@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class RestoreDBInstanceToPointInTimeRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
NOOP
Constructor and Description |
---|
RestoreDBInstanceToPointInTimeRequest()
Default constructor for RestoreDBInstanceToPointInTimeRequest object.
|
RestoreDBInstanceToPointInTimeRequest(String sourceDBInstanceIdentifier,
String targetDBInstanceIdentifier)
Constructs a new RestoreDBInstanceToPointInTimeRequest object.
|
Modifier and Type | Method and Description |
---|---|
RestoreDBInstanceToPointInTimeRequest |
clone()
Creates a shallow clone of this object for all fields except the handler context.
|
boolean |
equals(Object obj) |
Integer |
getAllocatedStorage()
The amount of storage (in gibibytes) to allocate initially for the DB instance.
|
Boolean |
getAutoMinorVersionUpgrade()
A value that indicates whether minor version upgrades are applied automatically to the DB instance during the
maintenance window.
|
String |
getAvailabilityZone()
The Availability Zone (AZ) where the DB instance will be created.
|
String |
getBackupTarget()
Specifies where automated backups and manual snapshots are stored for the restored DB instance.
|
Boolean |
getCopyTagsToSnapshot()
A value that indicates whether to copy all tags from the restored DB instance to snapshots of the DB instance.
|
String |
getCustomIamInstanceProfile()
The instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance.
|
String |
getDBInstanceClass()
The compute and memory capacity of the Amazon RDS DB instance, for example db.m4.large.
|
String |
getDBName()
The database name for the restored DB instance.
|
String |
getDBParameterGroupName()
The name of the DB parameter group to associate with this DB instance.
|
String |
getDBSubnetGroupName()
The DB subnet group name to use for the new instance.
|
Boolean |
getDeletionProtection()
A value that indicates whether the DB instance has deletion protection enabled.
|
String |
getDomain()
Specify the Active Directory directory ID to restore the DB instance in.
|
String |
getDomainIAMRoleName()
Specify the name of the IAM role to be used when making API calls to the Directory Service.
|
List<String> |
getEnableCloudwatchLogsExports()
The list of logs that the restored DB instance is to export to CloudWatch Logs.
|
Boolean |
getEnableCustomerOwnedIp()
A value that indicates whether to enable a customer-owned IP address (CoIP) for an RDS on Outposts DB instance.
|
Boolean |
getEnableIAMDatabaseAuthentication()
A value that indicates whether to enable mapping of Amazon Web Services Identity and Access Management (IAM)
accounts to database accounts.
|
String |
getEngine()
The database engine to use for the new instance.
|
Integer |
getIops()
The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB
instance.
|
String |
getLicenseModel()
License model information for the restored DB instance.
|
Integer |
getMaxAllocatedStorage()
The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance.
|
Boolean |
getMultiAZ()
A value that indicates whether the DB instance is a Multi-AZ deployment.
|
String |
getNetworkType()
The network type of the DB instance.
|
String |
getOptionGroupName()
The name of the option group to be used for the restored DB instance.
|
Integer |
getPort()
The port number on which the database accepts connections.
|
List<ProcessorFeature> |
getProcessorFeatures()
The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
|
Boolean |
getPubliclyAccessible()
A value that indicates whether the DB instance is publicly accessible.
|
Date |
getRestoreTime()
The date and time to restore from.
|
String |
getSourceDBInstanceAutomatedBackupsArn()
The Amazon Resource Name (ARN) of the replicated automated backups from which to restore, for example,
arn:aws:rds:useast-1:123456789012:auto-backup:ab-L2IJCEXJP7XQ7HOJ4SIEXAMPLE . |
String |
getSourceDBInstanceIdentifier()
The identifier of the source DB instance from which to restore.
|
String |
getSourceDbiResourceId()
The resource ID of the source DB instance from which to restore.
|
Integer |
getStorageThroughput()
Specifies the storage throughput value for the DB instance.
|
String |
getStorageType()
Specifies the storage type to be associated with the DB instance.
|
List<Tag> |
getTags() |
String |
getTargetDBInstanceIdentifier()
The name of the new DB instance to be created.
|
String |
getTdeCredentialArn()
The ARN from the key store with which to associate the instance for TDE encryption.
|
String |
getTdeCredentialPassword()
The password for the given ARN from the key store in order to access the device.
|
Boolean |
getUseDefaultProcessorFeatures()
A value that indicates whether the DB instance class of the DB instance uses its default processor features.
|
Boolean |
getUseLatestRestorableTime()
A value that indicates whether the DB instance is restored from the latest backup time.
|
List<String> |
getVpcSecurityGroupIds()
A list of EC2 VPC security groups to associate with this DB instance.
|
int |
hashCode() |
Boolean |
isAutoMinorVersionUpgrade()
A value that indicates whether minor version upgrades are applied automatically to the DB instance during the
maintenance window.
|
Boolean |
isCopyTagsToSnapshot()
A value that indicates whether to copy all tags from the restored DB instance to snapshots of the DB instance.
|
Boolean |
isDeletionProtection()
A value that indicates whether the DB instance has deletion protection enabled.
|
Boolean |
isEnableCustomerOwnedIp()
A value that indicates whether to enable a customer-owned IP address (CoIP) for an RDS on Outposts DB instance.
|
Boolean |
isEnableIAMDatabaseAuthentication()
A value that indicates whether to enable mapping of Amazon Web Services Identity and Access Management (IAM)
accounts to database accounts.
|
Boolean |
isMultiAZ()
A value that indicates whether the DB instance is a Multi-AZ deployment.
|
Boolean |
isPubliclyAccessible()
A value that indicates whether the DB instance is publicly accessible.
|
Boolean |
isUseDefaultProcessorFeatures()
A value that indicates whether the DB instance class of the DB instance uses its default processor features.
|
Boolean |
isUseLatestRestorableTime()
A value that indicates whether the DB instance is restored from the latest backup time.
|
void |
setAllocatedStorage(Integer allocatedStorage)
The amount of storage (in gibibytes) to allocate initially for the DB instance.
|
void |
setAutoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade)
A value that indicates whether minor version upgrades are applied automatically to the DB instance during the
maintenance window.
|
void |
setAvailabilityZone(String availabilityZone)
The Availability Zone (AZ) where the DB instance will be created.
|
void |
setBackupTarget(String backupTarget)
Specifies where automated backups and manual snapshots are stored for the restored DB instance.
|
void |
setCopyTagsToSnapshot(Boolean copyTagsToSnapshot)
A value that indicates whether to copy all tags from the restored DB instance to snapshots of the DB instance.
|
void |
setCustomIamInstanceProfile(String customIamInstanceProfile)
The instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance.
|
void |
setDBInstanceClass(String dBInstanceClass)
The compute and memory capacity of the Amazon RDS DB instance, for example db.m4.large.
|
void |
setDBName(String dBName)
The database name for the restored DB instance.
|
void |
setDBParameterGroupName(String dBParameterGroupName)
The name of the DB parameter group to associate with this DB instance.
|
void |
setDBSubnetGroupName(String dBSubnetGroupName)
The DB subnet group name to use for the new instance.
|
void |
setDeletionProtection(Boolean deletionProtection)
A value that indicates whether the DB instance has deletion protection enabled.
|
void |
setDomain(String domain)
Specify the Active Directory directory ID to restore the DB instance in.
|
void |
setDomainIAMRoleName(String domainIAMRoleName)
Specify the name of the IAM role to be used when making API calls to the Directory Service.
|
void |
setEnableCloudwatchLogsExports(Collection<String> enableCloudwatchLogsExports)
The list of logs that the restored DB instance is to export to CloudWatch Logs.
|
void |
setEnableCustomerOwnedIp(Boolean enableCustomerOwnedIp)
A value that indicates whether to enable a customer-owned IP address (CoIP) for an RDS on Outposts DB instance.
|
void |
setEnableIAMDatabaseAuthentication(Boolean enableIAMDatabaseAuthentication)
A value that indicates whether to enable mapping of Amazon Web Services Identity and Access Management (IAM)
accounts to database accounts.
|
void |
setEngine(String engine)
The database engine to use for the new instance.
|
void |
setIops(Integer iops)
The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB
instance.
|
void |
setLicenseModel(String licenseModel)
License model information for the restored DB instance.
|
void |
setMaxAllocatedStorage(Integer maxAllocatedStorage)
The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance.
|
void |
setMultiAZ(Boolean multiAZ)
A value that indicates whether the DB instance is a Multi-AZ deployment.
|
void |
setNetworkType(String networkType)
The network type of the DB instance.
|
void |
setOptionGroupName(String optionGroupName)
The name of the option group to be used for the restored DB instance.
|
void |
setPort(Integer port)
The port number on which the database accepts connections.
|
void |
setProcessorFeatures(Collection<ProcessorFeature> processorFeatures)
The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
|
void |
setPubliclyAccessible(Boolean publiclyAccessible)
A value that indicates whether the DB instance is publicly accessible.
|
void |
setRestoreTime(Date restoreTime)
The date and time to restore from.
|
void |
setSourceDBInstanceAutomatedBackupsArn(String sourceDBInstanceAutomatedBackupsArn)
The Amazon Resource Name (ARN) of the replicated automated backups from which to restore, for example,
arn:aws:rds:useast-1:123456789012:auto-backup:ab-L2IJCEXJP7XQ7HOJ4SIEXAMPLE . |
void |
setSourceDBInstanceIdentifier(String sourceDBInstanceIdentifier)
The identifier of the source DB instance from which to restore.
|
void |
setSourceDbiResourceId(String sourceDbiResourceId)
The resource ID of the source DB instance from which to restore.
|
void |
setStorageThroughput(Integer storageThroughput)
Specifies the storage throughput value for the DB instance.
|
void |
setStorageType(String storageType)
Specifies the storage type to be associated with the DB instance.
|
void |
setTags(Collection<Tag> tags) |
void |
setTargetDBInstanceIdentifier(String targetDBInstanceIdentifier)
The name of the new DB instance to be created.
|
void |
setTdeCredentialArn(String tdeCredentialArn)
The ARN from the key store with which to associate the instance for TDE encryption.
|
void |
setTdeCredentialPassword(String tdeCredentialPassword)
The password for the given ARN from the key store in order to access the device.
|
void |
setUseDefaultProcessorFeatures(Boolean useDefaultProcessorFeatures)
A value that indicates whether the DB instance class of the DB instance uses its default processor features.
|
void |
setUseLatestRestorableTime(Boolean useLatestRestorableTime)
A value that indicates whether the DB instance is restored from the latest backup time.
|
void |
setVpcSecurityGroupIds(Collection<String> vpcSecurityGroupIds)
A list of EC2 VPC security groups to associate with this DB instance.
|
String |
toString()
Returns a string representation of this object.
|
RestoreDBInstanceToPointInTimeRequest |
withAllocatedStorage(Integer allocatedStorage)
The amount of storage (in gibibytes) to allocate initially for the DB instance.
|
RestoreDBInstanceToPointInTimeRequest |
withAutoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade)
A value that indicates whether minor version upgrades are applied automatically to the DB instance during the
maintenance window.
|
RestoreDBInstanceToPointInTimeRequest |
withAvailabilityZone(String availabilityZone)
The Availability Zone (AZ) where the DB instance will be created.
|
RestoreDBInstanceToPointInTimeRequest |
withBackupTarget(String backupTarget)
Specifies where automated backups and manual snapshots are stored for the restored DB instance.
|
RestoreDBInstanceToPointInTimeRequest |
withCopyTagsToSnapshot(Boolean copyTagsToSnapshot)
A value that indicates whether to copy all tags from the restored DB instance to snapshots of the DB instance.
|
RestoreDBInstanceToPointInTimeRequest |
withCustomIamInstanceProfile(String customIamInstanceProfile)
The instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance.
|
RestoreDBInstanceToPointInTimeRequest |
withDBInstanceClass(String dBInstanceClass)
The compute and memory capacity of the Amazon RDS DB instance, for example db.m4.large.
|
RestoreDBInstanceToPointInTimeRequest |
withDBName(String dBName)
The database name for the restored DB instance.
|
RestoreDBInstanceToPointInTimeRequest |
withDBParameterGroupName(String dBParameterGroupName)
The name of the DB parameter group to associate with this DB instance.
|
RestoreDBInstanceToPointInTimeRequest |
withDBSubnetGroupName(String dBSubnetGroupName)
The DB subnet group name to use for the new instance.
|
RestoreDBInstanceToPointInTimeRequest |
withDeletionProtection(Boolean deletionProtection)
A value that indicates whether the DB instance has deletion protection enabled.
|
RestoreDBInstanceToPointInTimeRequest |
withDomain(String domain)
Specify the Active Directory directory ID to restore the DB instance in.
|
RestoreDBInstanceToPointInTimeRequest |
withDomainIAMRoleName(String domainIAMRoleName)
Specify the name of the IAM role to be used when making API calls to the Directory Service.
|
RestoreDBInstanceToPointInTimeRequest |
withEnableCloudwatchLogsExports(Collection<String> enableCloudwatchLogsExports)
The list of logs that the restored DB instance is to export to CloudWatch Logs.
|
RestoreDBInstanceToPointInTimeRequest |
withEnableCloudwatchLogsExports(String... enableCloudwatchLogsExports)
The list of logs that the restored DB instance is to export to CloudWatch Logs.
|
RestoreDBInstanceToPointInTimeRequest |
withEnableCustomerOwnedIp(Boolean enableCustomerOwnedIp)
A value that indicates whether to enable a customer-owned IP address (CoIP) for an RDS on Outposts DB instance.
|
RestoreDBInstanceToPointInTimeRequest |
withEnableIAMDatabaseAuthentication(Boolean enableIAMDatabaseAuthentication)
A value that indicates whether to enable mapping of Amazon Web Services Identity and Access Management (IAM)
accounts to database accounts.
|
RestoreDBInstanceToPointInTimeRequest |
withEngine(String engine)
The database engine to use for the new instance.
|
RestoreDBInstanceToPointInTimeRequest |
withIops(Integer iops)
The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB
instance.
|
RestoreDBInstanceToPointInTimeRequest |
withLicenseModel(String licenseModel)
License model information for the restored DB instance.
|
RestoreDBInstanceToPointInTimeRequest |
withMaxAllocatedStorage(Integer maxAllocatedStorage)
The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance.
|
RestoreDBInstanceToPointInTimeRequest |
withMultiAZ(Boolean multiAZ)
A value that indicates whether the DB instance is a Multi-AZ deployment.
|
RestoreDBInstanceToPointInTimeRequest |
withNetworkType(String networkType)
The network type of the DB instance.
|
RestoreDBInstanceToPointInTimeRequest |
withOptionGroupName(String optionGroupName)
The name of the option group to be used for the restored DB instance.
|
RestoreDBInstanceToPointInTimeRequest |
withPort(Integer port)
The port number on which the database accepts connections.
|
RestoreDBInstanceToPointInTimeRequest |
withProcessorFeatures(Collection<ProcessorFeature> processorFeatures)
The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
|
RestoreDBInstanceToPointInTimeRequest |
withProcessorFeatures(ProcessorFeature... processorFeatures)
The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
|
RestoreDBInstanceToPointInTimeRequest |
withPubliclyAccessible(Boolean publiclyAccessible)
A value that indicates whether the DB instance is publicly accessible.
|
RestoreDBInstanceToPointInTimeRequest |
withRestoreTime(Date restoreTime)
The date and time to restore from.
|
RestoreDBInstanceToPointInTimeRequest |
withSourceDBInstanceAutomatedBackupsArn(String sourceDBInstanceAutomatedBackupsArn)
The Amazon Resource Name (ARN) of the replicated automated backups from which to restore, for example,
arn:aws:rds:useast-1:123456789012:auto-backup:ab-L2IJCEXJP7XQ7HOJ4SIEXAMPLE . |
RestoreDBInstanceToPointInTimeRequest |
withSourceDBInstanceIdentifier(String sourceDBInstanceIdentifier)
The identifier of the source DB instance from which to restore.
|
RestoreDBInstanceToPointInTimeRequest |
withSourceDbiResourceId(String sourceDbiResourceId)
The resource ID of the source DB instance from which to restore.
|
RestoreDBInstanceToPointInTimeRequest |
withStorageThroughput(Integer storageThroughput)
Specifies the storage throughput value for the DB instance.
|
RestoreDBInstanceToPointInTimeRequest |
withStorageType(String storageType)
Specifies the storage type to be associated with the DB instance.
|
RestoreDBInstanceToPointInTimeRequest |
withTags(Collection<Tag> tags) |
RestoreDBInstanceToPointInTimeRequest |
withTags(Tag... tags)
NOTE: This method appends the values to the existing list (if any).
|
RestoreDBInstanceToPointInTimeRequest |
withTargetDBInstanceIdentifier(String targetDBInstanceIdentifier)
The name of the new DB instance to be created.
|
RestoreDBInstanceToPointInTimeRequest |
withTdeCredentialArn(String tdeCredentialArn)
The ARN from the key store with which to associate the instance for TDE encryption.
|
RestoreDBInstanceToPointInTimeRequest |
withTdeCredentialPassword(String tdeCredentialPassword)
The password for the given ARN from the key store in order to access the device.
|
RestoreDBInstanceToPointInTimeRequest |
withUseDefaultProcessorFeatures(Boolean useDefaultProcessorFeatures)
A value that indicates whether the DB instance class of the DB instance uses its default processor features.
|
RestoreDBInstanceToPointInTimeRequest |
withUseLatestRestorableTime(Boolean useLatestRestorableTime)
A value that indicates whether the DB instance is restored from the latest backup time.
|
RestoreDBInstanceToPointInTimeRequest |
withVpcSecurityGroupIds(Collection<String> vpcSecurityGroupIds)
A list of EC2 VPC security groups to associate with this DB instance.
|
RestoreDBInstanceToPointInTimeRequest |
withVpcSecurityGroupIds(String... vpcSecurityGroupIds)
A list of EC2 VPC security groups to associate with this DB instance.
|
addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout
public RestoreDBInstanceToPointInTimeRequest()
public RestoreDBInstanceToPointInTimeRequest(String sourceDBInstanceIdentifier, String targetDBInstanceIdentifier)
sourceDBInstanceIdentifier
- The identifier of the source DB instance from which to restore.
Constraints:
Must match the identifier of an existing DB instance.
targetDBInstanceIdentifier
- The name of the new DB instance to be created.
Constraints:
Must contain from 1 to 63 letters, numbers, or hyphens
First character must be a letter
Can't end with a hyphen or contain two consecutive hyphens
public void setSourceDBInstanceIdentifier(String sourceDBInstanceIdentifier)
The identifier of the source DB instance from which to restore.
Constraints:
Must match the identifier of an existing DB instance.
sourceDBInstanceIdentifier
- The identifier of the source DB instance from which to restore.
Constraints:
Must match the identifier of an existing DB instance.
public String getSourceDBInstanceIdentifier()
The identifier of the source DB instance from which to restore.
Constraints:
Must match the identifier of an existing DB instance.
Constraints:
Must match the identifier of an existing DB instance.
public RestoreDBInstanceToPointInTimeRequest withSourceDBInstanceIdentifier(String sourceDBInstanceIdentifier)
The identifier of the source DB instance from which to restore.
Constraints:
Must match the identifier of an existing DB instance.
sourceDBInstanceIdentifier
- The identifier of the source DB instance from which to restore.
Constraints:
Must match the identifier of an existing DB instance.
public void setTargetDBInstanceIdentifier(String targetDBInstanceIdentifier)
The name of the new DB instance to be created.
Constraints:
Must contain from 1 to 63 letters, numbers, or hyphens
First character must be a letter
Can't end with a hyphen or contain two consecutive hyphens
targetDBInstanceIdentifier
- The name of the new DB instance to be created.
Constraints:
Must contain from 1 to 63 letters, numbers, or hyphens
First character must be a letter
Can't end with a hyphen or contain two consecutive hyphens
public String getTargetDBInstanceIdentifier()
The name of the new DB instance to be created.
Constraints:
Must contain from 1 to 63 letters, numbers, or hyphens
First character must be a letter
Can't end with a hyphen or contain two consecutive hyphens
Constraints:
Must contain from 1 to 63 letters, numbers, or hyphens
First character must be a letter
Can't end with a hyphen or contain two consecutive hyphens
public RestoreDBInstanceToPointInTimeRequest withTargetDBInstanceIdentifier(String targetDBInstanceIdentifier)
The name of the new DB instance to be created.
Constraints:
Must contain from 1 to 63 letters, numbers, or hyphens
First character must be a letter
Can't end with a hyphen or contain two consecutive hyphens
targetDBInstanceIdentifier
- The name of the new DB instance to be created.
Constraints:
Must contain from 1 to 63 letters, numbers, or hyphens
First character must be a letter
Can't end with a hyphen or contain two consecutive hyphens
public void setRestoreTime(Date restoreTime)
The date and time to restore from.
Valid Values: Value must be a time in Universal Coordinated Time (UTC) format
Constraints:
Must be before the latest restorable time for the DB instance
Can't be specified if the UseLatestRestorableTime
parameter is enabled
Example: 2009-09-07T23:45:00Z
restoreTime
- The date and time to restore from.
Valid Values: Value must be a time in Universal Coordinated Time (UTC) format
Constraints:
Must be before the latest restorable time for the DB instance
Can't be specified if the UseLatestRestorableTime
parameter is enabled
Example: 2009-09-07T23:45:00Z
public Date getRestoreTime()
The date and time to restore from.
Valid Values: Value must be a time in Universal Coordinated Time (UTC) format
Constraints:
Must be before the latest restorable time for the DB instance
Can't be specified if the UseLatestRestorableTime
parameter is enabled
Example: 2009-09-07T23:45:00Z
Valid Values: Value must be a time in Universal Coordinated Time (UTC) format
Constraints:
Must be before the latest restorable time for the DB instance
Can't be specified if the UseLatestRestorableTime
parameter is enabled
Example: 2009-09-07T23:45:00Z
public RestoreDBInstanceToPointInTimeRequest withRestoreTime(Date restoreTime)
The date and time to restore from.
Valid Values: Value must be a time in Universal Coordinated Time (UTC) format
Constraints:
Must be before the latest restorable time for the DB instance
Can't be specified if the UseLatestRestorableTime
parameter is enabled
Example: 2009-09-07T23:45:00Z
restoreTime
- The date and time to restore from.
Valid Values: Value must be a time in Universal Coordinated Time (UTC) format
Constraints:
Must be before the latest restorable time for the DB instance
Can't be specified if the UseLatestRestorableTime
parameter is enabled
Example: 2009-09-07T23:45:00Z
public void setUseLatestRestorableTime(Boolean useLatestRestorableTime)
A value that indicates whether the DB instance is restored from the latest backup time. By default, the DB instance isn't restored from the latest backup time.
Constraints: Can't be specified if the RestoreTime
parameter is provided.
useLatestRestorableTime
- A value that indicates whether the DB instance is restored from the latest backup time. By default, the DB
instance isn't restored from the latest backup time.
Constraints: Can't be specified if the RestoreTime
parameter is provided.
public Boolean getUseLatestRestorableTime()
A value that indicates whether the DB instance is restored from the latest backup time. By default, the DB instance isn't restored from the latest backup time.
Constraints: Can't be specified if the RestoreTime
parameter is provided.
Constraints: Can't be specified if the RestoreTime
parameter is provided.
public RestoreDBInstanceToPointInTimeRequest withUseLatestRestorableTime(Boolean useLatestRestorableTime)
A value that indicates whether the DB instance is restored from the latest backup time. By default, the DB instance isn't restored from the latest backup time.
Constraints: Can't be specified if the RestoreTime
parameter is provided.
useLatestRestorableTime
- A value that indicates whether the DB instance is restored from the latest backup time. By default, the DB
instance isn't restored from the latest backup time.
Constraints: Can't be specified if the RestoreTime
parameter is provided.
public Boolean isUseLatestRestorableTime()
A value that indicates whether the DB instance is restored from the latest backup time. By default, the DB instance isn't restored from the latest backup time.
Constraints: Can't be specified if the RestoreTime
parameter is provided.
Constraints: Can't be specified if the RestoreTime
parameter is provided.
public void setDBInstanceClass(String dBInstanceClass)
The compute and memory capacity of the Amazon RDS DB instance, for example db.m4.large. Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines. For the full list of DB instance classes, and availability for your engine, see DB Instance Class in the Amazon RDS User Guide.
Default: The same DBInstanceClass as the original DB instance.
dBInstanceClass
- The compute and memory capacity of the Amazon RDS DB instance, for example db.m4.large. Not all DB
instance classes are available in all Amazon Web Services Regions, or for all database engines. For the
full list of DB instance classes, and availability for your engine, see DB Instance
Class in the Amazon RDS User Guide.
Default: The same DBInstanceClass as the original DB instance.
public String getDBInstanceClass()
The compute and memory capacity of the Amazon RDS DB instance, for example db.m4.large. Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines. For the full list of DB instance classes, and availability for your engine, see DB Instance Class in the Amazon RDS User Guide.
Default: The same DBInstanceClass as the original DB instance.
Default: The same DBInstanceClass as the original DB instance.
public RestoreDBInstanceToPointInTimeRequest withDBInstanceClass(String dBInstanceClass)
The compute and memory capacity of the Amazon RDS DB instance, for example db.m4.large. Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines. For the full list of DB instance classes, and availability for your engine, see DB Instance Class in the Amazon RDS User Guide.
Default: The same DBInstanceClass as the original DB instance.
dBInstanceClass
- The compute and memory capacity of the Amazon RDS DB instance, for example db.m4.large. Not all DB
instance classes are available in all Amazon Web Services Regions, or for all database engines. For the
full list of DB instance classes, and availability for your engine, see DB Instance
Class in the Amazon RDS User Guide.
Default: The same DBInstanceClass as the original DB instance.
public void setPort(Integer port)
The port number on which the database accepts connections.
Constraints: Value must be 1150-65535
Default: The same port as the original DB instance.
port
- The port number on which the database accepts connections.
Constraints: Value must be 1150-65535
Default: The same port as the original DB instance.
public Integer getPort()
The port number on which the database accepts connections.
Constraints: Value must be 1150-65535
Default: The same port as the original DB instance.
Constraints: Value must be 1150-65535
Default: The same port as the original DB instance.
public RestoreDBInstanceToPointInTimeRequest withPort(Integer port)
The port number on which the database accepts connections.
Constraints: Value must be 1150-65535
Default: The same port as the original DB instance.
port
- The port number on which the database accepts connections.
Constraints: Value must be 1150-65535
Default: The same port as the original DB instance.
public void setAvailabilityZone(String availabilityZone)
The Availability Zone (AZ) where the DB instance will be created.
Default: A random, system-chosen Availability Zone.
Constraint: You can't specify the AvailabilityZone
parameter if the DB instance is a Multi-AZ
deployment.
Example: us-east-1a
availabilityZone
- The Availability Zone (AZ) where the DB instance will be created.
Default: A random, system-chosen Availability Zone.
Constraint: You can't specify the AvailabilityZone
parameter if the DB instance is a Multi-AZ
deployment.
Example: us-east-1a
public String getAvailabilityZone()
The Availability Zone (AZ) where the DB instance will be created.
Default: A random, system-chosen Availability Zone.
Constraint: You can't specify the AvailabilityZone
parameter if the DB instance is a Multi-AZ
deployment.
Example: us-east-1a
Default: A random, system-chosen Availability Zone.
Constraint: You can't specify the AvailabilityZone
parameter if the DB instance is a
Multi-AZ deployment.
Example: us-east-1a
public RestoreDBInstanceToPointInTimeRequest withAvailabilityZone(String availabilityZone)
The Availability Zone (AZ) where the DB instance will be created.
Default: A random, system-chosen Availability Zone.
Constraint: You can't specify the AvailabilityZone
parameter if the DB instance is a Multi-AZ
deployment.
Example: us-east-1a
availabilityZone
- The Availability Zone (AZ) where the DB instance will be created.
Default: A random, system-chosen Availability Zone.
Constraint: You can't specify the AvailabilityZone
parameter if the DB instance is a Multi-AZ
deployment.
Example: us-east-1a
public void setDBSubnetGroupName(String dBSubnetGroupName)
The DB subnet group name to use for the new instance.
Constraints: If supplied, must match the name of an existing DBSubnetGroup.
Example: mydbsubnetgroup
dBSubnetGroupName
- The DB subnet group name to use for the new instance.
Constraints: If supplied, must match the name of an existing DBSubnetGroup.
Example: mydbsubnetgroup
public String getDBSubnetGroupName()
The DB subnet group name to use for the new instance.
Constraints: If supplied, must match the name of an existing DBSubnetGroup.
Example: mydbsubnetgroup
Constraints: If supplied, must match the name of an existing DBSubnetGroup.
Example: mydbsubnetgroup
public RestoreDBInstanceToPointInTimeRequest withDBSubnetGroupName(String dBSubnetGroupName)
The DB subnet group name to use for the new instance.
Constraints: If supplied, must match the name of an existing DBSubnetGroup.
Example: mydbsubnetgroup
dBSubnetGroupName
- The DB subnet group name to use for the new instance.
Constraints: If supplied, must match the name of an existing DBSubnetGroup.
Example: mydbsubnetgroup
public void setMultiAZ(Boolean multiAZ)
A value that indicates whether the DB instance is a Multi-AZ deployment.
This setting doesn't apply to RDS Custom.
Constraint: You can't specify the AvailabilityZone
parameter if the DB instance is a Multi-AZ
deployment.
multiAZ
- A value that indicates whether the DB instance is a Multi-AZ deployment.
This setting doesn't apply to RDS Custom.
Constraint: You can't specify the AvailabilityZone
parameter if the DB instance is a Multi-AZ
deployment.
public Boolean getMultiAZ()
A value that indicates whether the DB instance is a Multi-AZ deployment.
This setting doesn't apply to RDS Custom.
Constraint: You can't specify the AvailabilityZone
parameter if the DB instance is a Multi-AZ
deployment.
This setting doesn't apply to RDS Custom.
Constraint: You can't specify the AvailabilityZone
parameter if the DB instance is a
Multi-AZ deployment.
public RestoreDBInstanceToPointInTimeRequest withMultiAZ(Boolean multiAZ)
A value that indicates whether the DB instance is a Multi-AZ deployment.
This setting doesn't apply to RDS Custom.
Constraint: You can't specify the AvailabilityZone
parameter if the DB instance is a Multi-AZ
deployment.
multiAZ
- A value that indicates whether the DB instance is a Multi-AZ deployment.
This setting doesn't apply to RDS Custom.
Constraint: You can't specify the AvailabilityZone
parameter if the DB instance is a Multi-AZ
deployment.
public Boolean isMultiAZ()
A value that indicates whether the DB instance is a Multi-AZ deployment.
This setting doesn't apply to RDS Custom.
Constraint: You can't specify the AvailabilityZone
parameter if the DB instance is a Multi-AZ
deployment.
This setting doesn't apply to RDS Custom.
Constraint: You can't specify the AvailabilityZone
parameter if the DB instance is a
Multi-AZ deployment.
public void setPubliclyAccessible(Boolean publiclyAccessible)
A value that indicates whether the DB instance is publicly accessible.
When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB cluster's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. Access to the DB cluster is ultimately controlled by the security group it uses. That public access isn't permitted if the security group assigned to the DB cluster doesn't permit it.
When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.
For more information, see CreateDBInstance.
publiclyAccessible
- A value that indicates whether the DB instance is publicly accessible.
When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB cluster's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. Access to the DB cluster is ultimately controlled by the security group it uses. That public access isn't permitted if the security group assigned to the DB cluster doesn't permit it.
When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.
For more information, see CreateDBInstance.
public Boolean getPubliclyAccessible()
A value that indicates whether the DB instance is publicly accessible.
When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB cluster's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. Access to the DB cluster is ultimately controlled by the security group it uses. That public access isn't permitted if the security group assigned to the DB cluster doesn't permit it.
When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.
For more information, see CreateDBInstance.
When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB cluster's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. Access to the DB cluster is ultimately controlled by the security group it uses. That public access isn't permitted if the security group assigned to the DB cluster doesn't permit it.
When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.
For more information, see CreateDBInstance.
public RestoreDBInstanceToPointInTimeRequest withPubliclyAccessible(Boolean publiclyAccessible)
A value that indicates whether the DB instance is publicly accessible.
When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB cluster's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. Access to the DB cluster is ultimately controlled by the security group it uses. That public access isn't permitted if the security group assigned to the DB cluster doesn't permit it.
When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.
For more information, see CreateDBInstance.
publiclyAccessible
- A value that indicates whether the DB instance is publicly accessible.
When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB cluster's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. Access to the DB cluster is ultimately controlled by the security group it uses. That public access isn't permitted if the security group assigned to the DB cluster doesn't permit it.
When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.
For more information, see CreateDBInstance.
public Boolean isPubliclyAccessible()
A value that indicates whether the DB instance is publicly accessible.
When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB cluster's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. Access to the DB cluster is ultimately controlled by the security group it uses. That public access isn't permitted if the security group assigned to the DB cluster doesn't permit it.
When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.
For more information, see CreateDBInstance.
When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB cluster's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. Access to the DB cluster is ultimately controlled by the security group it uses. That public access isn't permitted if the security group assigned to the DB cluster doesn't permit it.
When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.
For more information, see CreateDBInstance.
public void setAutoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade)
A value that indicates whether minor version upgrades are applied automatically to the DB instance during the maintenance window.
This setting doesn't apply to RDS Custom.
autoMinorVersionUpgrade
- A value that indicates whether minor version upgrades are applied automatically to the DB instance during
the maintenance window.
This setting doesn't apply to RDS Custom.
public Boolean getAutoMinorVersionUpgrade()
A value that indicates whether minor version upgrades are applied automatically to the DB instance during the maintenance window.
This setting doesn't apply to RDS Custom.
This setting doesn't apply to RDS Custom.
public RestoreDBInstanceToPointInTimeRequest withAutoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade)
A value that indicates whether minor version upgrades are applied automatically to the DB instance during the maintenance window.
This setting doesn't apply to RDS Custom.
autoMinorVersionUpgrade
- A value that indicates whether minor version upgrades are applied automatically to the DB instance during
the maintenance window.
This setting doesn't apply to RDS Custom.
public Boolean isAutoMinorVersionUpgrade()
A value that indicates whether minor version upgrades are applied automatically to the DB instance during the maintenance window.
This setting doesn't apply to RDS Custom.
This setting doesn't apply to RDS Custom.
public void setLicenseModel(String licenseModel)
License model information for the restored DB instance.
This setting doesn't apply to RDS Custom.
Default: Same as source.
Valid values: license-included
| bring-your-own-license
|
general-public-license
licenseModel
- License model information for the restored DB instance.
This setting doesn't apply to RDS Custom.
Default: Same as source.
Valid values: license-included
| bring-your-own-license
|
general-public-license
public String getLicenseModel()
License model information for the restored DB instance.
This setting doesn't apply to RDS Custom.
Default: Same as source.
Valid values: license-included
| bring-your-own-license
|
general-public-license
This setting doesn't apply to RDS Custom.
Default: Same as source.
Valid values: license-included
| bring-your-own-license
|
general-public-license
public RestoreDBInstanceToPointInTimeRequest withLicenseModel(String licenseModel)
License model information for the restored DB instance.
This setting doesn't apply to RDS Custom.
Default: Same as source.
Valid values: license-included
| bring-your-own-license
|
general-public-license
licenseModel
- License model information for the restored DB instance.
This setting doesn't apply to RDS Custom.
Default: Same as source.
Valid values: license-included
| bring-your-own-license
|
general-public-license
public void setDBName(String dBName)
The database name for the restored DB instance.
This parameter isn't supported for the MySQL or MariaDB engines. It also doesn't apply to RDS Custom.
dBName
- The database name for the restored DB instance. This parameter isn't supported for the MySQL or MariaDB engines. It also doesn't apply to RDS Custom.
public String getDBName()
The database name for the restored DB instance.
This parameter isn't supported for the MySQL or MariaDB engines. It also doesn't apply to RDS Custom.
This parameter isn't supported for the MySQL or MariaDB engines. It also doesn't apply to RDS Custom.
public RestoreDBInstanceToPointInTimeRequest withDBName(String dBName)
The database name for the restored DB instance.
This parameter isn't supported for the MySQL or MariaDB engines. It also doesn't apply to RDS Custom.
dBName
- The database name for the restored DB instance. This parameter isn't supported for the MySQL or MariaDB engines. It also doesn't apply to RDS Custom.
public void setEngine(String engine)
The database engine to use for the new instance.
This setting doesn't apply to RDS Custom.
Default: The same as source
Constraint: Must be compatible with the engine of the source
Valid Values:
mariadb
mysql
oracle-ee
oracle-ee-cdb
oracle-se2
oracle-se2-cdb
postgres
sqlserver-ee
sqlserver-se
sqlserver-ex
sqlserver-web
engine
- The database engine to use for the new instance.
This setting doesn't apply to RDS Custom.
Default: The same as source
Constraint: Must be compatible with the engine of the source
Valid Values:
mariadb
mysql
oracle-ee
oracle-ee-cdb
oracle-se2
oracle-se2-cdb
postgres
sqlserver-ee
sqlserver-se
sqlserver-ex
sqlserver-web
public String getEngine()
The database engine to use for the new instance.
This setting doesn't apply to RDS Custom.
Default: The same as source
Constraint: Must be compatible with the engine of the source
Valid Values:
mariadb
mysql
oracle-ee
oracle-ee-cdb
oracle-se2
oracle-se2-cdb
postgres
sqlserver-ee
sqlserver-se
sqlserver-ex
sqlserver-web
This setting doesn't apply to RDS Custom.
Default: The same as source
Constraint: Must be compatible with the engine of the source
Valid Values:
mariadb
mysql
oracle-ee
oracle-ee-cdb
oracle-se2
oracle-se2-cdb
postgres
sqlserver-ee
sqlserver-se
sqlserver-ex
sqlserver-web
public RestoreDBInstanceToPointInTimeRequest withEngine(String engine)
The database engine to use for the new instance.
This setting doesn't apply to RDS Custom.
Default: The same as source
Constraint: Must be compatible with the engine of the source
Valid Values:
mariadb
mysql
oracle-ee
oracle-ee-cdb
oracle-se2
oracle-se2-cdb
postgres
sqlserver-ee
sqlserver-se
sqlserver-ex
sqlserver-web
engine
- The database engine to use for the new instance.
This setting doesn't apply to RDS Custom.
Default: The same as source
Constraint: Must be compatible with the engine of the source
Valid Values:
mariadb
mysql
oracle-ee
oracle-ee-cdb
oracle-se2
oracle-se2-cdb
postgres
sqlserver-ee
sqlserver-se
sqlserver-ex
sqlserver-web
public void setIops(Integer iops)
The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB instance.
Constraints: Must be an integer greater than 1000.
SQL Server
Setting the IOPS value for the SQL Server database engine isn't supported.
iops
- The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB
instance.
Constraints: Must be an integer greater than 1000.
SQL Server
Setting the IOPS value for the SQL Server database engine isn't supported.
public Integer getIops()
The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB instance.
Constraints: Must be an integer greater than 1000.
SQL Server
Setting the IOPS value for the SQL Server database engine isn't supported.
Constraints: Must be an integer greater than 1000.
SQL Server
Setting the IOPS value for the SQL Server database engine isn't supported.
public RestoreDBInstanceToPointInTimeRequest withIops(Integer iops)
The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB instance.
Constraints: Must be an integer greater than 1000.
SQL Server
Setting the IOPS value for the SQL Server database engine isn't supported.
iops
- The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB
instance.
Constraints: Must be an integer greater than 1000.
SQL Server
Setting the IOPS value for the SQL Server database engine isn't supported.
public void setOptionGroupName(String optionGroupName)
The name of the option group to be used for the restored DB instance.
Permanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed from an option group, and that option group can't be removed from a DB instance after it is associated with a DB instance
This setting doesn't apply to RDS Custom.
optionGroupName
- The name of the option group to be used for the restored DB instance.
Permanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed from an option group, and that option group can't be removed from a DB instance after it is associated with a DB instance
This setting doesn't apply to RDS Custom.
public String getOptionGroupName()
The name of the option group to be used for the restored DB instance.
Permanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed from an option group, and that option group can't be removed from a DB instance after it is associated with a DB instance
This setting doesn't apply to RDS Custom.
Permanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed from an option group, and that option group can't be removed from a DB instance after it is associated with a DB instance
This setting doesn't apply to RDS Custom.
public RestoreDBInstanceToPointInTimeRequest withOptionGroupName(String optionGroupName)
The name of the option group to be used for the restored DB instance.
Permanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed from an option group, and that option group can't be removed from a DB instance after it is associated with a DB instance
This setting doesn't apply to RDS Custom.
optionGroupName
- The name of the option group to be used for the restored DB instance.
Permanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed from an option group, and that option group can't be removed from a DB instance after it is associated with a DB instance
This setting doesn't apply to RDS Custom.
public void setCopyTagsToSnapshot(Boolean copyTagsToSnapshot)
A value that indicates whether to copy all tags from the restored DB instance to snapshots of the DB instance. By default, tags are not copied.
copyTagsToSnapshot
- A value that indicates whether to copy all tags from the restored DB instance to snapshots of the DB
instance. By default, tags are not copied.public Boolean getCopyTagsToSnapshot()
A value that indicates whether to copy all tags from the restored DB instance to snapshots of the DB instance. By default, tags are not copied.
public RestoreDBInstanceToPointInTimeRequest withCopyTagsToSnapshot(Boolean copyTagsToSnapshot)
A value that indicates whether to copy all tags from the restored DB instance to snapshots of the DB instance. By default, tags are not copied.
copyTagsToSnapshot
- A value that indicates whether to copy all tags from the restored DB instance to snapshots of the DB
instance. By default, tags are not copied.public Boolean isCopyTagsToSnapshot()
A value that indicates whether to copy all tags from the restored DB instance to snapshots of the DB instance. By default, tags are not copied.
public void setTags(Collection<Tag> tags)
tags
- public RestoreDBInstanceToPointInTimeRequest withTags(Tag... tags)
NOTE: This method appends the values to the existing list (if any). Use
setTags(java.util.Collection)
or withTags(java.util.Collection)
if you want to override the
existing values.
tags
- public RestoreDBInstanceToPointInTimeRequest withTags(Collection<Tag> tags)
tags
- public void setStorageType(String storageType)
Specifies the storage type to be associated with the DB instance.
Valid values: gp2 | gp3 | io1 | standard
If you specify io1
or gp3
, you must also include a value for the Iops
parameter.
Default: io1
if the Iops
parameter is specified, otherwise gp2
storageType
- Specifies the storage type to be associated with the DB instance.
Valid values: gp2 | gp3 | io1 | standard
If you specify io1
or gp3
, you must also include a value for the
Iops
parameter.
Default: io1
if the Iops
parameter is specified, otherwise gp2
public String getStorageType()
Specifies the storage type to be associated with the DB instance.
Valid values: gp2 | gp3 | io1 | standard
If you specify io1
or gp3
, you must also include a value for the Iops
parameter.
Default: io1
if the Iops
parameter is specified, otherwise gp2
Valid values: gp2 | gp3 | io1 | standard
If you specify io1
or gp3
, you must also include a value for the
Iops
parameter.
Default: io1
if the Iops
parameter is specified, otherwise gp2
public RestoreDBInstanceToPointInTimeRequest withStorageType(String storageType)
Specifies the storage type to be associated with the DB instance.
Valid values: gp2 | gp3 | io1 | standard
If you specify io1
or gp3
, you must also include a value for the Iops
parameter.
Default: io1
if the Iops
parameter is specified, otherwise gp2
storageType
- Specifies the storage type to be associated with the DB instance.
Valid values: gp2 | gp3 | io1 | standard
If you specify io1
or gp3
, you must also include a value for the
Iops
parameter.
Default: io1
if the Iops
parameter is specified, otherwise gp2
public void setTdeCredentialArn(String tdeCredentialArn)
The ARN from the key store with which to associate the instance for TDE encryption.
This setting doesn't apply to RDS Custom.
tdeCredentialArn
- The ARN from the key store with which to associate the instance for TDE encryption.
This setting doesn't apply to RDS Custom.
public String getTdeCredentialArn()
The ARN from the key store with which to associate the instance for TDE encryption.
This setting doesn't apply to RDS Custom.
This setting doesn't apply to RDS Custom.
public RestoreDBInstanceToPointInTimeRequest withTdeCredentialArn(String tdeCredentialArn)
The ARN from the key store with which to associate the instance for TDE encryption.
This setting doesn't apply to RDS Custom.
tdeCredentialArn
- The ARN from the key store with which to associate the instance for TDE encryption.
This setting doesn't apply to RDS Custom.
public void setTdeCredentialPassword(String tdeCredentialPassword)
The password for the given ARN from the key store in order to access the device.
This setting doesn't apply to RDS Custom.
tdeCredentialPassword
- The password for the given ARN from the key store in order to access the device.
This setting doesn't apply to RDS Custom.
public String getTdeCredentialPassword()
The password for the given ARN from the key store in order to access the device.
This setting doesn't apply to RDS Custom.
This setting doesn't apply to RDS Custom.
public RestoreDBInstanceToPointInTimeRequest withTdeCredentialPassword(String tdeCredentialPassword)
The password for the given ARN from the key store in order to access the device.
This setting doesn't apply to RDS Custom.
tdeCredentialPassword
- The password for the given ARN from the key store in order to access the device.
This setting doesn't apply to RDS Custom.
public List<String> getVpcSecurityGroupIds()
A list of EC2 VPC security groups to associate with this DB instance.
Default: The default EC2 VPC security group for the DB subnet group's VPC.
Default: The default EC2 VPC security group for the DB subnet group's VPC.
public void setVpcSecurityGroupIds(Collection<String> vpcSecurityGroupIds)
A list of EC2 VPC security groups to associate with this DB instance.
Default: The default EC2 VPC security group for the DB subnet group's VPC.
vpcSecurityGroupIds
- A list of EC2 VPC security groups to associate with this DB instance.
Default: The default EC2 VPC security group for the DB subnet group's VPC.
public RestoreDBInstanceToPointInTimeRequest withVpcSecurityGroupIds(String... vpcSecurityGroupIds)
A list of EC2 VPC security groups to associate with this DB instance.
Default: The default EC2 VPC security group for the DB subnet group's VPC.
NOTE: This method appends the values to the existing list (if any). Use
setVpcSecurityGroupIds(java.util.Collection)
or withVpcSecurityGroupIds(java.util.Collection)
if you want to override the existing values.
vpcSecurityGroupIds
- A list of EC2 VPC security groups to associate with this DB instance.
Default: The default EC2 VPC security group for the DB subnet group's VPC.
public RestoreDBInstanceToPointInTimeRequest withVpcSecurityGroupIds(Collection<String> vpcSecurityGroupIds)
A list of EC2 VPC security groups to associate with this DB instance.
Default: The default EC2 VPC security group for the DB subnet group's VPC.
vpcSecurityGroupIds
- A list of EC2 VPC security groups to associate with this DB instance.
Default: The default EC2 VPC security group for the DB subnet group's VPC.
public void setDomain(String domain)
Specify the Active Directory directory ID to restore the DB instance in. Create the domain before running this command. Currently, you can create only the MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB instances in an Active Directory Domain.
This setting doesn't apply to RDS Custom.
For more information, see Kerberos Authentication in the Amazon RDS User Guide.
domain
- Specify the Active Directory directory ID to restore the DB instance in. Create the domain before running
this command. Currently, you can create only the MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB
instances in an Active Directory Domain.
This setting doesn't apply to RDS Custom.
For more information, see Kerberos Authentication in the Amazon RDS User Guide.
public String getDomain()
Specify the Active Directory directory ID to restore the DB instance in. Create the domain before running this command. Currently, you can create only the MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB instances in an Active Directory Domain.
This setting doesn't apply to RDS Custom.
For more information, see Kerberos Authentication in the Amazon RDS User Guide.
This setting doesn't apply to RDS Custom.
For more information, see Kerberos Authentication in the Amazon RDS User Guide.
public RestoreDBInstanceToPointInTimeRequest withDomain(String domain)
Specify the Active Directory directory ID to restore the DB instance in. Create the domain before running this command. Currently, you can create only the MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB instances in an Active Directory Domain.
This setting doesn't apply to RDS Custom.
For more information, see Kerberos Authentication in the Amazon RDS User Guide.
domain
- Specify the Active Directory directory ID to restore the DB instance in. Create the domain before running
this command. Currently, you can create only the MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB
instances in an Active Directory Domain.
This setting doesn't apply to RDS Custom.
For more information, see Kerberos Authentication in the Amazon RDS User Guide.
public void setDomainIAMRoleName(String domainIAMRoleName)
Specify the name of the IAM role to be used when making API calls to the Directory Service.
This setting doesn't apply to RDS Custom.
domainIAMRoleName
- Specify the name of the IAM role to be used when making API calls to the Directory Service.
This setting doesn't apply to RDS Custom.
public String getDomainIAMRoleName()
Specify the name of the IAM role to be used when making API calls to the Directory Service.
This setting doesn't apply to RDS Custom.
This setting doesn't apply to RDS Custom.
public RestoreDBInstanceToPointInTimeRequest withDomainIAMRoleName(String domainIAMRoleName)
Specify the name of the IAM role to be used when making API calls to the Directory Service.
This setting doesn't apply to RDS Custom.
domainIAMRoleName
- Specify the name of the IAM role to be used when making API calls to the Directory Service.
This setting doesn't apply to RDS Custom.
public void setEnableIAMDatabaseAuthentication(Boolean enableIAMDatabaseAuthentication)
A value that indicates whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts. By default, mapping isn't enabled.
This setting doesn't apply to RDS Custom.
For more information about IAM database authentication, see IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.
enableIAMDatabaseAuthentication
- A value that indicates whether to enable mapping of Amazon Web Services Identity and Access Management
(IAM) accounts to database accounts. By default, mapping isn't enabled.
This setting doesn't apply to RDS Custom.
For more information about IAM database authentication, see IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.
public Boolean getEnableIAMDatabaseAuthentication()
A value that indicates whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts. By default, mapping isn't enabled.
This setting doesn't apply to RDS Custom.
For more information about IAM database authentication, see IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.
This setting doesn't apply to RDS Custom.
For more information about IAM database authentication, see IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.
public RestoreDBInstanceToPointInTimeRequest withEnableIAMDatabaseAuthentication(Boolean enableIAMDatabaseAuthentication)
A value that indicates whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts. By default, mapping isn't enabled.
This setting doesn't apply to RDS Custom.
For more information about IAM database authentication, see IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.
enableIAMDatabaseAuthentication
- A value that indicates whether to enable mapping of Amazon Web Services Identity and Access Management
(IAM) accounts to database accounts. By default, mapping isn't enabled.
This setting doesn't apply to RDS Custom.
For more information about IAM database authentication, see IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.
public Boolean isEnableIAMDatabaseAuthentication()
A value that indicates whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts. By default, mapping isn't enabled.
This setting doesn't apply to RDS Custom.
For more information about IAM database authentication, see IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.
This setting doesn't apply to RDS Custom.
For more information about IAM database authentication, see IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.
public List<String> getEnableCloudwatchLogsExports()
The list of logs that the restored DB instance is to export to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.
This setting doesn't apply to RDS Custom.
This setting doesn't apply to RDS Custom.
public void setEnableCloudwatchLogsExports(Collection<String> enableCloudwatchLogsExports)
The list of logs that the restored DB instance is to export to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.
This setting doesn't apply to RDS Custom.
enableCloudwatchLogsExports
- The list of logs that the restored DB instance is to export to CloudWatch Logs. The values in the list
depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.
This setting doesn't apply to RDS Custom.
public RestoreDBInstanceToPointInTimeRequest withEnableCloudwatchLogsExports(String... enableCloudwatchLogsExports)
The list of logs that the restored DB instance is to export to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.
This setting doesn't apply to RDS Custom.
NOTE: This method appends the values to the existing list (if any). Use
setEnableCloudwatchLogsExports(java.util.Collection)
or
withEnableCloudwatchLogsExports(java.util.Collection)
if you want to override the existing values.
enableCloudwatchLogsExports
- The list of logs that the restored DB instance is to export to CloudWatch Logs. The values in the list
depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.
This setting doesn't apply to RDS Custom.
public RestoreDBInstanceToPointInTimeRequest withEnableCloudwatchLogsExports(Collection<String> enableCloudwatchLogsExports)
The list of logs that the restored DB instance is to export to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.
This setting doesn't apply to RDS Custom.
enableCloudwatchLogsExports
- The list of logs that the restored DB instance is to export to CloudWatch Logs. The values in the list
depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.
This setting doesn't apply to RDS Custom.
public List<ProcessorFeature> getProcessorFeatures()
The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
This setting doesn't apply to RDS Custom.
This setting doesn't apply to RDS Custom.
public void setProcessorFeatures(Collection<ProcessorFeature> processorFeatures)
The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
This setting doesn't apply to RDS Custom.
processorFeatures
- The number of CPU cores and the number of threads per core for the DB instance class of the DB
instance.
This setting doesn't apply to RDS Custom.
public RestoreDBInstanceToPointInTimeRequest withProcessorFeatures(ProcessorFeature... processorFeatures)
The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
This setting doesn't apply to RDS Custom.
NOTE: This method appends the values to the existing list (if any). Use
setProcessorFeatures(java.util.Collection)
or withProcessorFeatures(java.util.Collection)
if
you want to override the existing values.
processorFeatures
- The number of CPU cores and the number of threads per core for the DB instance class of the DB
instance.
This setting doesn't apply to RDS Custom.
public RestoreDBInstanceToPointInTimeRequest withProcessorFeatures(Collection<ProcessorFeature> processorFeatures)
The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
This setting doesn't apply to RDS Custom.
processorFeatures
- The number of CPU cores and the number of threads per core for the DB instance class of the DB
instance.
This setting doesn't apply to RDS Custom.
public void setUseDefaultProcessorFeatures(Boolean useDefaultProcessorFeatures)
A value that indicates whether the DB instance class of the DB instance uses its default processor features.
This setting doesn't apply to RDS Custom.
useDefaultProcessorFeatures
- A value that indicates whether the DB instance class of the DB instance uses its default processor
features.
This setting doesn't apply to RDS Custom.
public Boolean getUseDefaultProcessorFeatures()
A value that indicates whether the DB instance class of the DB instance uses its default processor features.
This setting doesn't apply to RDS Custom.
This setting doesn't apply to RDS Custom.
public RestoreDBInstanceToPointInTimeRequest withUseDefaultProcessorFeatures(Boolean useDefaultProcessorFeatures)
A value that indicates whether the DB instance class of the DB instance uses its default processor features.
This setting doesn't apply to RDS Custom.
useDefaultProcessorFeatures
- A value that indicates whether the DB instance class of the DB instance uses its default processor
features.
This setting doesn't apply to RDS Custom.
public Boolean isUseDefaultProcessorFeatures()
A value that indicates whether the DB instance class of the DB instance uses its default processor features.
This setting doesn't apply to RDS Custom.
This setting doesn't apply to RDS Custom.
public void setDBParameterGroupName(String dBParameterGroupName)
The name of the DB parameter group to associate with this DB instance.
If you do not specify a value for DBParameterGroupName
, then the default
DBParameterGroup
for the specified DB engine is used.
This setting doesn't apply to RDS Custom.
Constraints:
If supplied, must match the name of an existing DBParameterGroup.
Must be 1 to 255 letters, numbers, or hyphens.
First character must be a letter.
Can't end with a hyphen or contain two consecutive hyphens.
dBParameterGroupName
- The name of the DB parameter group to associate with this DB instance.
If you do not specify a value for DBParameterGroupName
, then the default
DBParameterGroup
for the specified DB engine is used.
This setting doesn't apply to RDS Custom.
Constraints:
If supplied, must match the name of an existing DBParameterGroup.
Must be 1 to 255 letters, numbers, or hyphens.
First character must be a letter.
Can't end with a hyphen or contain two consecutive hyphens.
public String getDBParameterGroupName()
The name of the DB parameter group to associate with this DB instance.
If you do not specify a value for DBParameterGroupName
, then the default
DBParameterGroup
for the specified DB engine is used.
This setting doesn't apply to RDS Custom.
Constraints:
If supplied, must match the name of an existing DBParameterGroup.
Must be 1 to 255 letters, numbers, or hyphens.
First character must be a letter.
Can't end with a hyphen or contain two consecutive hyphens.
If you do not specify a value for DBParameterGroupName
, then the default
DBParameterGroup
for the specified DB engine is used.
This setting doesn't apply to RDS Custom.
Constraints:
If supplied, must match the name of an existing DBParameterGroup.
Must be 1 to 255 letters, numbers, or hyphens.
First character must be a letter.
Can't end with a hyphen or contain two consecutive hyphens.
public RestoreDBInstanceToPointInTimeRequest withDBParameterGroupName(String dBParameterGroupName)
The name of the DB parameter group to associate with this DB instance.
If you do not specify a value for DBParameterGroupName
, then the default
DBParameterGroup
for the specified DB engine is used.
This setting doesn't apply to RDS Custom.
Constraints:
If supplied, must match the name of an existing DBParameterGroup.
Must be 1 to 255 letters, numbers, or hyphens.
First character must be a letter.
Can't end with a hyphen or contain two consecutive hyphens.
dBParameterGroupName
- The name of the DB parameter group to associate with this DB instance.
If you do not specify a value for DBParameterGroupName
, then the default
DBParameterGroup
for the specified DB engine is used.
This setting doesn't apply to RDS Custom.
Constraints:
If supplied, must match the name of an existing DBParameterGroup.
Must be 1 to 255 letters, numbers, or hyphens.
First character must be a letter.
Can't end with a hyphen or contain two consecutive hyphens.
public void setDeletionProtection(Boolean deletionProtection)
A value that indicates whether the DB instance has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection isn't enabled. For more information, see Deleting a DB Instance.
deletionProtection
- A value that indicates whether the DB instance has deletion protection enabled. The database can't be
deleted when deletion protection is enabled. By default, deletion protection isn't enabled. For more
information, see Deleting a DB
Instance.public Boolean getDeletionProtection()
A value that indicates whether the DB instance has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection isn't enabled. For more information, see Deleting a DB Instance.
public RestoreDBInstanceToPointInTimeRequest withDeletionProtection(Boolean deletionProtection)
A value that indicates whether the DB instance has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection isn't enabled. For more information, see Deleting a DB Instance.
deletionProtection
- A value that indicates whether the DB instance has deletion protection enabled. The database can't be
deleted when deletion protection is enabled. By default, deletion protection isn't enabled. For more
information, see Deleting a DB
Instance.public Boolean isDeletionProtection()
A value that indicates whether the DB instance has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection isn't enabled. For more information, see Deleting a DB Instance.
public void setSourceDbiResourceId(String sourceDbiResourceId)
The resource ID of the source DB instance from which to restore.
sourceDbiResourceId
- The resource ID of the source DB instance from which to restore.public String getSourceDbiResourceId()
The resource ID of the source DB instance from which to restore.
public RestoreDBInstanceToPointInTimeRequest withSourceDbiResourceId(String sourceDbiResourceId)
The resource ID of the source DB instance from which to restore.
sourceDbiResourceId
- The resource ID of the source DB instance from which to restore.public void setMaxAllocatedStorage(Integer maxAllocatedStorage)
The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance.
For more information about this setting, including limitations that apply to it, see Managing capacity automatically with Amazon RDS storage autoscaling in the Amazon RDS User Guide.
This setting doesn't apply to RDS Custom.
maxAllocatedStorage
- The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB
instance.
For more information about this setting, including limitations that apply to it, see Managing capacity automatically with Amazon RDS storage autoscaling in the Amazon RDS User Guide.
This setting doesn't apply to RDS Custom.
public Integer getMaxAllocatedStorage()
The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance.
For more information about this setting, including limitations that apply to it, see Managing capacity automatically with Amazon RDS storage autoscaling in the Amazon RDS User Guide.
This setting doesn't apply to RDS Custom.
For more information about this setting, including limitations that apply to it, see Managing capacity automatically with Amazon RDS storage autoscaling in the Amazon RDS User Guide.
This setting doesn't apply to RDS Custom.
public RestoreDBInstanceToPointInTimeRequest withMaxAllocatedStorage(Integer maxAllocatedStorage)
The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance.
For more information about this setting, including limitations that apply to it, see Managing capacity automatically with Amazon RDS storage autoscaling in the Amazon RDS User Guide.
This setting doesn't apply to RDS Custom.
maxAllocatedStorage
- The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB
instance.
For more information about this setting, including limitations that apply to it, see Managing capacity automatically with Amazon RDS storage autoscaling in the Amazon RDS User Guide.
This setting doesn't apply to RDS Custom.
public void setSourceDBInstanceAutomatedBackupsArn(String sourceDBInstanceAutomatedBackupsArn)
The Amazon Resource Name (ARN) of the replicated automated backups from which to restore, for example,
arn:aws:rds:useast-1:123456789012:auto-backup:ab-L2IJCEXJP7XQ7HOJ4SIEXAMPLE
.
This setting doesn't apply to RDS Custom.
sourceDBInstanceAutomatedBackupsArn
- The Amazon Resource Name (ARN) of the replicated automated backups from which to restore, for example,
arn:aws:rds:useast-1:123456789012:auto-backup:ab-L2IJCEXJP7XQ7HOJ4SIEXAMPLE
.
This setting doesn't apply to RDS Custom.
public String getSourceDBInstanceAutomatedBackupsArn()
The Amazon Resource Name (ARN) of the replicated automated backups from which to restore, for example,
arn:aws:rds:useast-1:123456789012:auto-backup:ab-L2IJCEXJP7XQ7HOJ4SIEXAMPLE
.
This setting doesn't apply to RDS Custom.
arn:aws:rds:useast-1:123456789012:auto-backup:ab-L2IJCEXJP7XQ7HOJ4SIEXAMPLE
.
This setting doesn't apply to RDS Custom.
public RestoreDBInstanceToPointInTimeRequest withSourceDBInstanceAutomatedBackupsArn(String sourceDBInstanceAutomatedBackupsArn)
The Amazon Resource Name (ARN) of the replicated automated backups from which to restore, for example,
arn:aws:rds:useast-1:123456789012:auto-backup:ab-L2IJCEXJP7XQ7HOJ4SIEXAMPLE
.
This setting doesn't apply to RDS Custom.
sourceDBInstanceAutomatedBackupsArn
- The Amazon Resource Name (ARN) of the replicated automated backups from which to restore, for example,
arn:aws:rds:useast-1:123456789012:auto-backup:ab-L2IJCEXJP7XQ7HOJ4SIEXAMPLE
.
This setting doesn't apply to RDS Custom.
public void setEnableCustomerOwnedIp(Boolean enableCustomerOwnedIp)
A value that indicates whether to enable a customer-owned IP address (CoIP) for an RDS on Outposts DB instance.
A CoIP provides local or external connectivity to resources in your Outpost subnets through your on-premises network. For some use cases, a CoIP can provide lower latency for connections to the DB instance from outside of its virtual private cloud (VPC) on your local network.
This setting doesn't apply to RDS Custom.
For more information about RDS on Outposts, see Working with Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.
For more information about CoIPs, see Customer-owned IP addresses in the Amazon Web Services Outposts User Guide.
enableCustomerOwnedIp
- A value that indicates whether to enable a customer-owned IP address (CoIP) for an RDS on Outposts DB
instance.
A CoIP provides local or external connectivity to resources in your Outpost subnets through your on-premises network. For some use cases, a CoIP can provide lower latency for connections to the DB instance from outside of its virtual private cloud (VPC) on your local network.
This setting doesn't apply to RDS Custom.
For more information about RDS on Outposts, see Working with Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.
For more information about CoIPs, see Customer-owned IP addresses in the Amazon Web Services Outposts User Guide.
public Boolean getEnableCustomerOwnedIp()
A value that indicates whether to enable a customer-owned IP address (CoIP) for an RDS on Outposts DB instance.
A CoIP provides local or external connectivity to resources in your Outpost subnets through your on-premises network. For some use cases, a CoIP can provide lower latency for connections to the DB instance from outside of its virtual private cloud (VPC) on your local network.
This setting doesn't apply to RDS Custom.
For more information about RDS on Outposts, see Working with Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.
For more information about CoIPs, see Customer-owned IP addresses in the Amazon Web Services Outposts User Guide.
A CoIP provides local or external connectivity to resources in your Outpost subnets through your on-premises network. For some use cases, a CoIP can provide lower latency for connections to the DB instance from outside of its virtual private cloud (VPC) on your local network.
This setting doesn't apply to RDS Custom.
For more information about RDS on Outposts, see Working with Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.
For more information about CoIPs, see Customer-owned IP addresses in the Amazon Web Services Outposts User Guide.
public RestoreDBInstanceToPointInTimeRequest withEnableCustomerOwnedIp(Boolean enableCustomerOwnedIp)
A value that indicates whether to enable a customer-owned IP address (CoIP) for an RDS on Outposts DB instance.
A CoIP provides local or external connectivity to resources in your Outpost subnets through your on-premises network. For some use cases, a CoIP can provide lower latency for connections to the DB instance from outside of its virtual private cloud (VPC) on your local network.
This setting doesn't apply to RDS Custom.
For more information about RDS on Outposts, see Working with Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.
For more information about CoIPs, see Customer-owned IP addresses in the Amazon Web Services Outposts User Guide.
enableCustomerOwnedIp
- A value that indicates whether to enable a customer-owned IP address (CoIP) for an RDS on Outposts DB
instance.
A CoIP provides local or external connectivity to resources in your Outpost subnets through your on-premises network. For some use cases, a CoIP can provide lower latency for connections to the DB instance from outside of its virtual private cloud (VPC) on your local network.
This setting doesn't apply to RDS Custom.
For more information about RDS on Outposts, see Working with Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.
For more information about CoIPs, see Customer-owned IP addresses in the Amazon Web Services Outposts User Guide.
public Boolean isEnableCustomerOwnedIp()
A value that indicates whether to enable a customer-owned IP address (CoIP) for an RDS on Outposts DB instance.
A CoIP provides local or external connectivity to resources in your Outpost subnets through your on-premises network. For some use cases, a CoIP can provide lower latency for connections to the DB instance from outside of its virtual private cloud (VPC) on your local network.
This setting doesn't apply to RDS Custom.
For more information about RDS on Outposts, see Working with Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.
For more information about CoIPs, see Customer-owned IP addresses in the Amazon Web Services Outposts User Guide.
A CoIP provides local or external connectivity to resources in your Outpost subnets through your on-premises network. For some use cases, a CoIP can provide lower latency for connections to the DB instance from outside of its virtual private cloud (VPC) on your local network.
This setting doesn't apply to RDS Custom.
For more information about RDS on Outposts, see Working with Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.
For more information about CoIPs, see Customer-owned IP addresses in the Amazon Web Services Outposts User Guide.
public void setCustomIamInstanceProfile(String customIamInstanceProfile)
The instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance. The instance profile must meet the following requirements:
The profile must exist in your account.
The profile must have an IAM role that Amazon EC2 has permissions to assume.
The instance profile name and the associated IAM role name must start with the prefix AWSRDSCustom
.
For the list of permissions required for the IAM role, see Configure IAM and your VPC in the Amazon RDS User Guide.
This setting is required for RDS Custom.
customIamInstanceProfile
- The instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance. The
instance profile must meet the following requirements:
The profile must exist in your account.
The profile must have an IAM role that Amazon EC2 has permissions to assume.
The instance profile name and the associated IAM role name must start with the prefix
AWSRDSCustom
.
For the list of permissions required for the IAM role, see Configure IAM and your VPC in the Amazon RDS User Guide.
This setting is required for RDS Custom.
public String getCustomIamInstanceProfile()
The instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance. The instance profile must meet the following requirements:
The profile must exist in your account.
The profile must have an IAM role that Amazon EC2 has permissions to assume.
The instance profile name and the associated IAM role name must start with the prefix AWSRDSCustom
.
For the list of permissions required for the IAM role, see Configure IAM and your VPC in the Amazon RDS User Guide.
This setting is required for RDS Custom.
The profile must exist in your account.
The profile must have an IAM role that Amazon EC2 has permissions to assume.
The instance profile name and the associated IAM role name must start with the prefix
AWSRDSCustom
.
For the list of permissions required for the IAM role, see Configure IAM and your VPC in the Amazon RDS User Guide.
This setting is required for RDS Custom.
public RestoreDBInstanceToPointInTimeRequest withCustomIamInstanceProfile(String customIamInstanceProfile)
The instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance. The instance profile must meet the following requirements:
The profile must exist in your account.
The profile must have an IAM role that Amazon EC2 has permissions to assume.
The instance profile name and the associated IAM role name must start with the prefix AWSRDSCustom
.
For the list of permissions required for the IAM role, see Configure IAM and your VPC in the Amazon RDS User Guide.
This setting is required for RDS Custom.
customIamInstanceProfile
- The instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance. The
instance profile must meet the following requirements:
The profile must exist in your account.
The profile must have an IAM role that Amazon EC2 has permissions to assume.
The instance profile name and the associated IAM role name must start with the prefix
AWSRDSCustom
.
For the list of permissions required for the IAM role, see Configure IAM and your VPC in the Amazon RDS User Guide.
This setting is required for RDS Custom.
public void setBackupTarget(String backupTarget)
Specifies where automated backups and manual snapshots are stored for the restored DB instance.
Possible values are outposts
(Amazon Web Services Outposts) and region
(Amazon Web
Services Region). The default is region
.
For more information, see Working with Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.
backupTarget
- Specifies where automated backups and manual snapshots are stored for the restored DB instance.
Possible values are outposts
(Amazon Web Services Outposts) and region
(Amazon
Web Services Region). The default is region
.
For more information, see Working with Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.
public String getBackupTarget()
Specifies where automated backups and manual snapshots are stored for the restored DB instance.
Possible values are outposts
(Amazon Web Services Outposts) and region
(Amazon Web
Services Region). The default is region
.
For more information, see Working with Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.
Possible values are outposts
(Amazon Web Services Outposts) and region
(Amazon
Web Services Region). The default is region
.
For more information, see Working with Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.
public RestoreDBInstanceToPointInTimeRequest withBackupTarget(String backupTarget)
Specifies where automated backups and manual snapshots are stored for the restored DB instance.
Possible values are outposts
(Amazon Web Services Outposts) and region
(Amazon Web
Services Region). The default is region
.
For more information, see Working with Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.
backupTarget
- Specifies where automated backups and manual snapshots are stored for the restored DB instance.
Possible values are outposts
(Amazon Web Services Outposts) and region
(Amazon
Web Services Region). The default is region
.
For more information, see Working with Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.
public void setNetworkType(String networkType)
The network type of the DB instance.
Valid values:
IPV4
DUAL
The network type is determined by the DBSubnetGroup
specified for the DB instance. A
DBSubnetGroup
can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (
DUAL
).
For more information, see Working with a DB instance in a VPC in the Amazon RDS User Guide.
networkType
- The network type of the DB instance.
Valid values:
IPV4
DUAL
The network type is determined by the DBSubnetGroup
specified for the DB instance. A
DBSubnetGroup
can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (
DUAL
).
For more information, see Working with a DB instance in a VPC in the Amazon RDS User Guide.
public String getNetworkType()
The network type of the DB instance.
Valid values:
IPV4
DUAL
The network type is determined by the DBSubnetGroup
specified for the DB instance. A
DBSubnetGroup
can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (
DUAL
).
For more information, see Working with a DB instance in a VPC in the Amazon RDS User Guide.
Valid values:
IPV4
DUAL
The network type is determined by the DBSubnetGroup
specified for the DB instance. A
DBSubnetGroup
can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (
DUAL
).
For more information, see Working with a DB instance in a VPC in the Amazon RDS User Guide.
public RestoreDBInstanceToPointInTimeRequest withNetworkType(String networkType)
The network type of the DB instance.
Valid values:
IPV4
DUAL
The network type is determined by the DBSubnetGroup
specified for the DB instance. A
DBSubnetGroup
can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (
DUAL
).
For more information, see Working with a DB instance in a VPC in the Amazon RDS User Guide.
networkType
- The network type of the DB instance.
Valid values:
IPV4
DUAL
The network type is determined by the DBSubnetGroup
specified for the DB instance. A
DBSubnetGroup
can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (
DUAL
).
For more information, see Working with a DB instance in a VPC in the Amazon RDS User Guide.
public void setStorageThroughput(Integer storageThroughput)
Specifies the storage throughput value for the DB instance.
This setting doesn't apply to RDS Custom or Amazon Aurora.
storageThroughput
- Specifies the storage throughput value for the DB instance.
This setting doesn't apply to RDS Custom or Amazon Aurora.
public Integer getStorageThroughput()
Specifies the storage throughput value for the DB instance.
This setting doesn't apply to RDS Custom or Amazon Aurora.
This setting doesn't apply to RDS Custom or Amazon Aurora.
public RestoreDBInstanceToPointInTimeRequest withStorageThroughput(Integer storageThroughput)
Specifies the storage throughput value for the DB instance.
This setting doesn't apply to RDS Custom or Amazon Aurora.
storageThroughput
- Specifies the storage throughput value for the DB instance.
This setting doesn't apply to RDS Custom or Amazon Aurora.
public void setAllocatedStorage(Integer allocatedStorage)
The amount of storage (in gibibytes) to allocate initially for the DB instance. Follow the allocation rules
specified in CreateDBInstance
.
Be sure to allocate enough storage for your new DB instance so that the restore operation can succeed. You can also allocate additional storage for future growth.
allocatedStorage
- The amount of storage (in gibibytes) to allocate initially for the DB instance. Follow the allocation
rules specified in CreateDBInstance
. Be sure to allocate enough storage for your new DB instance so that the restore operation can succeed. You can also allocate additional storage for future growth.
public Integer getAllocatedStorage()
The amount of storage (in gibibytes) to allocate initially for the DB instance. Follow the allocation rules
specified in CreateDBInstance
.
Be sure to allocate enough storage for your new DB instance so that the restore operation can succeed. You can also allocate additional storage for future growth.
CreateDBInstance
. Be sure to allocate enough storage for your new DB instance so that the restore operation can succeed. You can also allocate additional storage for future growth.
public RestoreDBInstanceToPointInTimeRequest withAllocatedStorage(Integer allocatedStorage)
The amount of storage (in gibibytes) to allocate initially for the DB instance. Follow the allocation rules
specified in CreateDBInstance
.
Be sure to allocate enough storage for your new DB instance so that the restore operation can succeed. You can also allocate additional storage for future growth.
allocatedStorage
- The amount of storage (in gibibytes) to allocate initially for the DB instance. Follow the allocation
rules specified in CreateDBInstance
. Be sure to allocate enough storage for your new DB instance so that the restore operation can succeed. You can also allocate additional storage for future growth.
public String toString()
toString
in class Object
Object.toString()
public RestoreDBInstanceToPointInTimeRequest clone()
AmazonWebServiceRequest
clone
in class AmazonWebServiceRequest
Object.clone()