@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 gigabytes) to allocate initially for the DB instance.
|
Boolean |
getAutoMinorVersionUpgrade()
True to indicate that minor engine upgrades are applied automatically to the DB instance during the maintenance
window, and otherwise false.
|
String |
getAvailabilityZone()
The Availability Zone that the DB instance is created in.
|
Integer |
getBackupRetentionPeriod()
The number of days for which automated backups are retained.
|
Boolean |
getCopyTagsToSnapshot()
True to copy all tags from the DB instance to snapshots of the DB instance, and otherwise false.
|
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.
|
List<String> |
getEnableCloudwatchLogsExports()
The list of logs that the restored DB instance is to export to CloudWatch Logs.
|
Boolean |
getEnableIAMDatabaseAuthentication()
True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and otherwise
false.
|
Boolean |
getEnablePerformanceInsights()
True to enable Performance Insights for the DB instance, and otherwise false.
|
String |
getEngine()
The name of the database engine to be used for this 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 AWS KMS key identifier for an encrypted DB instance.
|
String |
getLicenseModel()
The license model for this DB instance.
|
String |
getMasterUsername()
The name for the master user.
|
String |
getMasterUserPassword()
The password for the master user.
|
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 |
getOptionGroupName()
The name of the option group to associate with this DB instance.
|
String |
getPerformanceInsightsKMSKeyId()
The AWS KMS key identifier for encryption of 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).
|
Boolean |
getPubliclyAccessible()
Specifies whether the DB instance is publicly accessible or not.
|
String |
getS3BucketName()
The name of your Amazon S3 bucket that contains your database backup file.
|
String |
getS3IngestionRoleArn()
An AWS Identity and Access Management (IAM) role to allow 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 engine version of your source database.
|
Boolean |
getStorageEncrypted()
Specifies whether the new DB instance is encrypted or not.
|
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.
|
List<String> |
getVpcSecurityGroupIds()
A list of VPC security groups to associate with this DB instance.
|
int |
hashCode() |
Boolean |
isAutoMinorVersionUpgrade()
True to indicate that minor engine upgrades are applied automatically to the DB instance during the maintenance
window, and otherwise false.
|
Boolean |
isCopyTagsToSnapshot()
True to copy all tags from the DB instance to snapshots of the DB instance, and otherwise false.
|
Boolean |
isEnableIAMDatabaseAuthentication()
True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and otherwise
false.
|
Boolean |
isEnablePerformanceInsights()
True to enable Performance Insights for the DB instance, and otherwise false.
|
Boolean |
isMultiAZ()
Specifies whether the DB instance is a Multi-AZ deployment.
|
Boolean |
isPubliclyAccessible()
Specifies whether the DB instance is publicly accessible or not.
|
Boolean |
isStorageEncrypted()
Specifies whether the new DB instance is encrypted or not.
|
void |
setAllocatedStorage(Integer allocatedStorage)
The amount of storage (in gigabytes) to allocate initially for the DB instance.
|
void |
setAutoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade)
True to indicate that minor engine upgrades are applied automatically to the DB instance during the maintenance
window, and otherwise false.
|
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 |
setCopyTagsToSnapshot(Boolean copyTagsToSnapshot)
True to copy all tags from the DB instance to snapshots of the DB instance, and otherwise false.
|
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 |
setEnableCloudwatchLogsExports(Collection<String> enableCloudwatchLogsExports)
The list of logs that the restored DB instance is to export to CloudWatch Logs.
|
void |
setEnableIAMDatabaseAuthentication(Boolean enableIAMDatabaseAuthentication)
True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and otherwise
false.
|
void |
setEnablePerformanceInsights(Boolean enablePerformanceInsights)
True to enable Performance Insights for the DB instance, and otherwise false.
|
void |
setEngine(String engine)
The name of the database engine to be used for this 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 AWS KMS key identifier for an encrypted DB instance.
|
void |
setLicenseModel(String licenseModel)
The license model for this DB instance.
|
void |
setMasterUsername(String masterUsername)
The name for the master user.
|
void |
setMasterUserPassword(String masterUserPassword)
The password for the master user.
|
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 |
setOptionGroupName(String optionGroupName)
The name of the option group to associate with this DB instance.
|
void |
setPerformanceInsightsKMSKeyId(String performanceInsightsKMSKeyId)
The AWS KMS key identifier for encryption of 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 |
setPubliclyAccessible(Boolean publiclyAccessible)
Specifies whether the DB instance is publicly accessible or not.
|
void |
setS3BucketName(String s3BucketName)
The name of your Amazon S3 bucket that contains your database backup file.
|
void |
setS3IngestionRoleArn(String s3IngestionRoleArn)
An AWS Identity and Access Management (IAM) role to allow 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 engine version of your source database.
|
void |
setStorageEncrypted(Boolean storageEncrypted)
Specifies whether the new DB instance is encrypted or not.
|
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 |
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; useful for testing and debugging.
|
RestoreDBInstanceFromS3Request |
withAllocatedStorage(Integer allocatedStorage)
The amount of storage (in gigabytes) to allocate initially for the DB instance.
|
RestoreDBInstanceFromS3Request |
withAutoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade)
True to indicate that minor engine upgrades are applied automatically to the DB instance during the maintenance
window, and otherwise false.
|
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 |
withCopyTagsToSnapshot(Boolean copyTagsToSnapshot)
True to copy all tags from the DB instance to snapshots of the DB instance, and otherwise false.
|
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 |
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)
True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and otherwise
false.
|
RestoreDBInstanceFromS3Request |
withEnablePerformanceInsights(Boolean enablePerformanceInsights)
True to enable Performance Insights for the DB instance, and otherwise false.
|
RestoreDBInstanceFromS3Request |
withEngine(String engine)
The name of the database engine to be used for this 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 AWS KMS key identifier for an encrypted DB instance.
|
RestoreDBInstanceFromS3Request |
withLicenseModel(String licenseModel)
The license model for this DB instance.
|
RestoreDBInstanceFromS3Request |
withMasterUsername(String masterUsername)
The name for the master user.
|
RestoreDBInstanceFromS3Request |
withMasterUserPassword(String masterUserPassword)
The password for the master user.
|
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 |
withOptionGroupName(String optionGroupName)
The name of the option group to associate with this DB instance.
|
RestoreDBInstanceFromS3Request |
withPerformanceInsightsKMSKeyId(String performanceInsightsKMSKeyId)
The AWS KMS key identifier for encryption of 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 |
withPubliclyAccessible(Boolean publiclyAccessible)
Specifies whether the DB instance is publicly accessible or not.
|
RestoreDBInstanceFromS3Request |
withS3BucketName(String s3BucketName)
The name of your Amazon S3 bucket that contains your database backup file.
|
RestoreDBInstanceFromS3Request |
withS3IngestionRoleArn(String s3IngestionRoleArn)
An AWS Identity and Access Management (IAM) role to allow 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 engine version of your source database.
|
RestoreDBInstanceFromS3Request |
withStorageEncrypted(Boolean storageEncrypted)
Specifies whether the new DB instance is encrypted or not.
|
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 |
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.
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.
Cannot 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.
Cannot 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.
Cannot 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.
Cannot 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.
Cannot 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.
Cannot end with a hyphen or contain two consecutive hyphens.
Example: mydbinstance
public void setAllocatedStorage(Integer allocatedStorage)
The amount of storage (in gigabytes) to allocate initially for the DB instance. Follow the allocation rules specified in CreateDBInstance.
Be sure to allocate enough memory for your new DB instance so that the restore operation can succeed. You can also allocate additional memory for future growth.
allocatedStorage
- The amount of storage (in gigabytes) to allocate initially for the DB instance. Follow the allocation
rules specified in CreateDBInstance. Be sure to allocate enough memory for your new DB instance so that the restore operation can succeed. You can also allocate additional memory for future growth.
public Integer getAllocatedStorage()
The amount of storage (in gigabytes) to allocate initially for the DB instance. Follow the allocation rules specified in CreateDBInstance.
Be sure to allocate enough memory for your new DB instance so that the restore operation can succeed. You can also allocate additional memory for future growth.
Be sure to allocate enough memory for your new DB instance so that the restore operation can succeed. You can also allocate additional memory for future growth.
public RestoreDBInstanceFromS3Request withAllocatedStorage(Integer allocatedStorage)
The amount of storage (in gigabytes) to allocate initially for the DB instance. Follow the allocation rules specified in CreateDBInstance.
Be sure to allocate enough memory for your new DB instance so that the restore operation can succeed. You can also allocate additional memory for future growth.
allocatedStorage
- The amount of storage (in gigabytes) to allocate initially for the DB instance. Follow the allocation
rules specified in CreateDBInstance. Be sure to allocate enough memory for your new DB instance so that the restore operation can succeed. You can also allocate additional memory 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 AWS 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 is not 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 AWS 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 is not 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 AWS 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 is not supported on the db.t2.micro DB instance class.
db.m4.large
. Not all DB
instance classes are available in all AWS 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 is not 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 AWS 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 is not 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 AWS 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 is not 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.
Cannot 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.
Cannot 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.
Cannot be a reserved word for the chosen database engine.
Constraints:
Must be 1 to 16 letters or numbers.
First character must be a letter.
Cannot 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.
Cannot 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.
Cannot be a reserved word for the chosen database engine.
public void setMasterUserPassword(String masterUserPassword)
The password for the master user. The password can include any printable ASCII character except "/", """, or "@".
Constraints: Must contain from 8 to 41 characters.
masterUserPassword
- The password for the master user. The password can include any printable ASCII character except "/",
""", or "@".
Constraints: Must contain from 8 to 41 characters.
public String getMasterUserPassword()
The password for the master user. The password can include any printable ASCII character except "/", """, or "@".
Constraints: Must contain from 8 to 41 characters.
Constraints: Must contain from 8 to 41 characters.
public RestoreDBInstanceFromS3Request withMasterUserPassword(String masterUserPassword)
The password for the master user. The password can include any printable ASCII character except "/", """, or "@".
Constraints: Must contain from 8 to 41 characters.
masterUserPassword
- The password for the master user. The password can include any printable ASCII character except "/",
""", or "@".
Constraints: Must contain from 8 to 41 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 AWS Regions and Availability Zones, see Regions and Availability Zones.
Default: A random, system-chosen Availability Zone in the endpoint's AWS Region.
Example: us-east-1d
Constraint: The AvailabilityZone parameter can't be specified if the MultiAZ parameter is set to
true
. The specified Availability Zone must be in the same AWS Region as the current endpoint.
availabilityZone
- The Availability Zone that the DB instance is created in. For information about AWS Regions and
Availability Zones, see Regions and Availability Zones.
Default: A random, system-chosen Availability Zone in the endpoint's AWS Region.
Example: us-east-1d
Constraint: The AvailabilityZone parameter can't be specified if the MultiAZ parameter is set to
true
. The specified Availability Zone must be in the same AWS Region as the current endpoint.
public String getAvailabilityZone()
The Availability Zone that the DB instance is created in. For information about AWS Regions and Availability Zones, see Regions and Availability Zones.
Default: A random, system-chosen Availability Zone in the endpoint's AWS Region.
Example: us-east-1d
Constraint: The AvailabilityZone parameter can't be specified if the MultiAZ parameter is set to
true
. The specified Availability Zone must be in the same AWS Region as the current endpoint.
Default: A random, system-chosen Availability Zone in the endpoint's AWS Region.
Example: us-east-1d
Constraint: The AvailabilityZone parameter can't be specified if the MultiAZ parameter is set to
true
. The specified Availability Zone must be in the same AWS Region as the current
endpoint.
public RestoreDBInstanceFromS3Request withAvailabilityZone(String availabilityZone)
The Availability Zone that the DB instance is created in. For information about AWS Regions and Availability Zones, see Regions and Availability Zones.
Default: A random, system-chosen Availability Zone in the endpoint's AWS Region.
Example: us-east-1d
Constraint: The AvailabilityZone parameter can't be specified if the MultiAZ parameter is set to
true
. The specified Availability Zone must be in the same AWS Region as the current endpoint.
availabilityZone
- The Availability Zone that the DB instance is created in. For information about AWS Regions and
Availability Zones, see Regions and Availability Zones.
Default: A random, system-chosen Availability Zone in the endpoint's AWS Region.
Example: us-east-1d
Constraint: The AvailabilityZone parameter can't be specified if the MultiAZ parameter is set to
true
. The specified Availability Zone must be in the same AWS Region as the current endpoint.
public void setDBSubnetGroupName(String dBSubnetGroupName)
A DB subnet group to associate with this DB instance.
dBSubnetGroupName
- A DB subnet group to associate with this DB instance.public String getDBSubnetGroupName()
A DB subnet group to associate with this DB instance.
public RestoreDBInstanceFromS3Request withDBSubnetGroupName(String dBSubnetGroupName)
A DB subnet group to associate with this DB instance.
dBSubnetGroupName
- A DB subnet group to associate with this DB instance.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.
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.
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.
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.
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.
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 this argument is omitted, the default parameter group for the specified engine is used.
dBParameterGroupName
- The name of the DB parameter group to associate with this DB instance. If this argument is omitted, the
default parameter group for the specified engine is used.public String getDBParameterGroupName()
The name of the DB parameter group to associate with this DB instance. If this argument is omitted, the default parameter group for the specified engine is used.
public RestoreDBInstanceFromS3Request withDBParameterGroupName(String dBParameterGroupName)
The name of the DB parameter group to associate with this DB instance. If this argument is omitted, the default parameter group for the specified engine is used.
dBParameterGroupName
- The name of the DB parameter group to associate with this DB instance. If this argument is omitted, the
default parameter group for the specified 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.
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 The Backup Window.
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 The Backup Window.
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 The Backup Window.
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 The Backup Window.
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 The Backup Window.
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 MultiAZ is set to true
, you can't set
the AvailabilityZone parameter.
multiAZ
- Specifies whether the DB instance is a Multi-AZ deployment. If MultiAZ is set to true
, you
can't set the AvailabilityZone parameter.public Boolean getMultiAZ()
Specifies whether the DB instance is a Multi-AZ deployment. If MultiAZ is set to true
, you can't set
the AvailabilityZone parameter.
true
, you
can't set the AvailabilityZone parameter.public RestoreDBInstanceFromS3Request withMultiAZ(Boolean multiAZ)
Specifies whether the DB instance is a Multi-AZ deployment. If MultiAZ is set to true
, you can't set
the AvailabilityZone parameter.
multiAZ
- Specifies whether the DB instance is a Multi-AZ deployment. If MultiAZ is set to true
, you
can't set the AvailabilityZone parameter.public Boolean isMultiAZ()
Specifies whether the DB instance is a Multi-AZ deployment. If MultiAZ is set to true
, you can't set
the AvailabilityZone parameter.
true
, you
can't set the 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 as specified in CreateDBInstance.
engineVersion
- The version number of the database engine to use. Choose the latest minor version of your database engine
as specified in CreateDBInstance.public String getEngineVersion()
The version number of the database engine to use. Choose the latest minor version of your database engine as specified in CreateDBInstance.
public RestoreDBInstanceFromS3Request withEngineVersion(String engineVersion)
The version number of the database engine to use. Choose the latest minor version of your database engine as specified in CreateDBInstance.
engineVersion
- The version number of the database engine to use. Choose the latest minor version of your database engine
as specified in CreateDBInstance.public void setAutoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade)
True to indicate that minor engine upgrades are applied automatically to the DB instance during the maintenance window, and otherwise false.
Default: true
autoMinorVersionUpgrade
- True to indicate that minor engine upgrades are applied automatically to the DB instance during the
maintenance window, and otherwise false.
Default: true
public Boolean getAutoMinorVersionUpgrade()
True to indicate that minor engine upgrades are applied automatically to the DB instance during the maintenance window, and otherwise false.
Default: true
Default: true
public RestoreDBInstanceFromS3Request withAutoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade)
True to indicate that minor engine upgrades are applied automatically to the DB instance during the maintenance window, and otherwise false.
Default: true
autoMinorVersionUpgrade
- True to indicate that minor engine upgrades are applied automatically to the DB instance during the
maintenance window, and otherwise false.
Default: true
public Boolean isAutoMinorVersionUpgrade()
True to indicate that minor engine upgrades are applied automatically to the DB instance during the maintenance window, and otherwise false.
Default: true
Default: true
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 see Amazon RDS Provisioned IOPS Storage to Improve Performance.
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 see Amazon RDS
Provisioned IOPS Storage to Improve Performance.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 see Amazon RDS Provisioned IOPS Storage to Improve Performance.
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 see Amazon RDS Provisioned IOPS Storage to Improve Performance.
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 see Amazon RDS
Provisioned IOPS Storage to Improve Performance.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 or not. For more information, see CreateDBInstance.
publiclyAccessible
- Specifies whether the DB instance is publicly accessible or not. For more information, see
CreateDBInstance.public Boolean getPubliclyAccessible()
Specifies whether the DB instance is publicly accessible or not. For more information, see CreateDBInstance.
public RestoreDBInstanceFromS3Request withPubliclyAccessible(Boolean publiclyAccessible)
Specifies whether the DB instance is publicly accessible or not. For more information, see CreateDBInstance.
publiclyAccessible
- Specifies whether the DB instance is publicly accessible or not. For more information, see
CreateDBInstance.public Boolean isPubliclyAccessible()
Specifies whether the DB instance is publicly accessible or not. 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.
public void setTags(Collection<Tag> tags)
A list of tags to associate with this DB instance. For more information, see Tagging Amazon RDS Resources.
tags
- A list of tags to associate with this DB instance. For more information, see Tagging Amazon RDS
Resources.public RestoreDBInstanceFromS3Request withTags(Tag... tags)
A list of tags to associate with this DB instance. For more information, see Tagging Amazon RDS Resources.
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.public RestoreDBInstanceFromS3Request withTags(Collection<Tag> tags)
A list of tags to associate with this DB instance. For more information, see Tagging Amazon RDS Resources.
tags
- A list of tags to associate with this DB instance. For more information, see Tagging Amazon RDS
Resources.public void setStorageType(String storageType)
Specifies the storage type to be associated with the DB instance.
Valid values: standard
| gp2
| io1
If you specify io1
, you must also include a value for the Iops
parameter.
Default: io1
if the Iops
parameter is specified; otherwise standard
storageType
- Specifies the storage type to be associated with the DB instance.
Valid values: standard
| gp2
| io1
If you specify io1
, you must also include a value for the Iops
parameter.
Default: io1
if the Iops
parameter is specified; otherwise standard
public String getStorageType()
Specifies the storage type to be associated with the DB instance.
Valid values: standard
| gp2
| io1
If you specify io1
, you must also include a value for the Iops
parameter.
Default: io1
if the Iops
parameter is specified; otherwise standard
Valid values: standard
| gp2
| io1
If you specify io1
, you must also include a value for the Iops
parameter.
Default: io1
if the Iops
parameter is specified; otherwise
standard
public RestoreDBInstanceFromS3Request withStorageType(String storageType)
Specifies the storage type to be associated with the DB instance.
Valid values: standard
| gp2
| io1
If you specify io1
, you must also include a value for the Iops
parameter.
Default: io1
if the Iops
parameter is specified; otherwise standard
storageType
- Specifies the storage type to be associated with the DB instance.
Valid values: standard
| gp2
| io1
If you specify io1
, you must also include a value for the Iops
parameter.
Default: io1
if the Iops
parameter is specified; otherwise standard
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 AWS KMS key identifier for an encrypted DB instance.
The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are creating a DB instance with the same AWS account that owns the KMS encryption key used to encrypt the new DB instance, then you can use the KMS key alias instead of the ARN for the KM encryption key.
If the StorageEncrypted
parameter is true, and you do not specify a value for the
KmsKeyId
parameter, then Amazon RDS will use your default encryption key. AWS KMS creates the
default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS
Region.
kmsKeyId
- The AWS KMS key identifier for an encrypted DB instance.
The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are creating a DB instance with the same AWS account that owns the KMS encryption key used to encrypt the new DB instance, then you can use the KMS key alias instead of the ARN for the KM encryption key.
If the StorageEncrypted
parameter is true, and you do not specify a value for the
KmsKeyId
parameter, then Amazon RDS will use your default encryption key. AWS KMS creates the
default encryption key for your AWS account. Your AWS account has a different default encryption key for
each AWS Region.
public String getKmsKeyId()
The AWS KMS key identifier for an encrypted DB instance.
The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are creating a DB instance with the same AWS account that owns the KMS encryption key used to encrypt the new DB instance, then you can use the KMS key alias instead of the ARN for the KM encryption key.
If the StorageEncrypted
parameter is true, and you do not specify a value for the
KmsKeyId
parameter, then Amazon RDS will use your default encryption key. AWS KMS creates the
default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS
Region.
The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are creating a DB instance with the same AWS account that owns the KMS encryption key used to encrypt the new DB instance, then you can use the KMS key alias instead of the ARN for the KM encryption key.
If the StorageEncrypted
parameter is true, and you do not specify a value for the
KmsKeyId
parameter, then Amazon RDS will use your default encryption key. AWS KMS creates
the default encryption key for your AWS account. Your AWS account has a different default encryption key
for each AWS Region.
public RestoreDBInstanceFromS3Request withKmsKeyId(String kmsKeyId)
The AWS KMS key identifier for an encrypted DB instance.
The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are creating a DB instance with the same AWS account that owns the KMS encryption key used to encrypt the new DB instance, then you can use the KMS key alias instead of the ARN for the KM encryption key.
If the StorageEncrypted
parameter is true, and you do not specify a value for the
KmsKeyId
parameter, then Amazon RDS will use your default encryption key. AWS KMS creates the
default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS
Region.
kmsKeyId
- The AWS KMS key identifier for an encrypted DB instance.
The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are creating a DB instance with the same AWS account that owns the KMS encryption key used to encrypt the new DB instance, then you can use the KMS key alias instead of the ARN for the KM encryption key.
If the StorageEncrypted
parameter is true, and you do not specify a value for the
KmsKeyId
parameter, then Amazon RDS will use your default encryption key. AWS KMS creates the
default encryption key for your AWS account. Your AWS account has a different default encryption key for
each AWS Region.
public void setCopyTagsToSnapshot(Boolean copyTagsToSnapshot)
True to copy all tags from the DB instance to snapshots of the DB instance, and otherwise false.
Default: false.
copyTagsToSnapshot
- True to copy all tags from the DB instance to snapshots of the DB instance, and otherwise false.
Default: false.
public Boolean getCopyTagsToSnapshot()
True to copy all tags from the DB instance to snapshots of the DB instance, and otherwise false.
Default: false.
Default: false.
public RestoreDBInstanceFromS3Request withCopyTagsToSnapshot(Boolean copyTagsToSnapshot)
True to copy all tags from the DB instance to snapshots of the DB instance, and otherwise false.
Default: false.
copyTagsToSnapshot
- True to copy all tags from the DB instance to snapshots of the DB instance, and otherwise false.
Default: false.
public Boolean isCopyTagsToSnapshot()
True to copy all tags from the DB instance to snapshots of the DB instance, and otherwise false.
Default: false.
Default: false.
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.
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.
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.
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.
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.
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.
If MonitoringInterval
is set to a value other than 0, then you must supply a
MonitoringRoleArn
value.
public void setEnableIAMDatabaseAuthentication(Boolean enableIAMDatabaseAuthentication)
True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and otherwise false.
Default: false
enableIAMDatabaseAuthentication
- True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and
otherwise false.
Default: false
public Boolean getEnableIAMDatabaseAuthentication()
True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and otherwise false.
Default: false
Default: false
public RestoreDBInstanceFromS3Request withEnableIAMDatabaseAuthentication(Boolean enableIAMDatabaseAuthentication)
True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and otherwise false.
Default: false
enableIAMDatabaseAuthentication
- True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and
otherwise false.
Default: false
public Boolean isEnableIAMDatabaseAuthentication()
True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and otherwise false.
Default: false
Default: false
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 engine version of your source database.
Valid Values: 5.6
sourceEngineVersion
- The engine version of your source database.
Valid Values: 5.6
public String getSourceEngineVersion()
The engine version of your source database.
Valid Values: 5.6
Valid Values: 5.6
public RestoreDBInstanceFromS3Request withSourceEngineVersion(String sourceEngineVersion)
The engine version of your source database.
Valid Values: 5.6
sourceEngineVersion
- The engine version of your source database.
Valid Values: 5.6
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 AWS Identity and Access Management (IAM) role to allow Amazon RDS to access your Amazon S3 bucket.
s3IngestionRoleArn
- An AWS Identity and Access Management (IAM) role to allow Amazon RDS to access your Amazon S3 bucket.public String getS3IngestionRoleArn()
An AWS Identity and Access Management (IAM) role to allow Amazon RDS to access your Amazon S3 bucket.
public RestoreDBInstanceFromS3Request withS3IngestionRoleArn(String s3IngestionRoleArn)
An AWS Identity and Access Management (IAM) role to allow Amazon RDS to access your Amazon S3 bucket.
s3IngestionRoleArn
- An AWS Identity and Access Management (IAM) role to allow Amazon RDS to access your Amazon S3 bucket.public void setEnablePerformanceInsights(Boolean enablePerformanceInsights)
True to enable Performance Insights for the DB instance, and otherwise false.
For more information, see Using Amazon Performance Insights in the Amazon Relational Database Service User Guide.
enablePerformanceInsights
- True to enable Performance Insights for the DB instance, and otherwise false.
For more information, see Using Amazon Performance Insights in the Amazon Relational Database Service User Guide.
public Boolean getEnablePerformanceInsights()
True to enable Performance Insights for the DB instance, and otherwise false.
For more information, see Using Amazon Performance Insights in the Amazon Relational Database Service User Guide.
For more information, see Using Amazon Performance Insights in the Amazon Relational Database Service User Guide.
public RestoreDBInstanceFromS3Request withEnablePerformanceInsights(Boolean enablePerformanceInsights)
True to enable Performance Insights for the DB instance, and otherwise false.
For more information, see Using Amazon Performance Insights in the Amazon Relational Database Service User Guide.
enablePerformanceInsights
- True to enable Performance Insights for the DB instance, and otherwise false.
For more information, see Using Amazon Performance Insights in the Amazon Relational Database Service User Guide.
public Boolean isEnablePerformanceInsights()
True to enable Performance Insights for the DB instance, and otherwise false.
For more information, see Using Amazon Performance Insights in the Amazon Relational Database Service User Guide.
For more information, see Using Amazon Performance Insights in the Amazon Relational Database Service User Guide.
public void setPerformanceInsightsKMSKeyId(String performanceInsightsKMSKeyId)
The AWS KMS key identifier for encryption of Performance Insights data. The KMS key ID is the Amazon Resource Name (ARN), the KMS key identifier, or the KMS key alias for the KMS encryption key.
performanceInsightsKMSKeyId
- The AWS KMS key identifier for encryption of Performance Insights data. The KMS key ID is the Amazon
Resource Name (ARN), the KMS key identifier, or the KMS key alias for the KMS encryption key.public String getPerformanceInsightsKMSKeyId()
The AWS KMS key identifier for encryption of Performance Insights data. The KMS key ID is the Amazon Resource Name (ARN), the KMS key identifier, or the KMS key alias for the KMS encryption key.
public RestoreDBInstanceFromS3Request withPerformanceInsightsKMSKeyId(String performanceInsightsKMSKeyId)
The AWS KMS key identifier for encryption of Performance Insights data. The KMS key ID is the Amazon Resource Name (ARN), the KMS key identifier, or the KMS key alias for the KMS encryption key.
performanceInsightsKMSKeyId
- The AWS KMS key identifier for encryption of Performance Insights data. The KMS key ID is the Amazon
Resource Name (ARN), the KMS key identifier, or the KMS key alias for the KMS encryption key.public List<String> getEnableCloudwatchLogsExports()
The list of logs that the restored DB instance is to export to CloudWatch Logs.
public void setEnableCloudwatchLogsExports(Collection<String> enableCloudwatchLogsExports)
The list of logs that the restored DB instance is to export to CloudWatch Logs.
enableCloudwatchLogsExports
- The list of logs that the restored DB instance is to export to CloudWatch Logs.public RestoreDBInstanceFromS3Request withEnableCloudwatchLogsExports(String... enableCloudwatchLogsExports)
The list of logs that the restored DB instance is to export to CloudWatch Logs.
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.public RestoreDBInstanceFromS3Request withEnableCloudwatchLogsExports(Collection<String> enableCloudwatchLogsExports)
The list of logs that the restored DB instance is to export to CloudWatch Logs.
enableCloudwatchLogsExports
- The list of logs that the restored DB instance is to export to CloudWatch Logs.public String toString()
toString
in class Object
Object.toString()
public RestoreDBInstanceFromS3Request clone()
AmazonWebServiceRequest
clone
in class AmazonWebServiceRequest
Object.clone()
Copyright © 2013 Amazon Web Services, Inc. All Rights Reserved.