@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class RestoreDBInstanceFromS3Request extends AmazonWebServiceRequest implements Serializable, Cloneable
NOOP
Constructor and Description |
---|
RestoreDBInstanceFromS3Request() |
Modifier and Type | Method and Description |
---|---|
RestoreDBInstanceFromS3Request |
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()
Specifies whether to automatically apply minor engine upgrades to the DB instance during the maintenance window.
|
String |
getAvailabilityZone()
The Availability Zone that the DB instance is created in.
|
Integer |
getBackupRetentionPeriod()
The number of days for which automated backups are retained.
|
String |
getCACertificateIdentifier()
The CA certificate identifier to use for the DB instance's server certificate.
|
Boolean |
getCopyTagsToSnapshot()
Specifies whether to copy all tags from the DB instance to snapshots of the DB instance.
|
String |
getDBInstanceClass()
The compute and memory capacity of the DB instance, for example db.m4.large.
|
String |
getDBInstanceIdentifier()
The DB instance identifier.
|
String |
getDBName()
The name of the database to create when the DB instance is created.
|
String |
getDBParameterGroupName()
The name of the DB parameter group to associate with this DB instance.
|
List<String> |
getDBSecurityGroups()
A list of DB security groups to associate with this DB instance.
|
String |
getDBSubnetGroupName()
A DB subnet group to associate with this DB instance.
|
Boolean |
getDedicatedLogVolume()
Specifies whether to enable a dedicated log volume (DLV) for the DB instance.
|
Boolean |
getDeletionProtection()
Specifies whether to enable deletion protection for the DB instance.
|
List<String> |
getEnableCloudwatchLogsExports()
The list of logs that the restored DB instance is to export to CloudWatch Logs.
|
Boolean |
getEnableIAMDatabaseAuthentication()
Specifies whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to
database accounts.
|
Boolean |
getEnablePerformanceInsights()
Specifies whether to enable Performance Insights for the DB instance.
|
String |
getEngine()
The name of the database engine to be used for this instance.
|
String |
getEngineLifecycleSupport()
The life cycle type for this DB instance.
|
String |
getEngineVersion()
The version number of the database engine to use.
|
Integer |
getIops()
The amount of Provisioned IOPS (input/output operations per second) to allocate initially for the DB instance.
|
String |
getKmsKeyId()
The Amazon Web Services KMS key identifier for an encrypted DB instance.
|
String |
getLicenseModel()
The license model for this DB instance.
|
Boolean |
getManageMasterUserPassword()
Specifies whether to manage the master user password with Amazon Web Services Secrets Manager.
|
String |
getMasterUsername()
The name for the master user.
|
String |
getMasterUserPassword()
The password for the master user.
|
String |
getMasterUserSecretKmsKeyId()
The Amazon Web Services KMS key identifier to encrypt a secret that is automatically generated and managed in
Amazon Web Services Secrets Manager.
|
Integer |
getMaxAllocatedStorage()
The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance.
|
Integer |
getMonitoringInterval()
The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance.
|
String |
getMonitoringRoleArn()
The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs.
|
Boolean |
getMultiAZ()
Specifies 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 associate with this DB instance.
|
String |
getPerformanceInsightsKMSKeyId()
The Amazon Web Services KMS key identifier for encryption of Performance Insights data.
|
Integer |
getPerformanceInsightsRetentionPeriod()
The number of days to retain Performance Insights data.
|
Integer |
getPort()
The port number on which the database accepts connections.
|
String |
getPreferredBackupWindow()
The time range each day during which automated backups are created if automated backups are enabled.
|
String |
getPreferredMaintenanceWindow()
The time range each week during which system maintenance can occur, in Universal Coordinated Time (UTC).
|
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()
Specifies whether the DB instance is publicly accessible.
|
String |
getS3BucketName()
The name of your Amazon S3 bucket that contains your database backup file.
|
String |
getS3IngestionRoleArn()
An Amazon Web Services Identity and Access Management (IAM) role with a trust policy and a permissions policy
that allows Amazon RDS to access your Amazon S3 bucket.
|
String |
getS3Prefix()
The prefix of your Amazon S3 bucket.
|
String |
getSourceEngine()
The name of the engine of your source database.
|
String |
getSourceEngineVersion()
The version of the database that the backup files were created from.
|
Boolean |
getStorageEncrypted()
Specifies whether the new DB instance is encrypted or not.
|
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()
A list of tags to associate with this DB instance.
|
Boolean |
getUseDefaultProcessorFeatures()
Specifies whether the DB instance class of the DB instance uses its default processor features.
|
List<String> |
getVpcSecurityGroupIds()
A list of VPC security groups to associate with this DB instance.
|
int |
hashCode() |
Boolean |
isAutoMinorVersionUpgrade()
Specifies whether to automatically apply minor engine upgrades to the DB instance during the maintenance window.
|
Boolean |
isCopyTagsToSnapshot()
Specifies whether to copy all tags from the DB instance to snapshots of the DB instance.
|
Boolean |
isDedicatedLogVolume()
Specifies whether to enable a dedicated log volume (DLV) for the DB instance.
|
Boolean |
isDeletionProtection()
Specifies whether to enable deletion protection for the DB instance.
|
Boolean |
isEnableIAMDatabaseAuthentication()
Specifies whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to
database accounts.
|
Boolean |
isEnablePerformanceInsights()
Specifies whether to enable Performance Insights for the DB instance.
|
Boolean |
isManageMasterUserPassword()
Specifies whether to manage the master user password with Amazon Web Services Secrets Manager.
|
Boolean |
isMultiAZ()
Specifies whether the DB instance is a Multi-AZ deployment.
|
Boolean |
isPubliclyAccessible()
Specifies whether the DB instance is publicly accessible.
|
Boolean |
isStorageEncrypted()
Specifies whether the new DB instance is encrypted or not.
|
Boolean |
isUseDefaultProcessorFeatures()
Specifies whether the DB instance class of the DB instance uses its default processor features.
|
void |
setAllocatedStorage(Integer allocatedStorage)
The amount of storage (in gibibytes) to allocate initially for the DB instance.
|
void |
setAutoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade)
Specifies whether to automatically apply minor engine upgrades to the DB instance during the maintenance window.
|
void |
setAvailabilityZone(String availabilityZone)
The Availability Zone that the DB instance is created in.
|
void |
setBackupRetentionPeriod(Integer backupRetentionPeriod)
The number of days for which automated backups are retained.
|
void |
setCACertificateIdentifier(String cACertificateIdentifier)
The CA certificate identifier to use for the DB instance's server certificate.
|
void |
setCopyTagsToSnapshot(Boolean copyTagsToSnapshot)
Specifies whether to copy all tags from the DB instance to snapshots of the DB instance.
|
void |
setDBInstanceClass(String dBInstanceClass)
The compute and memory capacity of the DB instance, for example db.m4.large.
|
void |
setDBInstanceIdentifier(String dBInstanceIdentifier)
The DB instance identifier.
|
void |
setDBName(String dBName)
The name of the database to create when the DB instance is created.
|
void |
setDBParameterGroupName(String dBParameterGroupName)
The name of the DB parameter group to associate with this DB instance.
|
void |
setDBSecurityGroups(Collection<String> dBSecurityGroups)
A list of DB security groups to associate with this DB instance.
|
void |
setDBSubnetGroupName(String dBSubnetGroupName)
A DB subnet group to associate with this DB instance.
|
void |
setDedicatedLogVolume(Boolean dedicatedLogVolume)
Specifies whether to enable a dedicated log volume (DLV) for the DB instance.
|
void |
setDeletionProtection(Boolean deletionProtection)
Specifies whether to enable deletion protection for the DB instance.
|
void |
setEnableCloudwatchLogsExports(Collection<String> enableCloudwatchLogsExports)
The list of logs that the restored DB instance is to export to CloudWatch Logs.
|
void |
setEnableIAMDatabaseAuthentication(Boolean enableIAMDatabaseAuthentication)
Specifies whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to
database accounts.
|
void |
setEnablePerformanceInsights(Boolean enablePerformanceInsights)
Specifies whether to enable Performance Insights for the DB instance.
|
void |
setEngine(String engine)
The name of the database engine to be used for this instance.
|
void |
setEngineLifecycleSupport(String engineLifecycleSupport)
The life cycle type for this DB instance.
|
void |
setEngineVersion(String engineVersion)
The version number of the database engine to use.
|
void |
setIops(Integer iops)
The amount of Provisioned IOPS (input/output operations per second) to allocate initially for the DB instance.
|
void |
setKmsKeyId(String kmsKeyId)
The Amazon Web Services KMS key identifier for an encrypted DB instance.
|
void |
setLicenseModel(String licenseModel)
The license model for this DB instance.
|
void |
setManageMasterUserPassword(Boolean manageMasterUserPassword)
Specifies whether to manage the master user password with Amazon Web Services Secrets Manager.
|
void |
setMasterUsername(String masterUsername)
The name for the master user.
|
void |
setMasterUserPassword(String masterUserPassword)
The password for the master user.
|
void |
setMasterUserSecretKmsKeyId(String masterUserSecretKmsKeyId)
The Amazon Web Services KMS key identifier to encrypt a secret that is automatically generated and managed in
Amazon Web Services Secrets Manager.
|
void |
setMaxAllocatedStorage(Integer maxAllocatedStorage)
The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance.
|
void |
setMonitoringInterval(Integer monitoringInterval)
The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance.
|
void |
setMonitoringRoleArn(String monitoringRoleArn)
The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs.
|
void |
setMultiAZ(Boolean multiAZ)
Specifies 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 associate with this DB instance.
|
void |
setPerformanceInsightsKMSKeyId(String performanceInsightsKMSKeyId)
The Amazon Web Services KMS key identifier for encryption of Performance Insights data.
|
void |
setPerformanceInsightsRetentionPeriod(Integer performanceInsightsRetentionPeriod)
The number of days to retain Performance Insights data.
|
void |
setPort(Integer port)
The port number on which the database accepts connections.
|
void |
setPreferredBackupWindow(String preferredBackupWindow)
The time range each day during which automated backups are created if automated backups are enabled.
|
void |
setPreferredMaintenanceWindow(String preferredMaintenanceWindow)
The time range each week during which system maintenance can occur, in Universal Coordinated Time (UTC).
|
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)
Specifies whether the DB instance is publicly accessible.
|
void |
setS3BucketName(String s3BucketName)
The name of your Amazon S3 bucket that contains your database backup file.
|
void |
setS3IngestionRoleArn(String s3IngestionRoleArn)
An Amazon Web Services Identity and Access Management (IAM) role with a trust policy and a permissions policy
that allows Amazon RDS to access your Amazon S3 bucket.
|
void |
setS3Prefix(String s3Prefix)
The prefix of your Amazon S3 bucket.
|
void |
setSourceEngine(String sourceEngine)
The name of the engine of your source database.
|
void |
setSourceEngineVersion(String sourceEngineVersion)
The version of the database that the backup files were created from.
|
void |
setStorageEncrypted(Boolean storageEncrypted)
Specifies whether the new DB instance is encrypted or not.
|
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)
A list of tags to associate with this DB instance.
|
void |
setUseDefaultProcessorFeatures(Boolean useDefaultProcessorFeatures)
Specifies whether the DB instance class of the DB instance uses its default processor features.
|
void |
setVpcSecurityGroupIds(Collection<String> vpcSecurityGroupIds)
A list of VPC security groups to associate with this DB instance.
|
String |
toString()
Returns a string representation of this object.
|
RestoreDBInstanceFromS3Request |
withAllocatedStorage(Integer allocatedStorage)
The amount of storage (in gibibytes) to allocate initially for the DB instance.
|
RestoreDBInstanceFromS3Request |
withAutoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade)
Specifies whether to automatically apply minor engine upgrades to the DB instance during the maintenance window.
|
RestoreDBInstanceFromS3Request |
withAvailabilityZone(String availabilityZone)
The Availability Zone that the DB instance is created in.
|
RestoreDBInstanceFromS3Request |
withBackupRetentionPeriod(Integer backupRetentionPeriod)
The number of days for which automated backups are retained.
|
RestoreDBInstanceFromS3Request |
withCACertificateIdentifier(String cACertificateIdentifier)
The CA certificate identifier to use for the DB instance's server certificate.
|
RestoreDBInstanceFromS3Request |
withCopyTagsToSnapshot(Boolean copyTagsToSnapshot)
Specifies whether to copy all tags from the DB instance to snapshots of the DB instance.
|
RestoreDBInstanceFromS3Request |
withDBInstanceClass(String dBInstanceClass)
The compute and memory capacity of the DB instance, for example db.m4.large.
|
RestoreDBInstanceFromS3Request |
withDBInstanceIdentifier(String dBInstanceIdentifier)
The DB instance identifier.
|
RestoreDBInstanceFromS3Request |
withDBName(String dBName)
The name of the database to create when the DB instance is created.
|
RestoreDBInstanceFromS3Request |
withDBParameterGroupName(String dBParameterGroupName)
The name of the DB parameter group to associate with this DB instance.
|
RestoreDBInstanceFromS3Request |
withDBSecurityGroups(Collection<String> dBSecurityGroups)
A list of DB security groups to associate with this DB instance.
|
RestoreDBInstanceFromS3Request |
withDBSecurityGroups(String... dBSecurityGroups)
A list of DB security groups to associate with this DB instance.
|
RestoreDBInstanceFromS3Request |
withDBSubnetGroupName(String dBSubnetGroupName)
A DB subnet group to associate with this DB instance.
|
RestoreDBInstanceFromS3Request |
withDedicatedLogVolume(Boolean dedicatedLogVolume)
Specifies whether to enable a dedicated log volume (DLV) for the DB instance.
|
RestoreDBInstanceFromS3Request |
withDeletionProtection(Boolean deletionProtection)
Specifies whether to enable deletion protection for the DB instance.
|
RestoreDBInstanceFromS3Request |
withEnableCloudwatchLogsExports(Collection<String> enableCloudwatchLogsExports)
The list of logs that the restored DB instance is to export to CloudWatch Logs.
|
RestoreDBInstanceFromS3Request |
withEnableCloudwatchLogsExports(String... enableCloudwatchLogsExports)
The list of logs that the restored DB instance is to export to CloudWatch Logs.
|
RestoreDBInstanceFromS3Request |
withEnableIAMDatabaseAuthentication(Boolean enableIAMDatabaseAuthentication)
Specifies whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to
database accounts.
|
RestoreDBInstanceFromS3Request |
withEnablePerformanceInsights(Boolean enablePerformanceInsights)
Specifies whether to enable Performance Insights for the DB instance.
|
RestoreDBInstanceFromS3Request |
withEngine(String engine)
The name of the database engine to be used for this instance.
|
RestoreDBInstanceFromS3Request |
withEngineLifecycleSupport(String engineLifecycleSupport)
The life cycle type for this DB instance.
|
RestoreDBInstanceFromS3Request |
withEngineVersion(String engineVersion)
The version number of the database engine to use.
|
RestoreDBInstanceFromS3Request |
withIops(Integer iops)
The amount of Provisioned IOPS (input/output operations per second) to allocate initially for the DB instance.
|
RestoreDBInstanceFromS3Request |
withKmsKeyId(String kmsKeyId)
The Amazon Web Services KMS key identifier for an encrypted DB instance.
|
RestoreDBInstanceFromS3Request |
withLicenseModel(String licenseModel)
The license model for this DB instance.
|
RestoreDBInstanceFromS3Request |
withManageMasterUserPassword(Boolean manageMasterUserPassword)
Specifies whether to manage the master user password with Amazon Web Services Secrets Manager.
|
RestoreDBInstanceFromS3Request |
withMasterUsername(String masterUsername)
The name for the master user.
|
RestoreDBInstanceFromS3Request |
withMasterUserPassword(String masterUserPassword)
The password for the master user.
|
RestoreDBInstanceFromS3Request |
withMasterUserSecretKmsKeyId(String masterUserSecretKmsKeyId)
The Amazon Web Services KMS key identifier to encrypt a secret that is automatically generated and managed in
Amazon Web Services Secrets Manager.
|
RestoreDBInstanceFromS3Request |
withMaxAllocatedStorage(Integer maxAllocatedStorage)
The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance.
|
RestoreDBInstanceFromS3Request |
withMonitoringInterval(Integer monitoringInterval)
The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance.
|
RestoreDBInstanceFromS3Request |
withMonitoringRoleArn(String monitoringRoleArn)
The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs.
|
RestoreDBInstanceFromS3Request |
withMultiAZ(Boolean multiAZ)
Specifies whether the DB instance is a Multi-AZ deployment.
|
RestoreDBInstanceFromS3Request |
withNetworkType(String networkType)
The network type of the DB instance.
|
RestoreDBInstanceFromS3Request |
withOptionGroupName(String optionGroupName)
The name of the option group to associate with this DB instance.
|
RestoreDBInstanceFromS3Request |
withPerformanceInsightsKMSKeyId(String performanceInsightsKMSKeyId)
The Amazon Web Services KMS key identifier for encryption of Performance Insights data.
|
RestoreDBInstanceFromS3Request |
withPerformanceInsightsRetentionPeriod(Integer performanceInsightsRetentionPeriod)
The number of days to retain Performance Insights data.
|
RestoreDBInstanceFromS3Request |
withPort(Integer port)
The port number on which the database accepts connections.
|
RestoreDBInstanceFromS3Request |
withPreferredBackupWindow(String preferredBackupWindow)
The time range each day during which automated backups are created if automated backups are enabled.
|
RestoreDBInstanceFromS3Request |
withPreferredMaintenanceWindow(String preferredMaintenanceWindow)
The time range each week during which system maintenance can occur, in Universal Coordinated Time (UTC).
|
RestoreDBInstanceFromS3Request |
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.
|
RestoreDBInstanceFromS3Request |
withProcessorFeatures(ProcessorFeature... processorFeatures)
The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
|
RestoreDBInstanceFromS3Request |
withPubliclyAccessible(Boolean publiclyAccessible)
Specifies whether the DB instance is publicly accessible.
|
RestoreDBInstanceFromS3Request |
withS3BucketName(String s3BucketName)
The name of your Amazon S3 bucket that contains your database backup file.
|
RestoreDBInstanceFromS3Request |
withS3IngestionRoleArn(String s3IngestionRoleArn)
An Amazon Web Services Identity and Access Management (IAM) role with a trust policy and a permissions policy
that allows Amazon RDS to access your Amazon S3 bucket.
|
RestoreDBInstanceFromS3Request |
withS3Prefix(String s3Prefix)
The prefix of your Amazon S3 bucket.
|
RestoreDBInstanceFromS3Request |
withSourceEngine(String sourceEngine)
The name of the engine of your source database.
|
RestoreDBInstanceFromS3Request |
withSourceEngineVersion(String sourceEngineVersion)
The version of the database that the backup files were created from.
|
RestoreDBInstanceFromS3Request |
withStorageEncrypted(Boolean storageEncrypted)
Specifies whether the new DB instance is encrypted or not.
|
RestoreDBInstanceFromS3Request |
withStorageThroughput(Integer storageThroughput)
Specifies the storage throughput value for the DB instance.
|
RestoreDBInstanceFromS3Request |
withStorageType(String storageType)
Specifies the storage type to be associated with the DB instance.
|
RestoreDBInstanceFromS3Request |
withTags(Collection<Tag> tags)
A list of tags to associate with this DB instance.
|
RestoreDBInstanceFromS3Request |
withTags(Tag... tags)
A list of tags to associate with this DB instance.
|
RestoreDBInstanceFromS3Request |
withUseDefaultProcessorFeatures(Boolean useDefaultProcessorFeatures)
Specifies whether the DB instance class of the DB instance uses its default processor features.
|
RestoreDBInstanceFromS3Request |
withVpcSecurityGroupIds(Collection<String> vpcSecurityGroupIds)
A list of VPC security groups to associate with this DB instance.
|
RestoreDBInstanceFromS3Request |
withVpcSecurityGroupIds(String... vpcSecurityGroupIds)
A list of 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 void setDBName(String dBName)
The name of the database to create when the DB instance is created. Follow the naming rules specified in
CreateDBInstance
.
dBName
- The name of the database to create when the DB instance is created. Follow the naming rules specified in
CreateDBInstance
.public String getDBName()
The name of the database to create when the DB instance is created. Follow the naming rules specified in
CreateDBInstance
.
CreateDBInstance
.public RestoreDBInstanceFromS3Request withDBName(String dBName)
The name of the database to create when the DB instance is created. Follow the naming rules specified in
CreateDBInstance
.
dBName
- The name of the database to create when the DB instance is created. Follow the naming rules specified in
CreateDBInstance
.public void setDBInstanceIdentifier(String dBInstanceIdentifier)
The DB instance identifier. This parameter is stored as a lowercase string.
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.
Example: mydbinstance
dBInstanceIdentifier
- The DB instance identifier. This parameter is stored as a lowercase string.
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.
Example: mydbinstance
public String getDBInstanceIdentifier()
The DB instance identifier. This parameter is stored as a lowercase string.
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.
Example: mydbinstance
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.
Example: mydbinstance
public RestoreDBInstanceFromS3Request withDBInstanceIdentifier(String dBInstanceIdentifier)
The DB instance identifier. This parameter is stored as a lowercase string.
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.
Example: mydbinstance
dBInstanceIdentifier
- The DB instance identifier. This parameter is stored as a lowercase string.
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.
Example: mydbinstance
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 RestoreDBInstanceFromS3Request 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 void setDBInstanceClass(String dBInstanceClass)
The compute and memory capacity of the 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.
Importing from Amazon S3 isn't supported on the db.t2.micro DB instance class.
dBInstanceClass
- The compute and memory capacity of the 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.
Importing from Amazon S3 isn't supported on the db.t2.micro DB instance class.
public String getDBInstanceClass()
The compute and memory capacity of the 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.
Importing from Amazon S3 isn't supported on the db.t2.micro DB instance class.
Importing from Amazon S3 isn't supported on the db.t2.micro DB instance class.
public RestoreDBInstanceFromS3Request withDBInstanceClass(String dBInstanceClass)
The compute and memory capacity of the 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.
Importing from Amazon S3 isn't supported on the db.t2.micro DB instance class.
dBInstanceClass
- The compute and memory capacity of the 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.
Importing from Amazon S3 isn't supported on the db.t2.micro DB instance class.
public void setEngine(String engine)
The name of the database engine to be used for this instance.
Valid Values: mysql
engine
- The name of the database engine to be used for this instance.
Valid Values: mysql
public String getEngine()
The name of the database engine to be used for this instance.
Valid Values: mysql
Valid Values: mysql
public RestoreDBInstanceFromS3Request withEngine(String engine)
The name of the database engine to be used for this instance.
Valid Values: mysql
engine
- The name of the database engine to be used for this instance.
Valid Values: mysql
public void setMasterUsername(String masterUsername)
The name for the master user.
Constraints:
Must be 1 to 16 letters or numbers.
First character must be a letter.
Can't be a reserved word for the chosen database engine.
masterUsername
- The name for the master user.
Constraints:
Must be 1 to 16 letters or numbers.
First character must be a letter.
Can't be a reserved word for the chosen database engine.
public String getMasterUsername()
The name for the master user.
Constraints:
Must be 1 to 16 letters or numbers.
First character must be a letter.
Can't be a reserved word for the chosen database engine.
Constraints:
Must be 1 to 16 letters or numbers.
First character must be a letter.
Can't be a reserved word for the chosen database engine.
public RestoreDBInstanceFromS3Request withMasterUsername(String masterUsername)
The name for the master user.
Constraints:
Must be 1 to 16 letters or numbers.
First character must be a letter.
Can't be a reserved word for the chosen database engine.
masterUsername
- The name for the master user.
Constraints:
Must be 1 to 16 letters or numbers.
First character must be a letter.
Can't be a reserved word for the chosen database engine.
public void setMasterUserPassword(String masterUserPassword)
The password for the master user.
Constraints:
Can't be specified if ManageMasterUserPassword
is turned on.
Can include any printable ASCII character except "/", """, or "@". For RDS for Oracle, can't include the "&" (ampersand) or the "'" (single quotes) character.
Length Constraints:
RDS for Db2 - Must contain from 8 to 128 characters.
RDS for MariaDB - Must contain from 8 to 41 characters.
RDS for Microsoft SQL Server - Must contain from 8 to 128 characters.
RDS for MySQL - Must contain from 8 to 41 characters.
RDS for Oracle - Must contain from 8 to 30 characters.
RDS for PostgreSQL - Must contain from 8 to 128 characters.
masterUserPassword
- The password for the master user.
Constraints:
Can't be specified if ManageMasterUserPassword
is turned on.
Can include any printable ASCII character except "/", """, or "@". For RDS for Oracle, can't include the "&" (ampersand) or the "'" (single quotes) character.
Length Constraints:
RDS for Db2 - Must contain from 8 to 128 characters.
RDS for MariaDB - Must contain from 8 to 41 characters.
RDS for Microsoft SQL Server - Must contain from 8 to 128 characters.
RDS for MySQL - Must contain from 8 to 41 characters.
RDS for Oracle - Must contain from 8 to 30 characters.
RDS for PostgreSQL - Must contain from 8 to 128 characters.
public String getMasterUserPassword()
The password for the master user.
Constraints:
Can't be specified if ManageMasterUserPassword
is turned on.
Can include any printable ASCII character except "/", """, or "@". For RDS for Oracle, can't include the "&" (ampersand) or the "'" (single quotes) character.
Length Constraints:
RDS for Db2 - Must contain from 8 to 128 characters.
RDS for MariaDB - Must contain from 8 to 41 characters.
RDS for Microsoft SQL Server - Must contain from 8 to 128 characters.
RDS for MySQL - Must contain from 8 to 41 characters.
RDS for Oracle - Must contain from 8 to 30 characters.
RDS for PostgreSQL - Must contain from 8 to 128 characters.
Constraints:
Can't be specified if ManageMasterUserPassword
is turned on.
Can include any printable ASCII character except "/", """, or "@". For RDS for Oracle, can't include the "&" (ampersand) or the "'" (single quotes) character.
Length Constraints:
RDS for Db2 - Must contain from 8 to 128 characters.
RDS for MariaDB - Must contain from 8 to 41 characters.
RDS for Microsoft SQL Server - Must contain from 8 to 128 characters.
RDS for MySQL - Must contain from 8 to 41 characters.
RDS for Oracle - Must contain from 8 to 30 characters.
RDS for PostgreSQL - Must contain from 8 to 128 characters.
public RestoreDBInstanceFromS3Request withMasterUserPassword(String masterUserPassword)
The password for the master user.
Constraints:
Can't be specified if ManageMasterUserPassword
is turned on.
Can include any printable ASCII character except "/", """, or "@". For RDS for Oracle, can't include the "&" (ampersand) or the "'" (single quotes) character.
Length Constraints:
RDS for Db2 - Must contain from 8 to 128 characters.
RDS for MariaDB - Must contain from 8 to 41 characters.
RDS for Microsoft SQL Server - Must contain from 8 to 128 characters.
RDS for MySQL - Must contain from 8 to 41 characters.
RDS for Oracle - Must contain from 8 to 30 characters.
RDS for PostgreSQL - Must contain from 8 to 128 characters.
masterUserPassword
- The password for the master user.
Constraints:
Can't be specified if ManageMasterUserPassword
is turned on.
Can include any printable ASCII character except "/", """, or "@". For RDS for Oracle, can't include the "&" (ampersand) or the "'" (single quotes) character.
Length Constraints:
RDS for Db2 - Must contain from 8 to 128 characters.
RDS for MariaDB - Must contain from 8 to 41 characters.
RDS for Microsoft SQL Server - Must contain from 8 to 128 characters.
RDS for MySQL - Must contain from 8 to 41 characters.
RDS for Oracle - Must contain from 8 to 30 characters.
RDS for PostgreSQL - Must contain from 8 to 128 characters.
public List<String> getDBSecurityGroups()
A list of DB security groups to associate with this DB instance.
Default: The default DB security group for the database engine.
Default: The default DB security group for the database engine.
public void setDBSecurityGroups(Collection<String> dBSecurityGroups)
A list of DB security groups to associate with this DB instance.
Default: The default DB security group for the database engine.
dBSecurityGroups
- A list of DB security groups to associate with this DB instance.
Default: The default DB security group for the database engine.
public RestoreDBInstanceFromS3Request withDBSecurityGroups(String... dBSecurityGroups)
A list of DB security groups to associate with this DB instance.
Default: The default DB security group for the database engine.
NOTE: This method appends the values to the existing list (if any). Use
setDBSecurityGroups(java.util.Collection)
or withDBSecurityGroups(java.util.Collection)
if you
want to override the existing values.
dBSecurityGroups
- A list of DB security groups to associate with this DB instance.
Default: The default DB security group for the database engine.
public RestoreDBInstanceFromS3Request withDBSecurityGroups(Collection<String> dBSecurityGroups)
A list of DB security groups to associate with this DB instance.
Default: The default DB security group for the database engine.
dBSecurityGroups
- A list of DB security groups to associate with this DB instance.
Default: The default DB security group for the database engine.
public List<String> getVpcSecurityGroupIds()
A list of VPC security groups to associate with this DB instance.
public void setVpcSecurityGroupIds(Collection<String> vpcSecurityGroupIds)
A list of VPC security groups to associate with this DB instance.
vpcSecurityGroupIds
- A list of VPC security groups to associate with this DB instance.public RestoreDBInstanceFromS3Request withVpcSecurityGroupIds(String... vpcSecurityGroupIds)
A list of VPC security groups to associate with this DB instance.
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 VPC security groups to associate with this DB instance.public RestoreDBInstanceFromS3Request withVpcSecurityGroupIds(Collection<String> vpcSecurityGroupIds)
A list of VPC security groups to associate with this DB instance.
vpcSecurityGroupIds
- A list of VPC security groups to associate with this DB instance.public void setAvailabilityZone(String availabilityZone)
The Availability Zone that the DB instance is created in. For information about Amazon Web Services Regions and Availability Zones, see Regions and Availability Zones in the Amazon RDS User Guide.
Default: A random, system-chosen Availability Zone in the endpoint's Amazon Web Services Region.
Example: us-east-1d
Constraint: The AvailabilityZone
parameter can't be specified if the DB instance is a Multi-AZ
deployment. The specified Availability Zone must be in the same Amazon Web Services Region as the current
endpoint.
availabilityZone
- The Availability Zone that the DB instance is created in. For information about Amazon Web Services
Regions and Availability Zones, see Regions and Availability Zones in the Amazon RDS User Guide.
Default: A random, system-chosen Availability Zone in the endpoint's Amazon Web Services Region.
Example: us-east-1d
Constraint: The AvailabilityZone
parameter can't be specified if the DB instance is a
Multi-AZ deployment. The specified Availability Zone must be in the same Amazon Web Services Region as the
current endpoint.
public String getAvailabilityZone()
The Availability Zone that the DB instance is created in. For information about Amazon Web Services Regions and Availability Zones, see Regions and Availability Zones in the Amazon RDS User Guide.
Default: A random, system-chosen Availability Zone in the endpoint's Amazon Web Services Region.
Example: us-east-1d
Constraint: The AvailabilityZone
parameter can't be specified if the DB instance is a Multi-AZ
deployment. The specified Availability Zone must be in the same Amazon Web Services Region as the current
endpoint.
Default: A random, system-chosen Availability Zone in the endpoint's Amazon Web Services Region.
Example: us-east-1d
Constraint: The AvailabilityZone
parameter can't be specified if the DB instance is a
Multi-AZ deployment. The specified Availability Zone must be in the same Amazon Web Services Region as
the current endpoint.
public RestoreDBInstanceFromS3Request withAvailabilityZone(String availabilityZone)
The Availability Zone that the DB instance is created in. For information about Amazon Web Services Regions and Availability Zones, see Regions and Availability Zones in the Amazon RDS User Guide.
Default: A random, system-chosen Availability Zone in the endpoint's Amazon Web Services Region.
Example: us-east-1d
Constraint: The AvailabilityZone
parameter can't be specified if the DB instance is a Multi-AZ
deployment. The specified Availability Zone must be in the same Amazon Web Services Region as the current
endpoint.
availabilityZone
- The Availability Zone that the DB instance is created in. For information about Amazon Web Services
Regions and Availability Zones, see Regions and Availability Zones in the Amazon RDS User Guide.
Default: A random, system-chosen Availability Zone in the endpoint's Amazon Web Services Region.
Example: us-east-1d
Constraint: The AvailabilityZone
parameter can't be specified if the DB instance is a
Multi-AZ deployment. The specified Availability Zone must be in the same Amazon Web Services Region as the
current endpoint.
public void setDBSubnetGroupName(String dBSubnetGroupName)
A DB subnet group to associate with this DB instance.
Constraints: If supplied, must match the name of an existing DBSubnetGroup.
Example: mydbsubnetgroup
dBSubnetGroupName
- A DB subnet group to associate with this DB instance.
Constraints: If supplied, must match the name of an existing DBSubnetGroup.
Example: mydbsubnetgroup
public String getDBSubnetGroupName()
A DB subnet group to associate with this DB 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 RestoreDBInstanceFromS3Request withDBSubnetGroupName(String dBSubnetGroupName)
A DB subnet group to associate with this DB instance.
Constraints: If supplied, must match the name of an existing DBSubnetGroup.
Example: mydbsubnetgroup
dBSubnetGroupName
- A DB subnet group to associate with this DB instance.
Constraints: If supplied, must match the name of an existing DBSubnetGroup.
Example: mydbsubnetgroup
public void setPreferredMaintenanceWindow(String preferredMaintenanceWindow)
The time range each week during which system maintenance can occur, in Universal Coordinated Time (UTC). For more information, see Amazon RDS Maintenance Window in the Amazon RDS User Guide.
Constraints:
Must be in the format ddd:hh24:mi-ddd:hh24:mi
.
Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.
Must be in Universal Coordinated Time (UTC).
Must not conflict with the preferred backup window.
Must be at least 30 minutes.
preferredMaintenanceWindow
- The time range each week during which system maintenance can occur, in Universal Coordinated Time (UTC).
For more information, see Amazon RDS Maintenance Window in the Amazon RDS User Guide.
Constraints:
Must be in the format ddd:hh24:mi-ddd:hh24:mi
.
Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.
Must be in Universal Coordinated Time (UTC).
Must not conflict with the preferred backup window.
Must be at least 30 minutes.
public String getPreferredMaintenanceWindow()
The time range each week during which system maintenance can occur, in Universal Coordinated Time (UTC). For more information, see Amazon RDS Maintenance Window in the Amazon RDS User Guide.
Constraints:
Must be in the format ddd:hh24:mi-ddd:hh24:mi
.
Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.
Must be in Universal Coordinated Time (UTC).
Must not conflict with the preferred backup window.
Must be at least 30 minutes.
Constraints:
Must be in the format ddd:hh24:mi-ddd:hh24:mi
.
Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.
Must be in Universal Coordinated Time (UTC).
Must not conflict with the preferred backup window.
Must be at least 30 minutes.
public RestoreDBInstanceFromS3Request withPreferredMaintenanceWindow(String preferredMaintenanceWindow)
The time range each week during which system maintenance can occur, in Universal Coordinated Time (UTC). For more information, see Amazon RDS Maintenance Window in the Amazon RDS User Guide.
Constraints:
Must be in the format ddd:hh24:mi-ddd:hh24:mi
.
Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.
Must be in Universal Coordinated Time (UTC).
Must not conflict with the preferred backup window.
Must be at least 30 minutes.
preferredMaintenanceWindow
- The time range each week during which system maintenance can occur, in Universal Coordinated Time (UTC).
For more information, see Amazon RDS Maintenance Window in the Amazon RDS User Guide.
Constraints:
Must be in the format ddd:hh24:mi-ddd:hh24:mi
.
Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.
Must be in Universal Coordinated Time (UTC).
Must not conflict with the preferred backup window.
Must be at least 30 minutes.
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.
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.
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.
If you do not specify a value for DBParameterGroupName
, then the default
DBParameterGroup
for the specified DB engine is used.
public RestoreDBInstanceFromS3Request 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.
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.
public void setBackupRetentionPeriod(Integer backupRetentionPeriod)
The number of days for which automated backups are retained. Setting this parameter to a positive number enables
backups. For more information, see CreateDBInstance
.
backupRetentionPeriod
- The number of days for which automated backups are retained. Setting this parameter to a positive number
enables backups. For more information, see CreateDBInstance
.public Integer getBackupRetentionPeriod()
The number of days for which automated backups are retained. Setting this parameter to a positive number enables
backups. For more information, see CreateDBInstance
.
CreateDBInstance
.public RestoreDBInstanceFromS3Request withBackupRetentionPeriod(Integer backupRetentionPeriod)
The number of days for which automated backups are retained. Setting this parameter to a positive number enables
backups. For more information, see CreateDBInstance
.
backupRetentionPeriod
- The number of days for which automated backups are retained. Setting this parameter to a positive number
enables backups. For more information, see CreateDBInstance
.public void setPreferredBackupWindow(String preferredBackupWindow)
The time range each day during which automated backups are created if automated backups are enabled. For more information, see Backup window in the Amazon RDS User Guide.
Constraints:
Must be in the format hh24:mi-hh24:mi
.
Must be in Universal Coordinated Time (UTC).
Must not conflict with the preferred maintenance window.
Must be at least 30 minutes.
preferredBackupWindow
- The time range each day during which automated backups are created if automated backups are enabled. For
more information, see Backup window in the Amazon RDS User Guide.
Constraints:
Must be in the format hh24:mi-hh24:mi
.
Must be in Universal Coordinated Time (UTC).
Must not conflict with the preferred maintenance window.
Must be at least 30 minutes.
public String getPreferredBackupWindow()
The time range each day during which automated backups are created if automated backups are enabled. For more information, see Backup window in the Amazon RDS User Guide.
Constraints:
Must be in the format hh24:mi-hh24:mi
.
Must be in Universal Coordinated Time (UTC).
Must not conflict with the preferred maintenance window.
Must be at least 30 minutes.
Constraints:
Must be in the format hh24:mi-hh24:mi
.
Must be in Universal Coordinated Time (UTC).
Must not conflict with the preferred maintenance window.
Must be at least 30 minutes.
public RestoreDBInstanceFromS3Request withPreferredBackupWindow(String preferredBackupWindow)
The time range each day during which automated backups are created if automated backups are enabled. For more information, see Backup window in the Amazon RDS User Guide.
Constraints:
Must be in the format hh24:mi-hh24:mi
.
Must be in Universal Coordinated Time (UTC).
Must not conflict with the preferred maintenance window.
Must be at least 30 minutes.
preferredBackupWindow
- The time range each day during which automated backups are created if automated backups are enabled. For
more information, see Backup window in the Amazon RDS User Guide.
Constraints:
Must be in the format hh24:mi-hh24:mi
.
Must be in Universal Coordinated Time (UTC).
Must not conflict with the preferred maintenance window.
Must be at least 30 minutes.
public void setPort(Integer port)
The port number on which the database accepts connections.
Type: Integer
Valid Values: 1150
-65535
Default: 3306
port
- The port number on which the database accepts connections.
Type: Integer
Valid Values: 1150
-65535
Default: 3306
public Integer getPort()
The port number on which the database accepts connections.
Type: Integer
Valid Values: 1150
-65535
Default: 3306
Type: Integer
Valid Values: 1150
-65535
Default: 3306
public RestoreDBInstanceFromS3Request withPort(Integer port)
The port number on which the database accepts connections.
Type: Integer
Valid Values: 1150
-65535
Default: 3306
port
- The port number on which the database accepts connections.
Type: Integer
Valid Values: 1150
-65535
Default: 3306
public void setMultiAZ(Boolean multiAZ)
Specifies whether the DB instance is a Multi-AZ deployment. If the DB instance is a Multi-AZ deployment, you
can't set the AvailabilityZone
parameter.
multiAZ
- Specifies whether the DB instance is a Multi-AZ deployment. If the DB instance is a Multi-AZ deployment,
you can't set the AvailabilityZone
parameter.public Boolean getMultiAZ()
Specifies whether the DB instance is a Multi-AZ deployment. If the DB instance is a Multi-AZ deployment, you
can't set the AvailabilityZone
parameter.
AvailabilityZone
parameter.public RestoreDBInstanceFromS3Request withMultiAZ(Boolean multiAZ)
Specifies whether the DB instance is a Multi-AZ deployment. If the DB instance is a Multi-AZ deployment, you
can't set the AvailabilityZone
parameter.
multiAZ
- Specifies whether the DB instance is a Multi-AZ deployment. If the DB instance is a Multi-AZ deployment,
you can't set the AvailabilityZone
parameter.public Boolean isMultiAZ()
Specifies whether the DB instance is a Multi-AZ deployment. If the DB instance is a Multi-AZ deployment, you
can't set the AvailabilityZone
parameter.
AvailabilityZone
parameter.public void setEngineVersion(String engineVersion)
The version number of the database engine to use. Choose the latest minor version of your database engine. For
information about engine versions, see CreateDBInstance
, or call
DescribeDBEngineVersions
.
engineVersion
- The version number of the database engine to use. Choose the latest minor version of your database engine.
For information about engine versions, see CreateDBInstance
, or call
DescribeDBEngineVersions
.public String getEngineVersion()
The version number of the database engine to use. Choose the latest minor version of your database engine. For
information about engine versions, see CreateDBInstance
, or call
DescribeDBEngineVersions
.
CreateDBInstance
, or call
DescribeDBEngineVersions
.public RestoreDBInstanceFromS3Request withEngineVersion(String engineVersion)
The version number of the database engine to use. Choose the latest minor version of your database engine. For
information about engine versions, see CreateDBInstance
, or call
DescribeDBEngineVersions
.
engineVersion
- The version number of the database engine to use. Choose the latest minor version of your database engine.
For information about engine versions, see CreateDBInstance
, or call
DescribeDBEngineVersions
.public void setAutoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade)
Specifies whether to automatically apply minor engine upgrades to the DB instance during the maintenance window. By default, minor engine upgrades are not applied automatically.
autoMinorVersionUpgrade
- Specifies whether to automatically apply minor engine upgrades to the DB instance during the maintenance
window. By default, minor engine upgrades are not applied automatically.public Boolean getAutoMinorVersionUpgrade()
Specifies whether to automatically apply minor engine upgrades to the DB instance during the maintenance window. By default, minor engine upgrades are not applied automatically.
public RestoreDBInstanceFromS3Request withAutoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade)
Specifies whether to automatically apply minor engine upgrades to the DB instance during the maintenance window. By default, minor engine upgrades are not applied automatically.
autoMinorVersionUpgrade
- Specifies whether to automatically apply minor engine upgrades to the DB instance during the maintenance
window. By default, minor engine upgrades are not applied automatically.public Boolean isAutoMinorVersionUpgrade()
Specifies whether to automatically apply minor engine upgrades to the DB instance during the maintenance window. By default, minor engine upgrades are not applied automatically.
public void setLicenseModel(String licenseModel)
The license model for this DB instance. Use general-public-license
.
licenseModel
- The license model for this DB instance. Use general-public-license
.public String getLicenseModel()
The license model for this DB instance. Use general-public-license
.
general-public-license
.public RestoreDBInstanceFromS3Request withLicenseModel(String licenseModel)
The license model for this DB instance. Use general-public-license
.
licenseModel
- The license model for this DB instance. Use general-public-license
.public void setIops(Integer iops)
The amount of Provisioned IOPS (input/output operations per second) to allocate initially for the DB instance. For information about valid IOPS values, see Amazon RDS Provisioned IOPS storage in the Amazon RDS User Guide.
iops
- The amount of Provisioned IOPS (input/output operations per second) to allocate initially for the DB
instance. For information about valid IOPS values, see Amazon RDS
Provisioned IOPS storage in the Amazon RDS User Guide.public Integer getIops()
The amount of Provisioned IOPS (input/output operations per second) to allocate initially for the DB instance. For information about valid IOPS values, see Amazon RDS Provisioned IOPS storage in the Amazon RDS User Guide.
public RestoreDBInstanceFromS3Request withIops(Integer iops)
The amount of Provisioned IOPS (input/output operations per second) to allocate initially for the DB instance. For information about valid IOPS values, see Amazon RDS Provisioned IOPS storage in the Amazon RDS User Guide.
iops
- The amount of Provisioned IOPS (input/output operations per second) to allocate initially for the DB
instance. For information about valid IOPS values, see Amazon RDS
Provisioned IOPS storage in the Amazon RDS User Guide.public void setOptionGroupName(String optionGroupName)
The name of the option group to associate with this DB instance. If this argument is omitted, the default option group for the specified engine is used.
optionGroupName
- The name of the option group to associate with this DB instance. If this argument is omitted, the default
option group for the specified engine is used.public String getOptionGroupName()
The name of the option group to associate with this DB instance. If this argument is omitted, the default option group for the specified engine is used.
public RestoreDBInstanceFromS3Request withOptionGroupName(String optionGroupName)
The name of the option group to associate with this DB instance. If this argument is omitted, the default option group for the specified engine is used.
optionGroupName
- The name of the option group to associate with this DB instance. If this argument is omitted, the default
option group for the specified engine is used.public void setPubliclyAccessible(Boolean publiclyAccessible)
Specifies whether the DB instance is publicly accessible.
When the DB instance is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB instance's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB instance's VPC. Access to the DB instance is ultimately controlled by the security group it uses. That public access is not permitted if the security group assigned to the DB instance 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
- Specifies whether the DB instance is publicly accessible.
When the DB instance is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB instance's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB instance's VPC. Access to the DB instance is ultimately controlled by the security group it uses. That public access is not permitted if the security group assigned to the DB instance 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()
Specifies whether the DB instance is publicly accessible.
When the DB instance is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB instance's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB instance's VPC. Access to the DB instance is ultimately controlled by the security group it uses. That public access is not permitted if the security group assigned to the DB instance 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 instance is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB instance's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB instance's VPC. Access to the DB instance is ultimately controlled by the security group it uses. That public access is not permitted if the security group assigned to the DB instance 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 RestoreDBInstanceFromS3Request withPubliclyAccessible(Boolean publiclyAccessible)
Specifies whether the DB instance is publicly accessible.
When the DB instance is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB instance's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB instance's VPC. Access to the DB instance is ultimately controlled by the security group it uses. That public access is not permitted if the security group assigned to the DB instance 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
- Specifies whether the DB instance is publicly accessible.
When the DB instance is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB instance's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB instance's VPC. Access to the DB instance is ultimately controlled by the security group it uses. That public access is not permitted if the security group assigned to the DB instance 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()
Specifies whether the DB instance is publicly accessible.
When the DB instance is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB instance's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB instance's VPC. Access to the DB instance is ultimately controlled by the security group it uses. That public access is not permitted if the security group assigned to the DB instance 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 instance is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB instance's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB instance's VPC. Access to the DB instance is ultimately controlled by the security group it uses. That public access is not permitted if the security group assigned to the DB instance 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 List<Tag> getTags()
A list of tags to associate with this DB instance. For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.
public void setTags(Collection<Tag> tags)
A list of tags to associate with this DB instance. For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.
tags
- A list of tags to associate with this DB instance. For more information, see Tagging Amazon RDS
Resources in the Amazon RDS User Guide.public RestoreDBInstanceFromS3Request withTags(Tag... tags)
A list of tags to associate with this DB instance. For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.
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
- A list of tags to associate with this DB instance. For more information, see Tagging Amazon RDS
Resources in the Amazon RDS User Guide.public RestoreDBInstanceFromS3Request withTags(Collection<Tag> tags)
A list of tags to associate with this DB instance. For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.
tags
- A list of tags to associate with this DB instance. For more information, see Tagging Amazon RDS
Resources in the Amazon RDS User Guide.public void setStorageType(String storageType)
Specifies the storage type to be associated with the DB instance.
Valid Values: gp2 | gp3 | io1 | io2 | standard
If you specify io1
, io2
, 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 | io2 | standard
If you specify io1
, io2
, 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 | io2 | standard
If you specify io1
, io2
, 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 | io2 | standard
If you specify io1
, io2
, or gp3
, you must also include a value for
the Iops
parameter.
Default: io1
if the Iops
parameter is specified; otherwise gp2
public RestoreDBInstanceFromS3Request withStorageType(String storageType)
Specifies the storage type to be associated with the DB instance.
Valid Values: gp2 | gp3 | io1 | io2 | standard
If you specify io1
, io2
, 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 | io2 | standard
If you specify io1
, io2
, or gp3
, you must also include a value for
the Iops
parameter.
Default: io1
if the Iops
parameter is specified; otherwise gp2
public void setStorageEncrypted(Boolean storageEncrypted)
Specifies whether the new DB instance is encrypted or not.
storageEncrypted
- Specifies whether the new DB instance is encrypted or not.public Boolean getStorageEncrypted()
Specifies whether the new DB instance is encrypted or not.
public RestoreDBInstanceFromS3Request withStorageEncrypted(Boolean storageEncrypted)
Specifies whether the new DB instance is encrypted or not.
storageEncrypted
- Specifies whether the new DB instance is encrypted or not.public Boolean isStorageEncrypted()
Specifies whether the new DB instance is encrypted or not.
public void setKmsKeyId(String kmsKeyId)
The Amazon Web Services KMS key identifier for an encrypted DB instance.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.
If the StorageEncrypted
parameter is enabled, and you do not specify a value for the
KmsKeyId
parameter, then Amazon RDS will use your default KMS key. There is a default KMS key for
your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each
Amazon Web Services Region.
kmsKeyId
- The Amazon Web Services KMS key identifier for an encrypted DB instance.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.
If the StorageEncrypted
parameter is enabled, and you do not specify a value for the
KmsKeyId
parameter, then Amazon RDS will use your default KMS key. There is a default KMS key
for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for
each Amazon Web Services Region.
public String getKmsKeyId()
The Amazon Web Services KMS key identifier for an encrypted DB instance.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.
If the StorageEncrypted
parameter is enabled, and you do not specify a value for the
KmsKeyId
parameter, then Amazon RDS will use your default KMS key. There is a default KMS key for
your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each
Amazon Web Services Region.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.
If the StorageEncrypted
parameter is enabled, and you do not specify a value for the
KmsKeyId
parameter, then Amazon RDS will use your default KMS key. There is a default KMS
key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS
key for each Amazon Web Services Region.
public RestoreDBInstanceFromS3Request withKmsKeyId(String kmsKeyId)
The Amazon Web Services KMS key identifier for an encrypted DB instance.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.
If the StorageEncrypted
parameter is enabled, and you do not specify a value for the
KmsKeyId
parameter, then Amazon RDS will use your default KMS key. There is a default KMS key for
your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each
Amazon Web Services Region.
kmsKeyId
- The Amazon Web Services KMS key identifier for an encrypted DB instance.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.
If the StorageEncrypted
parameter is enabled, and you do not specify a value for the
KmsKeyId
parameter, then Amazon RDS will use your default KMS key. There is a default KMS key
for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for
each Amazon Web Services Region.
public void setCopyTagsToSnapshot(Boolean copyTagsToSnapshot)
Specifies whether to copy all tags from the DB instance to snapshots of the DB instance. By default, tags are not copied.
copyTagsToSnapshot
- Specifies whether to copy all tags from the DB instance to snapshots of the DB instance. By default, tags
are not copied.public Boolean getCopyTagsToSnapshot()
Specifies whether to copy all tags from the DB instance to snapshots of the DB instance. By default, tags are not copied.
public RestoreDBInstanceFromS3Request withCopyTagsToSnapshot(Boolean copyTagsToSnapshot)
Specifies whether to copy all tags from the DB instance to snapshots of the DB instance. By default, tags are not copied.
copyTagsToSnapshot
- Specifies whether to copy all tags from the DB instance to snapshots of the DB instance. By default, tags
are not copied.public Boolean isCopyTagsToSnapshot()
Specifies whether to copy all tags from the DB instance to snapshots of the DB instance. By default, tags are not copied.
public void setMonitoringInterval(Integer monitoringInterval)
The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collecting Enhanced Monitoring metrics, specify 0.
If MonitoringRoleArn
is specified, then you must also set MonitoringInterval
to a value
other than 0.
Valid Values: 0, 1, 5, 10, 15, 30, 60
Default: 0
monitoringInterval
- The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB
instance. To disable collecting Enhanced Monitoring metrics, specify 0.
If MonitoringRoleArn
is specified, then you must also set MonitoringInterval
to
a value other than 0.
Valid Values: 0, 1, 5, 10, 15, 30, 60
Default: 0
public Integer getMonitoringInterval()
The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collecting Enhanced Monitoring metrics, specify 0.
If MonitoringRoleArn
is specified, then you must also set MonitoringInterval
to a value
other than 0.
Valid Values: 0, 1, 5, 10, 15, 30, 60
Default: 0
If MonitoringRoleArn
is specified, then you must also set MonitoringInterval
to
a value other than 0.
Valid Values: 0, 1, 5, 10, 15, 30, 60
Default: 0
public RestoreDBInstanceFromS3Request withMonitoringInterval(Integer monitoringInterval)
The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collecting Enhanced Monitoring metrics, specify 0.
If MonitoringRoleArn
is specified, then you must also set MonitoringInterval
to a value
other than 0.
Valid Values: 0, 1, 5, 10, 15, 30, 60
Default: 0
monitoringInterval
- The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB
instance. To disable collecting Enhanced Monitoring metrics, specify 0.
If MonitoringRoleArn
is specified, then you must also set MonitoringInterval
to
a value other than 0.
Valid Values: 0, 1, 5, 10, 15, 30, 60
Default: 0
public void setMonitoringRoleArn(String monitoringRoleArn)
The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs. For
example, arn:aws:iam:123456789012:role/emaccess
. For information on creating a monitoring role, see
Setting Up and Enabling Enhanced Monitoring in the Amazon RDS User Guide.
If MonitoringInterval
is set to a value other than 0, then you must supply a
MonitoringRoleArn
value.
monitoringRoleArn
- The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs.
For example, arn:aws:iam:123456789012:role/emaccess
. For information on creating a monitoring
role, see Setting Up and Enabling Enhanced Monitoring in the Amazon RDS User Guide.
If MonitoringInterval
is set to a value other than 0, then you must supply a
MonitoringRoleArn
value.
public String getMonitoringRoleArn()
The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs. For
example, arn:aws:iam:123456789012:role/emaccess
. For information on creating a monitoring role, see
Setting Up and Enabling Enhanced Monitoring in the Amazon RDS User Guide.
If MonitoringInterval
is set to a value other than 0, then you must supply a
MonitoringRoleArn
value.
arn:aws:iam:123456789012:role/emaccess
. For information on creating a
monitoring role, see Setting Up and Enabling Enhanced Monitoring in the Amazon RDS User Guide.
If MonitoringInterval
is set to a value other than 0, then you must supply a
MonitoringRoleArn
value.
public RestoreDBInstanceFromS3Request withMonitoringRoleArn(String monitoringRoleArn)
The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs. For
example, arn:aws:iam:123456789012:role/emaccess
. For information on creating a monitoring role, see
Setting Up and Enabling Enhanced Monitoring in the Amazon RDS User Guide.
If MonitoringInterval
is set to a value other than 0, then you must supply a
MonitoringRoleArn
value.
monitoringRoleArn
- The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs.
For example, arn:aws:iam:123456789012:role/emaccess
. For information on creating a monitoring
role, see Setting Up and Enabling Enhanced Monitoring in the Amazon RDS User Guide.
If MonitoringInterval
is set to a value other than 0, then you must supply a
MonitoringRoleArn
value.
public void setEnableIAMDatabaseAuthentication(Boolean enableIAMDatabaseAuthentication)
Specifies whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts. By default, mapping isn't enabled.
For more information about IAM database authentication, see IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.
enableIAMDatabaseAuthentication
- Specifies whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts
to database accounts. By default, mapping isn't enabled.
For more information about IAM database authentication, see IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.
public Boolean getEnableIAMDatabaseAuthentication()
Specifies whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts. By default, mapping isn't enabled.
For more information about IAM database authentication, see IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.
For more information about IAM database authentication, see IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.
public RestoreDBInstanceFromS3Request withEnableIAMDatabaseAuthentication(Boolean enableIAMDatabaseAuthentication)
Specifies whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts. By default, mapping isn't enabled.
For more information about IAM database authentication, see IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.
enableIAMDatabaseAuthentication
- Specifies whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts
to database accounts. By default, mapping isn't enabled.
For more information about IAM database authentication, see IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.
public Boolean isEnableIAMDatabaseAuthentication()
Specifies whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts. By default, mapping isn't enabled.
For more information about IAM database authentication, see IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.
For more information about IAM database authentication, see IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.
public void setSourceEngine(String sourceEngine)
The name of the engine of your source database.
Valid Values: mysql
sourceEngine
- The name of the engine of your source database.
Valid Values: mysql
public String getSourceEngine()
The name of the engine of your source database.
Valid Values: mysql
Valid Values: mysql
public RestoreDBInstanceFromS3Request withSourceEngine(String sourceEngine)
The name of the engine of your source database.
Valid Values: mysql
sourceEngine
- The name of the engine of your source database.
Valid Values: mysql
public void setSourceEngineVersion(String sourceEngineVersion)
The version of the database that the backup files were created from.
MySQL versions 5.6 and 5.7 are supported.
Example: 5.6.40
sourceEngineVersion
- The version of the database that the backup files were created from.
MySQL versions 5.6 and 5.7 are supported.
Example: 5.6.40
public String getSourceEngineVersion()
The version of the database that the backup files were created from.
MySQL versions 5.6 and 5.7 are supported.
Example: 5.6.40
MySQL versions 5.6 and 5.7 are supported.
Example: 5.6.40
public RestoreDBInstanceFromS3Request withSourceEngineVersion(String sourceEngineVersion)
The version of the database that the backup files were created from.
MySQL versions 5.6 and 5.7 are supported.
Example: 5.6.40
sourceEngineVersion
- The version of the database that the backup files were created from.
MySQL versions 5.6 and 5.7 are supported.
Example: 5.6.40
public void setS3BucketName(String s3BucketName)
The name of your Amazon S3 bucket that contains your database backup file.
s3BucketName
- The name of your Amazon S3 bucket that contains your database backup file.public String getS3BucketName()
The name of your Amazon S3 bucket that contains your database backup file.
public RestoreDBInstanceFromS3Request withS3BucketName(String s3BucketName)
The name of your Amazon S3 bucket that contains your database backup file.
s3BucketName
- The name of your Amazon S3 bucket that contains your database backup file.public void setS3Prefix(String s3Prefix)
The prefix of your Amazon S3 bucket.
s3Prefix
- The prefix of your Amazon S3 bucket.public String getS3Prefix()
The prefix of your Amazon S3 bucket.
public RestoreDBInstanceFromS3Request withS3Prefix(String s3Prefix)
The prefix of your Amazon S3 bucket.
s3Prefix
- The prefix of your Amazon S3 bucket.public void setS3IngestionRoleArn(String s3IngestionRoleArn)
An Amazon Web Services Identity and Access Management (IAM) role with a trust policy and a permissions policy that allows Amazon RDS to access your Amazon S3 bucket. For information about this role, see Creating an IAM role manually in the Amazon RDS User Guide.
s3IngestionRoleArn
- An Amazon Web Services Identity and Access Management (IAM) role with a trust policy and a permissions
policy that allows Amazon RDS to access your Amazon S3 bucket. For information about this role, see Creating an IAM role manually in the Amazon RDS User Guide.public String getS3IngestionRoleArn()
An Amazon Web Services Identity and Access Management (IAM) role with a trust policy and a permissions policy that allows Amazon RDS to access your Amazon S3 bucket. For information about this role, see Creating an IAM role manually in the Amazon RDS User Guide.
public RestoreDBInstanceFromS3Request withS3IngestionRoleArn(String s3IngestionRoleArn)
An Amazon Web Services Identity and Access Management (IAM) role with a trust policy and a permissions policy that allows Amazon RDS to access your Amazon S3 bucket. For information about this role, see Creating an IAM role manually in the Amazon RDS User Guide.
s3IngestionRoleArn
- An Amazon Web Services Identity and Access Management (IAM) role with a trust policy and a permissions
policy that allows Amazon RDS to access your Amazon S3 bucket. For information about this role, see Creating an IAM role manually in the Amazon RDS User Guide.public void setEnablePerformanceInsights(Boolean enablePerformanceInsights)
Specifies whether to enable Performance Insights for the DB instance.
For more information, see Using Amazon Performance Insights in the Amazon RDS User Guide.
enablePerformanceInsights
- Specifies whether to enable Performance Insights for the DB instance.
For more information, see Using Amazon Performance Insights in the Amazon RDS User Guide.
public Boolean getEnablePerformanceInsights()
Specifies whether to enable Performance Insights for the DB instance.
For more information, see Using Amazon Performance Insights in the Amazon RDS User Guide.
For more information, see Using Amazon Performance Insights in the Amazon RDS User Guide.
public RestoreDBInstanceFromS3Request withEnablePerformanceInsights(Boolean enablePerformanceInsights)
Specifies whether to enable Performance Insights for the DB instance.
For more information, see Using Amazon Performance Insights in the Amazon RDS User Guide.
enablePerformanceInsights
- Specifies whether to enable Performance Insights for the DB instance.
For more information, see Using Amazon Performance Insights in the Amazon RDS User Guide.
public Boolean isEnablePerformanceInsights()
Specifies whether to enable Performance Insights for the DB instance.
For more information, see Using Amazon Performance Insights in the Amazon RDS User Guide.
For more information, see Using Amazon Performance Insights in the Amazon RDS User Guide.
public void setPerformanceInsightsKMSKeyId(String performanceInsightsKMSKeyId)
The Amazon Web Services KMS key identifier for encryption of Performance Insights data.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
If you do not specify a value for PerformanceInsightsKMSKeyId
, then Amazon RDS uses your default KMS
key. There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a
different default KMS key for each Amazon Web Services Region.
performanceInsightsKMSKeyId
- The Amazon Web Services KMS key identifier for encryption of Performance Insights data.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
If you do not specify a value for PerformanceInsightsKMSKeyId
, then Amazon RDS uses your
default KMS key. There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services
account has a different default KMS key for each Amazon Web Services Region.
public String getPerformanceInsightsKMSKeyId()
The Amazon Web Services KMS key identifier for encryption of Performance Insights data.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
If you do not specify a value for PerformanceInsightsKMSKeyId
, then Amazon RDS uses your default KMS
key. There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a
different default KMS key for each Amazon Web Services Region.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
If you do not specify a value for PerformanceInsightsKMSKeyId
, then Amazon RDS uses your
default KMS key. There is a default KMS key for your Amazon Web Services account. Your Amazon Web
Services account has a different default KMS key for each Amazon Web Services Region.
public RestoreDBInstanceFromS3Request withPerformanceInsightsKMSKeyId(String performanceInsightsKMSKeyId)
The Amazon Web Services KMS key identifier for encryption of Performance Insights data.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
If you do not specify a value for PerformanceInsightsKMSKeyId
, then Amazon RDS uses your default KMS
key. There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a
different default KMS key for each Amazon Web Services Region.
performanceInsightsKMSKeyId
- The Amazon Web Services KMS key identifier for encryption of Performance Insights data.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
If you do not specify a value for PerformanceInsightsKMSKeyId
, then Amazon RDS uses your
default KMS key. There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services
account has a different default KMS key for each Amazon Web Services Region.
public void setPerformanceInsightsRetentionPeriod(Integer performanceInsightsRetentionPeriod)
The number of days to retain Performance Insights data. The default is 7 days. The following values are valid:
7
month * 31, where month is a number of months from 1-23
731
For example, the following values are valid:
93 (3 months * 31)
341 (11 months * 31)
589 (19 months * 31)
731
If you specify a retention period such as 94, which isn't a valid value, RDS issues an error.
performanceInsightsRetentionPeriod
- The number of days to retain Performance Insights data. The default is 7 days. The following values are
valid:
7
month * 31, where month is a number of months from 1-23
731
For example, the following values are valid:
93 (3 months * 31)
341 (11 months * 31)
589 (19 months * 31)
731
If you specify a retention period such as 94, which isn't a valid value, RDS issues an error.
public Integer getPerformanceInsightsRetentionPeriod()
The number of days to retain Performance Insights data. The default is 7 days. The following values are valid:
7
month * 31, where month is a number of months from 1-23
731
For example, the following values are valid:
93 (3 months * 31)
341 (11 months * 31)
589 (19 months * 31)
731
If you specify a retention period such as 94, which isn't a valid value, RDS issues an error.
7
month * 31, where month is a number of months from 1-23
731
For example, the following values are valid:
93 (3 months * 31)
341 (11 months * 31)
589 (19 months * 31)
731
If you specify a retention period such as 94, which isn't a valid value, RDS issues an error.
public RestoreDBInstanceFromS3Request withPerformanceInsightsRetentionPeriod(Integer performanceInsightsRetentionPeriod)
The number of days to retain Performance Insights data. The default is 7 days. The following values are valid:
7
month * 31, where month is a number of months from 1-23
731
For example, the following values are valid:
93 (3 months * 31)
341 (11 months * 31)
589 (19 months * 31)
731
If you specify a retention period such as 94, which isn't a valid value, RDS issues an error.
performanceInsightsRetentionPeriod
- The number of days to retain Performance Insights data. The default is 7 days. The following values are
valid:
7
month * 31, where month is a number of months from 1-23
731
For example, the following values are valid:
93 (3 months * 31)
341 (11 months * 31)
589 (19 months * 31)
731
If you specify a retention period such as 94, which isn't a valid value, RDS issues an error.
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.
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.
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.public RestoreDBInstanceFromS3Request 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.
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.public RestoreDBInstanceFromS3Request 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.
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.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.
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.
processorFeatures
- The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.public RestoreDBInstanceFromS3Request withProcessorFeatures(ProcessorFeature... processorFeatures)
The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
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.public RestoreDBInstanceFromS3Request 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.
processorFeatures
- The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.public void setUseDefaultProcessorFeatures(Boolean useDefaultProcessorFeatures)
Specifies whether the DB instance class of the DB instance uses its default processor features.
useDefaultProcessorFeatures
- Specifies whether the DB instance class of the DB instance uses its default processor features.public Boolean getUseDefaultProcessorFeatures()
Specifies whether the DB instance class of the DB instance uses its default processor features.
public RestoreDBInstanceFromS3Request withUseDefaultProcessorFeatures(Boolean useDefaultProcessorFeatures)
Specifies whether the DB instance class of the DB instance uses its default processor features.
useDefaultProcessorFeatures
- Specifies whether the DB instance class of the DB instance uses its default processor features.public Boolean isUseDefaultProcessorFeatures()
Specifies whether the DB instance class of the DB instance uses its default processor features.
public void setDeletionProtection(Boolean deletionProtection)
Specifies whether to enable deletion protection for the DB instance. 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
- Specifies whether to enable deletion protection for the DB instance. 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()
Specifies whether to enable deletion protection for the DB instance. 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 RestoreDBInstanceFromS3Request withDeletionProtection(Boolean deletionProtection)
Specifies whether to enable deletion protection for the DB instance. 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
- Specifies whether to enable deletion protection for the DB instance. 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()
Specifies whether to enable deletion protection for the DB instance. 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 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.
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.
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.
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.
public RestoreDBInstanceFromS3Request 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.
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.
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 RestoreDBInstanceFromS3Request 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 RestoreDBInstanceFromS3Request 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 setManageMasterUserPassword(Boolean manageMasterUserPassword)
Specifies whether to manage the master user password with Amazon Web Services Secrets Manager.
For more information, see Password management with Amazon Web Services Secrets Manager in the Amazon RDS User Guide.
Constraints:
Can't manage the master user password with Amazon Web Services Secrets Manager if MasterUserPassword
is specified.
manageMasterUserPassword
- Specifies whether to manage the master user password with Amazon Web Services Secrets Manager.
For more information, see Password management with Amazon Web Services Secrets Manager in the Amazon RDS User Guide.
Constraints:
Can't manage the master user password with Amazon Web Services Secrets Manager if
MasterUserPassword
is specified.
public Boolean getManageMasterUserPassword()
Specifies whether to manage the master user password with Amazon Web Services Secrets Manager.
For more information, see Password management with Amazon Web Services Secrets Manager in the Amazon RDS User Guide.
Constraints:
Can't manage the master user password with Amazon Web Services Secrets Manager if MasterUserPassword
is specified.
For more information, see Password management with Amazon Web Services Secrets Manager in the Amazon RDS User Guide.
Constraints:
Can't manage the master user password with Amazon Web Services Secrets Manager if
MasterUserPassword
is specified.
public RestoreDBInstanceFromS3Request withManageMasterUserPassword(Boolean manageMasterUserPassword)
Specifies whether to manage the master user password with Amazon Web Services Secrets Manager.
For more information, see Password management with Amazon Web Services Secrets Manager in the Amazon RDS User Guide.
Constraints:
Can't manage the master user password with Amazon Web Services Secrets Manager if MasterUserPassword
is specified.
manageMasterUserPassword
- Specifies whether to manage the master user password with Amazon Web Services Secrets Manager.
For more information, see Password management with Amazon Web Services Secrets Manager in the Amazon RDS User Guide.
Constraints:
Can't manage the master user password with Amazon Web Services Secrets Manager if
MasterUserPassword
is specified.
public Boolean isManageMasterUserPassword()
Specifies whether to manage the master user password with Amazon Web Services Secrets Manager.
For more information, see Password management with Amazon Web Services Secrets Manager in the Amazon RDS User Guide.
Constraints:
Can't manage the master user password with Amazon Web Services Secrets Manager if MasterUserPassword
is specified.
For more information, see Password management with Amazon Web Services Secrets Manager in the Amazon RDS User Guide.
Constraints:
Can't manage the master user password with Amazon Web Services Secrets Manager if
MasterUserPassword
is specified.
public void setMasterUserSecretKmsKeyId(String masterUserSecretKmsKeyId)
The Amazon Web Services KMS key identifier to encrypt a secret that is automatically generated and managed in Amazon Web Services Secrets Manager.
This setting is valid only if the master user password is managed by RDS in Amazon Web Services Secrets Manager for the DB instance.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.
If you don't specify MasterUserSecretKmsKeyId
, then the aws/secretsmanager
KMS key is
used to encrypt the secret. If the secret is in a different Amazon Web Services account, then you can't use the
aws/secretsmanager
KMS key to encrypt the secret, and you must use a customer managed KMS key.
There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.
masterUserSecretKmsKeyId
- The Amazon Web Services KMS key identifier to encrypt a secret that is automatically generated and managed
in Amazon Web Services Secrets Manager.
This setting is valid only if the master user password is managed by RDS in Amazon Web Services Secrets Manager for the DB instance.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.
If you don't specify MasterUserSecretKmsKeyId
, then the aws/secretsmanager
KMS
key is used to encrypt the secret. If the secret is in a different Amazon Web Services account, then you
can't use the aws/secretsmanager
KMS key to encrypt the secret, and you must use a customer
managed KMS key.
There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.
public String getMasterUserSecretKmsKeyId()
The Amazon Web Services KMS key identifier to encrypt a secret that is automatically generated and managed in Amazon Web Services Secrets Manager.
This setting is valid only if the master user password is managed by RDS in Amazon Web Services Secrets Manager for the DB instance.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.
If you don't specify MasterUserSecretKmsKeyId
, then the aws/secretsmanager
KMS key is
used to encrypt the secret. If the secret is in a different Amazon Web Services account, then you can't use the
aws/secretsmanager
KMS key to encrypt the secret, and you must use a customer managed KMS key.
There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.
This setting is valid only if the master user password is managed by RDS in Amazon Web Services Secrets Manager for the DB instance.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.
If you don't specify MasterUserSecretKmsKeyId
, then the aws/secretsmanager
KMS
key is used to encrypt the secret. If the secret is in a different Amazon Web Services account, then you
can't use the aws/secretsmanager
KMS key to encrypt the secret, and you must use a customer
managed KMS key.
There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.
public RestoreDBInstanceFromS3Request withMasterUserSecretKmsKeyId(String masterUserSecretKmsKeyId)
The Amazon Web Services KMS key identifier to encrypt a secret that is automatically generated and managed in Amazon Web Services Secrets Manager.
This setting is valid only if the master user password is managed by RDS in Amazon Web Services Secrets Manager for the DB instance.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.
If you don't specify MasterUserSecretKmsKeyId
, then the aws/secretsmanager
KMS key is
used to encrypt the secret. If the secret is in a different Amazon Web Services account, then you can't use the
aws/secretsmanager
KMS key to encrypt the secret, and you must use a customer managed KMS key.
There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.
masterUserSecretKmsKeyId
- The Amazon Web Services KMS key identifier to encrypt a secret that is automatically generated and managed
in Amazon Web Services Secrets Manager.
This setting is valid only if the master user password is managed by RDS in Amazon Web Services Secrets Manager for the DB instance.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.
If you don't specify MasterUserSecretKmsKeyId
, then the aws/secretsmanager
KMS
key is used to encrypt the secret. If the secret is in a different Amazon Web Services account, then you
can't use the aws/secretsmanager
KMS key to encrypt the secret, and you must use a customer
managed KMS key.
There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.
public void setDedicatedLogVolume(Boolean dedicatedLogVolume)
Specifies whether to enable a dedicated log volume (DLV) for the DB instance.
dedicatedLogVolume
- Specifies whether to enable a dedicated log volume (DLV) for the DB instance.public Boolean getDedicatedLogVolume()
Specifies whether to enable a dedicated log volume (DLV) for the DB instance.
public RestoreDBInstanceFromS3Request withDedicatedLogVolume(Boolean dedicatedLogVolume)
Specifies whether to enable a dedicated log volume (DLV) for the DB instance.
dedicatedLogVolume
- Specifies whether to enable a dedicated log volume (DLV) for the DB instance.public Boolean isDedicatedLogVolume()
Specifies whether to enable a dedicated log volume (DLV) for the DB instance.
public void setCACertificateIdentifier(String cACertificateIdentifier)
The CA certificate identifier to use for the DB instance's server certificate.
This setting doesn't apply to RDS Custom DB instances.
For more information, see Using SSL/TLS to encrypt a connection to a DB instance in the Amazon RDS User Guide and Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora User Guide.
cACertificateIdentifier
- The CA certificate identifier to use for the DB instance's server certificate.
This setting doesn't apply to RDS Custom DB instances.
For more information, see Using SSL/TLS to encrypt a connection to a DB instance in the Amazon RDS User Guide and Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora User Guide.
public String getCACertificateIdentifier()
The CA certificate identifier to use for the DB instance's server certificate.
This setting doesn't apply to RDS Custom DB instances.
For more information, see Using SSL/TLS to encrypt a connection to a DB instance in the Amazon RDS User Guide and Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora User Guide.
This setting doesn't apply to RDS Custom DB instances.
For more information, see Using SSL/TLS to encrypt a connection to a DB instance in the Amazon RDS User Guide and Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora User Guide.
public RestoreDBInstanceFromS3Request withCACertificateIdentifier(String cACertificateIdentifier)
The CA certificate identifier to use for the DB instance's server certificate.
This setting doesn't apply to RDS Custom DB instances.
For more information, see Using SSL/TLS to encrypt a connection to a DB instance in the Amazon RDS User Guide and Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora User Guide.
cACertificateIdentifier
- The CA certificate identifier to use for the DB instance's server certificate.
This setting doesn't apply to RDS Custom DB instances.
For more information, see Using SSL/TLS to encrypt a connection to a DB instance in the Amazon RDS User Guide and Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora User Guide.
public void setEngineLifecycleSupport(String engineLifecycleSupport)
The life cycle type for this DB instance.
By default, this value is set to open-source-rds-extended-support
, which enrolls your DB instance
into Amazon RDS Extended Support. At the end of standard support, you can avoid charges for Extended Support by
setting the value to open-source-rds-extended-support-disabled
. In this case, RDS automatically
upgrades your restored DB instance to a higher engine version, if the major engine version is past its end of
standard support date.
You can use this setting to enroll your DB instance into Amazon RDS Extended Support. With RDS Extended Support, you can run the selected major engine version on your DB instance past the end of standard support for that engine version. For more information, see Using Amazon RDS Extended Support in the Amazon RDS User Guide.
This setting applies only to RDS for MySQL and RDS for PostgreSQL. For Amazon Aurora DB instances, the life cycle type is managed by the DB cluster.
Valid Values: open-source-rds-extended-support | open-source-rds-extended-support-disabled
Default: open-source-rds-extended-support
engineLifecycleSupport
- The life cycle type for this DB instance.
By default, this value is set to open-source-rds-extended-support
, which enrolls your DB
instance into Amazon RDS Extended Support. At the end of standard support, you can avoid charges for
Extended Support by setting the value to open-source-rds-extended-support-disabled
. In this
case, RDS automatically upgrades your restored DB instance to a higher engine version, if the major engine
version is past its end of standard support date.
You can use this setting to enroll your DB instance into Amazon RDS Extended Support. With RDS Extended Support, you can run the selected major engine version on your DB instance past the end of standard support for that engine version. For more information, see Using Amazon RDS Extended Support in the Amazon RDS User Guide.
This setting applies only to RDS for MySQL and RDS for PostgreSQL. For Amazon Aurora DB instances, the life cycle type is managed by the DB cluster.
Valid Values: open-source-rds-extended-support | open-source-rds-extended-support-disabled
Default: open-source-rds-extended-support
public String getEngineLifecycleSupport()
The life cycle type for this DB instance.
By default, this value is set to open-source-rds-extended-support
, which enrolls your DB instance
into Amazon RDS Extended Support. At the end of standard support, you can avoid charges for Extended Support by
setting the value to open-source-rds-extended-support-disabled
. In this case, RDS automatically
upgrades your restored DB instance to a higher engine version, if the major engine version is past its end of
standard support date.
You can use this setting to enroll your DB instance into Amazon RDS Extended Support. With RDS Extended Support, you can run the selected major engine version on your DB instance past the end of standard support for that engine version. For more information, see Using Amazon RDS Extended Support in the Amazon RDS User Guide.
This setting applies only to RDS for MySQL and RDS for PostgreSQL. For Amazon Aurora DB instances, the life cycle type is managed by the DB cluster.
Valid Values: open-source-rds-extended-support | open-source-rds-extended-support-disabled
Default: open-source-rds-extended-support
By default, this value is set to open-source-rds-extended-support
, which enrolls your DB
instance into Amazon RDS Extended Support. At the end of standard support, you can avoid charges for
Extended Support by setting the value to open-source-rds-extended-support-disabled
. In this
case, RDS automatically upgrades your restored DB instance to a higher engine version, if the major
engine version is past its end of standard support date.
You can use this setting to enroll your DB instance into Amazon RDS Extended Support. With RDS Extended Support, you can run the selected major engine version on your DB instance past the end of standard support for that engine version. For more information, see Using Amazon RDS Extended Support in the Amazon RDS User Guide.
This setting applies only to RDS for MySQL and RDS for PostgreSQL. For Amazon Aurora DB instances, the life cycle type is managed by the DB cluster.
Valid Values: open-source-rds-extended-support | open-source-rds-extended-support-disabled
Default: open-source-rds-extended-support
public RestoreDBInstanceFromS3Request withEngineLifecycleSupport(String engineLifecycleSupport)
The life cycle type for this DB instance.
By default, this value is set to open-source-rds-extended-support
, which enrolls your DB instance
into Amazon RDS Extended Support. At the end of standard support, you can avoid charges for Extended Support by
setting the value to open-source-rds-extended-support-disabled
. In this case, RDS automatically
upgrades your restored DB instance to a higher engine version, if the major engine version is past its end of
standard support date.
You can use this setting to enroll your DB instance into Amazon RDS Extended Support. With RDS Extended Support, you can run the selected major engine version on your DB instance past the end of standard support for that engine version. For more information, see Using Amazon RDS Extended Support in the Amazon RDS User Guide.
This setting applies only to RDS for MySQL and RDS for PostgreSQL. For Amazon Aurora DB instances, the life cycle type is managed by the DB cluster.
Valid Values: open-source-rds-extended-support | open-source-rds-extended-support-disabled
Default: open-source-rds-extended-support
engineLifecycleSupport
- The life cycle type for this DB instance.
By default, this value is set to open-source-rds-extended-support
, which enrolls your DB
instance into Amazon RDS Extended Support. At the end of standard support, you can avoid charges for
Extended Support by setting the value to open-source-rds-extended-support-disabled
. In this
case, RDS automatically upgrades your restored DB instance to a higher engine version, if the major engine
version is past its end of standard support date.
You can use this setting to enroll your DB instance into Amazon RDS Extended Support. With RDS Extended Support, you can run the selected major engine version on your DB instance past the end of standard support for that engine version. For more information, see Using Amazon RDS Extended Support in the Amazon RDS User Guide.
This setting applies only to RDS for MySQL and RDS for PostgreSQL. For Amazon Aurora DB instances, the life cycle type is managed by the DB cluster.
Valid Values: open-source-rds-extended-support | open-source-rds-extended-support-disabled
Default: open-source-rds-extended-support
public String toString()
toString
in class Object
Object.toString()
public RestoreDBInstanceFromS3Request clone()
AmazonWebServiceRequest
clone
in class AmazonWebServiceRequest
Object.clone()