@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class CreateDBInstanceRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
NOOP
Constructor and Description |
---|
CreateDBInstanceRequest()
Default constructor for CreateDBInstanceRequest object.
|
CreateDBInstanceRequest(String dBInstanceIdentifier,
Integer allocatedStorage,
String dBInstanceClass,
String engine,
String masterUsername,
String masterUserPassword)
Constructs a new CreateDBInstanceRequest object.
|
Modifier and Type | Method and Description |
---|---|
CreateDBInstanceRequest |
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 be initially allocated for the database instance.
|
Boolean |
getAutoMinorVersionUpgrade()
Indicates that minor engine upgrades are applied automatically to the DB instance during the maintenance window.
|
String |
getAvailabilityZone()
The EC2 Availability Zone that the database instance is created in.
|
Integer |
getBackupRetentionPeriod()
The number of days for which automated backups are retained.
|
String |
getCharacterSetName()
For supported engines, indicates that the DB instance should be associated with the specified CharacterSet.
|
Boolean |
getCopyTagsToSnapshot()
True to copy all tags from the DB instance to snapshots of the DB instance; otherwise false.
|
String |
getDBClusterIdentifier()
The identifier of the DB cluster that the instance will belong to.
|
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 meaning of this parameter differs according to the database engine you use.
|
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.
|
String |
getDomain()
Specify the Active Directory Domain to create the instance in.
|
String |
getDomainIAMRoleName()
Specify the name of the IAM role to be used when making API calls to the Directory Service.
|
Boolean |
getEnableIAMDatabaseAuthentication()
True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts; otherwise
false.
|
Boolean |
getEnablePerformanceInsights()
True to enable Performance Insights for the DB instance; 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 be initially allocated for the DB
instance.
|
String |
getKmsKeyId()
The KMS key identifier for an encrypted DB instance.
|
String |
getLicenseModel()
License model information 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 CloudWatch Logs.
|
Boolean |
getMultiAZ()
Specifies if the DB instance is a Multi-AZ deployment.
|
String |
getOptionGroupName()
Indicates that the DB instance should be associated with the specified option group.
|
String |
getPerformanceInsightsKMSKeyId()
The KMS key identifier for encryption of Performance Insights data.
|
Integer |
getPort()
The port number on which the database accepts connections.
|
String |
getPreferredBackupWindow()
The daily time range during which automated backups are created if automated backups are enabled, using the
BackupRetentionPeriod parameter. |
String |
getPreferredMaintenanceWindow()
The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
|
Integer |
getPromotionTier()
A value that specifies the order in which an Aurora Replica is promoted to the primary instance after a failure
of the existing primary instance.
|
Boolean |
getPubliclyAccessible()
Specifies the accessibility options for the DB instance.
|
Boolean |
getStorageEncrypted()
Specifies whether the DB instance is encrypted.
|
String |
getStorageType()
Specifies the storage type to be associated with the DB instance.
|
List<Tag> |
getTags() |
String |
getTdeCredentialArn()
The ARN from the Key Store with which to associate the instance for TDE encryption.
|
String |
getTdeCredentialPassword()
The password for the given ARN from the Key Store in order to access the device.
|
String |
getTimezone()
The time zone of the DB instance.
|
List<String> |
getVpcSecurityGroupIds()
A list of EC2 VPC security groups to associate with this DB instance.
|
int |
hashCode() |
Boolean |
isAutoMinorVersionUpgrade()
Indicates that minor engine upgrades are applied automatically to the DB instance during the maintenance window.
|
Boolean |
isCopyTagsToSnapshot()
True to copy all tags from the DB instance to snapshots of the DB instance; otherwise false.
|
Boolean |
isEnableIAMDatabaseAuthentication()
True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts; otherwise
false.
|
Boolean |
isEnablePerformanceInsights()
True to enable Performance Insights for the DB instance; otherwise false.
|
Boolean |
isMultiAZ()
Specifies if the DB instance is a Multi-AZ deployment.
|
Boolean |
isPubliclyAccessible()
Specifies the accessibility options for the DB instance.
|
Boolean |
isStorageEncrypted()
Specifies whether the DB instance is encrypted.
|
void |
setAllocatedStorage(Integer allocatedStorage)
The amount of storage (in gigabytes) to be initially allocated for the database instance.
|
void |
setAutoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade)
Indicates that minor engine upgrades are applied automatically to the DB instance during the maintenance window.
|
void |
setAvailabilityZone(String availabilityZone)
The EC2 Availability Zone that the database instance is created in.
|
void |
setBackupRetentionPeriod(Integer backupRetentionPeriod)
The number of days for which automated backups are retained.
|
void |
setCharacterSetName(String characterSetName)
For supported engines, indicates that the DB instance should be associated with the specified CharacterSet.
|
void |
setCopyTagsToSnapshot(Boolean copyTagsToSnapshot)
True to copy all tags from the DB instance to snapshots of the DB instance; otherwise false.
|
void |
setDBClusterIdentifier(String dBClusterIdentifier)
The identifier of the DB cluster that the instance will belong to.
|
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 meaning of this parameter differs according to the database engine you use.
|
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 |
setDomain(String domain)
Specify the Active Directory Domain to create the instance in.
|
void |
setDomainIAMRoleName(String domainIAMRoleName)
Specify the name of the IAM role to be used when making API calls to the Directory Service.
|
void |
setEnableIAMDatabaseAuthentication(Boolean enableIAMDatabaseAuthentication)
True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts; otherwise
false.
|
void |
setEnablePerformanceInsights(Boolean enablePerformanceInsights)
True to enable Performance Insights for the DB instance; 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 be initially allocated for the DB
instance.
|
void |
setKmsKeyId(String kmsKeyId)
The KMS key identifier for an encrypted DB instance.
|
void |
setLicenseModel(String licenseModel)
License model information 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 CloudWatch Logs.
|
void |
setMultiAZ(Boolean multiAZ)
Specifies if the DB instance is a Multi-AZ deployment.
|
void |
setOptionGroupName(String optionGroupName)
Indicates that the DB instance should be associated with the specified option group.
|
void |
setPerformanceInsightsKMSKeyId(String performanceInsightsKMSKeyId)
The 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 daily time range during which automated backups are created if automated backups are enabled, using the
BackupRetentionPeriod parameter. |
void |
setPreferredMaintenanceWindow(String preferredMaintenanceWindow)
The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
|
void |
setPromotionTier(Integer promotionTier)
A value that specifies the order in which an Aurora Replica is promoted to the primary instance after a failure
of the existing primary instance.
|
void |
setPubliclyAccessible(Boolean publiclyAccessible)
Specifies the accessibility options for the DB instance.
|
void |
setStorageEncrypted(Boolean storageEncrypted)
Specifies whether the DB instance is encrypted.
|
void |
setStorageType(String storageType)
Specifies the storage type to be associated with the DB instance.
|
void |
setTags(Collection<Tag> tags) |
void |
setTdeCredentialArn(String tdeCredentialArn)
The ARN from the Key Store with which to associate the instance for TDE encryption.
|
void |
setTdeCredentialPassword(String tdeCredentialPassword)
The password for the given ARN from the Key Store in order to access the device.
|
void |
setTimezone(String timezone)
The time zone of the DB instance.
|
void |
setVpcSecurityGroupIds(Collection<String> vpcSecurityGroupIds)
A list of EC2 VPC security groups to associate with this DB instance.
|
String |
toString()
Returns a string representation of this object; useful for testing and debugging.
|
CreateDBInstanceRequest |
withAllocatedStorage(Integer allocatedStorage)
The amount of storage (in gigabytes) to be initially allocated for the database instance.
|
CreateDBInstanceRequest |
withAutoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade)
Indicates that minor engine upgrades are applied automatically to the DB instance during the maintenance window.
|
CreateDBInstanceRequest |
withAvailabilityZone(String availabilityZone)
The EC2 Availability Zone that the database instance is created in.
|
CreateDBInstanceRequest |
withBackupRetentionPeriod(Integer backupRetentionPeriod)
The number of days for which automated backups are retained.
|
CreateDBInstanceRequest |
withCharacterSetName(String characterSetName)
For supported engines, indicates that the DB instance should be associated with the specified CharacterSet.
|
CreateDBInstanceRequest |
withCopyTagsToSnapshot(Boolean copyTagsToSnapshot)
True to copy all tags from the DB instance to snapshots of the DB instance; otherwise false.
|
CreateDBInstanceRequest |
withDBClusterIdentifier(String dBClusterIdentifier)
The identifier of the DB cluster that the instance will belong to.
|
CreateDBInstanceRequest |
withDBInstanceClass(String dBInstanceClass)
The compute and memory capacity of the DB instance, for example,
db.m4.large . |
CreateDBInstanceRequest |
withDBInstanceIdentifier(String dBInstanceIdentifier)
The DB instance identifier.
|
CreateDBInstanceRequest |
withDBName(String dBName)
The meaning of this parameter differs according to the database engine you use.
|
CreateDBInstanceRequest |
withDBParameterGroupName(String dBParameterGroupName)
The name of the DB parameter group to associate with this DB instance.
|
CreateDBInstanceRequest |
withDBSecurityGroups(Collection<String> dBSecurityGroups)
A list of DB security groups to associate with this DB instance.
|
CreateDBInstanceRequest |
withDBSecurityGroups(String... dBSecurityGroups)
A list of DB security groups to associate with this DB instance.
|
CreateDBInstanceRequest |
withDBSubnetGroupName(String dBSubnetGroupName)
A DB subnet group to associate with this DB instance.
|
CreateDBInstanceRequest |
withDomain(String domain)
Specify the Active Directory Domain to create the instance in.
|
CreateDBInstanceRequest |
withDomainIAMRoleName(String domainIAMRoleName)
Specify the name of the IAM role to be used when making API calls to the Directory Service.
|
CreateDBInstanceRequest |
withEnableIAMDatabaseAuthentication(Boolean enableIAMDatabaseAuthentication)
True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts; otherwise
false.
|
CreateDBInstanceRequest |
withEnablePerformanceInsights(Boolean enablePerformanceInsights)
True to enable Performance Insights for the DB instance; otherwise false.
|
CreateDBInstanceRequest |
withEngine(String engine)
The name of the database engine to be used for this instance.
|
CreateDBInstanceRequest |
withEngineVersion(String engineVersion)
The version number of the database engine to use.
|
CreateDBInstanceRequest |
withIops(Integer iops)
The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB
instance.
|
CreateDBInstanceRequest |
withKmsKeyId(String kmsKeyId)
The KMS key identifier for an encrypted DB instance.
|
CreateDBInstanceRequest |
withLicenseModel(String licenseModel)
License model information for this DB instance.
|
CreateDBInstanceRequest |
withMasterUsername(String masterUsername)
The name for the master user.
|
CreateDBInstanceRequest |
withMasterUserPassword(String masterUserPassword)
The password for the master user.
|
CreateDBInstanceRequest |
withMonitoringInterval(Integer monitoringInterval)
The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance.
|
CreateDBInstanceRequest |
withMonitoringRoleArn(String monitoringRoleArn)
The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to CloudWatch Logs.
|
CreateDBInstanceRequest |
withMultiAZ(Boolean multiAZ)
Specifies if the DB instance is a Multi-AZ deployment.
|
CreateDBInstanceRequest |
withOptionGroupName(String optionGroupName)
Indicates that the DB instance should be associated with the specified option group.
|
CreateDBInstanceRequest |
withPerformanceInsightsKMSKeyId(String performanceInsightsKMSKeyId)
The KMS key identifier for encryption of Performance Insights data.
|
CreateDBInstanceRequest |
withPort(Integer port)
The port number on which the database accepts connections.
|
CreateDBInstanceRequest |
withPreferredBackupWindow(String preferredBackupWindow)
The daily time range during which automated backups are created if automated backups are enabled, using the
BackupRetentionPeriod parameter. |
CreateDBInstanceRequest |
withPreferredMaintenanceWindow(String preferredMaintenanceWindow)
The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
|
CreateDBInstanceRequest |
withPromotionTier(Integer promotionTier)
A value that specifies the order in which an Aurora Replica is promoted to the primary instance after a failure
of the existing primary instance.
|
CreateDBInstanceRequest |
withPubliclyAccessible(Boolean publiclyAccessible)
Specifies the accessibility options for the DB instance.
|
CreateDBInstanceRequest |
withStorageEncrypted(Boolean storageEncrypted)
Specifies whether the DB instance is encrypted.
|
CreateDBInstanceRequest |
withStorageType(String storageType)
Specifies the storage type to be associated with the DB instance.
|
CreateDBInstanceRequest |
withTags(Collection<Tag> tags) |
CreateDBInstanceRequest |
withTags(Tag... tags)
NOTE: This method appends the values to the existing list (if any).
|
CreateDBInstanceRequest |
withTdeCredentialArn(String tdeCredentialArn)
The ARN from the Key Store with which to associate the instance for TDE encryption.
|
CreateDBInstanceRequest |
withTdeCredentialPassword(String tdeCredentialPassword)
The password for the given ARN from the Key Store in order to access the device.
|
CreateDBInstanceRequest |
withTimezone(String timezone)
The time zone of the DB instance.
|
CreateDBInstanceRequest |
withVpcSecurityGroupIds(Collection<String> vpcSecurityGroupIds)
A list of EC2 VPC security groups to associate with this DB instance.
|
CreateDBInstanceRequest |
withVpcSecurityGroupIds(String... vpcSecurityGroupIds)
A list of EC2 VPC security groups to associate with this DB instance.
|
addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout
public CreateDBInstanceRequest()
public CreateDBInstanceRequest(String dBInstanceIdentifier, Integer allocatedStorage, String dBInstanceClass, String engine, String masterUsername, String masterUserPassword)
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
allocatedStorage
- The amount of storage (in gigabytes) to be initially allocated for the database instance.
Type: Integer
Amazon Aurora
Not applicable. Aurora cluster volumes automatically grow as the amount of data in your database increases, though you are only charged for the space that you use in an Aurora cluster volume.
MySQL
Constraints to the amount of storage for each storage type are the following:
General Purpose (SSD) storage (gp2): Must be an integer from 5 to 6144.
Provisioned IOPS storage (io1): Must be an integer from 100 to 6144.
Magnetic storage (standard): Must be an integer from 5 to 3072.
MariaDB
Constraints to the amount of storage for each storage type are the following:
General Purpose (SSD) storage (gp2): Must be an integer from 5 to 6144.
Provisioned IOPS storage (io1): Must be an integer from 100 to 6144.
Magnetic storage (standard): Must be an integer from 5 to 3072.
PostgreSQL
Constraints to the amount of storage for each storage type are the following:
General Purpose (SSD) storage (gp2): Must be an integer from 5 to 6144.
Provisioned IOPS storage (io1): Must be an integer from 100 to 6144.
Magnetic storage (standard): Must be an integer from 5 to 3072.
Oracle
Constraints to the amount of storage for each storage type are the following:
General Purpose (SSD) storage (gp2): Must be an integer from 10 to 6144.
Provisioned IOPS storage (io1): Must be an integer from 100 to 6144.
Magnetic storage (standard): Must be an integer from 10 to 3072.
SQL Server
Constraints to the amount of storage for each storage type are the following:
General Purpose (SSD) storage (gp2):
Enterprise and Standard editions: Must be an integer from 200 to 16384.
Web and Express editions: Must be an integer from 20 to 16384.
Provisioned IOPS storage (io1):
Enterprise and Standard editions: Must be an integer from 200 to 16384.
Web and Express editions: Must be an integer from 100 to 16384.
Magnetic storage (standard):
Enterprise and Standard editions: Must be an integer from 200 to 1024.
Web and Express editions: Must be an integer from 20 to 1024.
dBInstanceClass
- The compute and memory capacity of the DB instance, for example, db.m4.large
. Not all DB
instance classes are available in all 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.engine
- The name of the database engine to be used for this instance.
Not every database engine is available for every AWS Region.
Valid Values:
aurora
mariadb
mysql
oracle-ee
oracle-se2
oracle-se1
oracle-se
postgres
sqlserver-ee
sqlserver-se
sqlserver-ex
sqlserver-web
masterUsername
- The name for the master user.
Amazon Aurora
Not applicable. The name for the master user is managed by the DB cluster. For more information, see CreateDBCluster.
MariaDB
Constraints:
Required for MariaDB.
Must be 1 to 16 letters or numbers.
Cannot be a reserved word for the chosen database engine.
Microsoft SQL Server
Constraints:
Required for SQL Server.
Must be 1 to 128 letters or numbers.
The first character must be a letter.
Cannot be a reserved word for the chosen database engine.
MySQL
Constraints:
Required for MySQL.
Must be 1 to 16 letters or numbers.
First character must be a letter.
Cannot be a reserved word for the chosen database engine.
Oracle
Constraints:
Required for Oracle.
Must be 1 to 30 letters or numbers.
First character must be a letter.
Cannot be a reserved word for the chosen database engine.
PostgreSQL
Constraints:
Required for PostgreSQL.
Must be 1 to 63 letters or numbers.
First character must be a letter.
Cannot be a reserved word for the chosen database engine.
masterUserPassword
- The password for the master user. Can be any printable ASCII character except "/", """, or "@".
Amazon Aurora
Not applicable. The password for the master user is managed by the DB cluster. For more information, see CreateDBCluster.
MariaDB
Constraints: Must contain from 8 to 41 characters.
Microsoft SQL Server
Constraints: Must contain from 8 to 128 characters.
MySQL
Constraints: Must contain from 8 to 41 characters.
Oracle
Constraints: Must contain from 8 to 30 characters.
PostgreSQL
Constraints: Must contain from 8 to 128 characters.
public void setDBName(String dBName)
The meaning of this parameter differs according to the database engine you use.
Type: String
MySQL
The name of the database to create when the DB instance is created. If this parameter is not specified, no database is created in the DB instance.
Constraints:
Must contain 1 to 64 letters or numbers.
Cannot be a word reserved by the specified database engine
MariaDB
The name of the database to create when the DB instance is created. If this parameter is not specified, no database is created in the DB instance.
Constraints:
Must contain 1 to 64 letters or numbers.
Cannot be a word reserved by the specified database engine
PostgreSQL
The name of the database to create when the DB instance is created. If this parameter is not specified, the default "postgres" database is created in the DB instance.
Constraints:
Must contain 1 to 63 letters, numbers, or underscores.
Must begin with a letter or an underscore. Subsequent characters can be letters, underscores, or digits (0-9).
Cannot be a word reserved by the specified database engine
Oracle
The Oracle System ID (SID) of the created DB instance. If you specify null
, the default value
ORCL
is used. You can't specify the string NULL, or any other reserved word, for DBName
.
Default: ORCL
Constraints:
Cannot be longer than 8 characters
SQL Server
Not applicable. Must be null.
Amazon Aurora
The name of the database to create when the primary instance of the DB cluster is created. If this parameter is not specified, no database is created in the DB instance.
Constraints:
Must contain 1 to 64 letters or numbers.
Cannot be a word reserved by the specified database engine
dBName
- The meaning of this parameter differs according to the database engine you use.
Type: String
MySQL
The name of the database to create when the DB instance is created. If this parameter is not specified, no database is created in the DB instance.
Constraints:
Must contain 1 to 64 letters or numbers.
Cannot be a word reserved by the specified database engine
MariaDB
The name of the database to create when the DB instance is created. If this parameter is not specified, no database is created in the DB instance.
Constraints:
Must contain 1 to 64 letters or numbers.
Cannot be a word reserved by the specified database engine
PostgreSQL
The name of the database to create when the DB instance is created. If this parameter is not specified, the default "postgres" database is created in the DB instance.
Constraints:
Must contain 1 to 63 letters, numbers, or underscores.
Must begin with a letter or an underscore. Subsequent characters can be letters, underscores, or digits (0-9).
Cannot be a word reserved by the specified database engine
Oracle
The Oracle System ID (SID) of the created DB instance. If you specify null
, the default value
ORCL
is used. You can't specify the string NULL, or any other reserved word, for
DBName
.
Default: ORCL
Constraints:
Cannot be longer than 8 characters
SQL Server
Not applicable. Must be null.
Amazon Aurora
The name of the database to create when the primary instance of the DB cluster is created. If this parameter is not specified, no database is created in the DB instance.
Constraints:
Must contain 1 to 64 letters or numbers.
Cannot be a word reserved by the specified database engine
public String getDBName()
The meaning of this parameter differs according to the database engine you use.
Type: String
MySQL
The name of the database to create when the DB instance is created. If this parameter is not specified, no database is created in the DB instance.
Constraints:
Must contain 1 to 64 letters or numbers.
Cannot be a word reserved by the specified database engine
MariaDB
The name of the database to create when the DB instance is created. If this parameter is not specified, no database is created in the DB instance.
Constraints:
Must contain 1 to 64 letters or numbers.
Cannot be a word reserved by the specified database engine
PostgreSQL
The name of the database to create when the DB instance is created. If this parameter is not specified, the default "postgres" database is created in the DB instance.
Constraints:
Must contain 1 to 63 letters, numbers, or underscores.
Must begin with a letter or an underscore. Subsequent characters can be letters, underscores, or digits (0-9).
Cannot be a word reserved by the specified database engine
Oracle
The Oracle System ID (SID) of the created DB instance. If you specify null
, the default value
ORCL
is used. You can't specify the string NULL, or any other reserved word, for DBName
.
Default: ORCL
Constraints:
Cannot be longer than 8 characters
SQL Server
Not applicable. Must be null.
Amazon Aurora
The name of the database to create when the primary instance of the DB cluster is created. If this parameter is not specified, no database is created in the DB instance.
Constraints:
Must contain 1 to 64 letters or numbers.
Cannot be a word reserved by the specified database engine
Type: String
MySQL
The name of the database to create when the DB instance is created. If this parameter is not specified, no database is created in the DB instance.
Constraints:
Must contain 1 to 64 letters or numbers.
Cannot be a word reserved by the specified database engine
MariaDB
The name of the database to create when the DB instance is created. If this parameter is not specified, no database is created in the DB instance.
Constraints:
Must contain 1 to 64 letters or numbers.
Cannot be a word reserved by the specified database engine
PostgreSQL
The name of the database to create when the DB instance is created. If this parameter is not specified, the default "postgres" database is created in the DB instance.
Constraints:
Must contain 1 to 63 letters, numbers, or underscores.
Must begin with a letter or an underscore. Subsequent characters can be letters, underscores, or digits (0-9).
Cannot be a word reserved by the specified database engine
Oracle
The Oracle System ID (SID) of the created DB instance. If you specify null
, the default
value ORCL
is used. You can't specify the string NULL, or any other reserved word, for
DBName
.
Default: ORCL
Constraints:
Cannot be longer than 8 characters
SQL Server
Not applicable. Must be null.
Amazon Aurora
The name of the database to create when the primary instance of the DB cluster is created. If this parameter is not specified, no database is created in the DB instance.
Constraints:
Must contain 1 to 64 letters or numbers.
Cannot be a word reserved by the specified database engine
public CreateDBInstanceRequest withDBName(String dBName)
The meaning of this parameter differs according to the database engine you use.
Type: String
MySQL
The name of the database to create when the DB instance is created. If this parameter is not specified, no database is created in the DB instance.
Constraints:
Must contain 1 to 64 letters or numbers.
Cannot be a word reserved by the specified database engine
MariaDB
The name of the database to create when the DB instance is created. If this parameter is not specified, no database is created in the DB instance.
Constraints:
Must contain 1 to 64 letters or numbers.
Cannot be a word reserved by the specified database engine
PostgreSQL
The name of the database to create when the DB instance is created. If this parameter is not specified, the default "postgres" database is created in the DB instance.
Constraints:
Must contain 1 to 63 letters, numbers, or underscores.
Must begin with a letter or an underscore. Subsequent characters can be letters, underscores, or digits (0-9).
Cannot be a word reserved by the specified database engine
Oracle
The Oracle System ID (SID) of the created DB instance. If you specify null
, the default value
ORCL
is used. You can't specify the string NULL, or any other reserved word, for DBName
.
Default: ORCL
Constraints:
Cannot be longer than 8 characters
SQL Server
Not applicable. Must be null.
Amazon Aurora
The name of the database to create when the primary instance of the DB cluster is created. If this parameter is not specified, no database is created in the DB instance.
Constraints:
Must contain 1 to 64 letters or numbers.
Cannot be a word reserved by the specified database engine
dBName
- The meaning of this parameter differs according to the database engine you use.
Type: String
MySQL
The name of the database to create when the DB instance is created. If this parameter is not specified, no database is created in the DB instance.
Constraints:
Must contain 1 to 64 letters or numbers.
Cannot be a word reserved by the specified database engine
MariaDB
The name of the database to create when the DB instance is created. If this parameter is not specified, no database is created in the DB instance.
Constraints:
Must contain 1 to 64 letters or numbers.
Cannot be a word reserved by the specified database engine
PostgreSQL
The name of the database to create when the DB instance is created. If this parameter is not specified, the default "postgres" database is created in the DB instance.
Constraints:
Must contain 1 to 63 letters, numbers, or underscores.
Must begin with a letter or an underscore. Subsequent characters can be letters, underscores, or digits (0-9).
Cannot be a word reserved by the specified database engine
Oracle
The Oracle System ID (SID) of the created DB instance. If you specify null
, the default value
ORCL
is used. You can't specify the string NULL, or any other reserved word, for
DBName
.
Default: ORCL
Constraints:
Cannot be longer than 8 characters
SQL Server
Not applicable. Must be null.
Amazon Aurora
The name of the database to create when the primary instance of the DB cluster is created. If this parameter is not specified, no database is created in the DB instance.
Constraints:
Must contain 1 to 64 letters or numbers.
Cannot be a word reserved by the specified database engine
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 CreateDBInstanceRequest 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 be initially allocated for the database instance.
Type: Integer
Amazon Aurora
Not applicable. Aurora cluster volumes automatically grow as the amount of data in your database increases, though you are only charged for the space that you use in an Aurora cluster volume.
MySQL
Constraints to the amount of storage for each storage type are the following:
General Purpose (SSD) storage (gp2): Must be an integer from 5 to 6144.
Provisioned IOPS storage (io1): Must be an integer from 100 to 6144.
Magnetic storage (standard): Must be an integer from 5 to 3072.
MariaDB
Constraints to the amount of storage for each storage type are the following:
General Purpose (SSD) storage (gp2): Must be an integer from 5 to 6144.
Provisioned IOPS storage (io1): Must be an integer from 100 to 6144.
Magnetic storage (standard): Must be an integer from 5 to 3072.
PostgreSQL
Constraints to the amount of storage for each storage type are the following:
General Purpose (SSD) storage (gp2): Must be an integer from 5 to 6144.
Provisioned IOPS storage (io1): Must be an integer from 100 to 6144.
Magnetic storage (standard): Must be an integer from 5 to 3072.
Oracle
Constraints to the amount of storage for each storage type are the following:
General Purpose (SSD) storage (gp2): Must be an integer from 10 to 6144.
Provisioned IOPS storage (io1): Must be an integer from 100 to 6144.
Magnetic storage (standard): Must be an integer from 10 to 3072.
SQL Server
Constraints to the amount of storage for each storage type are the following:
General Purpose (SSD) storage (gp2):
Enterprise and Standard editions: Must be an integer from 200 to 16384.
Web and Express editions: Must be an integer from 20 to 16384.
Provisioned IOPS storage (io1):
Enterprise and Standard editions: Must be an integer from 200 to 16384.
Web and Express editions: Must be an integer from 100 to 16384.
Magnetic storage (standard):
Enterprise and Standard editions: Must be an integer from 200 to 1024.
Web and Express editions: Must be an integer from 20 to 1024.
allocatedStorage
- The amount of storage (in gigabytes) to be initially allocated for the database instance.
Type: Integer
Amazon Aurora
Not applicable. Aurora cluster volumes automatically grow as the amount of data in your database increases, though you are only charged for the space that you use in an Aurora cluster volume.
MySQL
Constraints to the amount of storage for each storage type are the following:
General Purpose (SSD) storage (gp2): Must be an integer from 5 to 6144.
Provisioned IOPS storage (io1): Must be an integer from 100 to 6144.
Magnetic storage (standard): Must be an integer from 5 to 3072.
MariaDB
Constraints to the amount of storage for each storage type are the following:
General Purpose (SSD) storage (gp2): Must be an integer from 5 to 6144.
Provisioned IOPS storage (io1): Must be an integer from 100 to 6144.
Magnetic storage (standard): Must be an integer from 5 to 3072.
PostgreSQL
Constraints to the amount of storage for each storage type are the following:
General Purpose (SSD) storage (gp2): Must be an integer from 5 to 6144.
Provisioned IOPS storage (io1): Must be an integer from 100 to 6144.
Magnetic storage (standard): Must be an integer from 5 to 3072.
Oracle
Constraints to the amount of storage for each storage type are the following:
General Purpose (SSD) storage (gp2): Must be an integer from 10 to 6144.
Provisioned IOPS storage (io1): Must be an integer from 100 to 6144.
Magnetic storage (standard): Must be an integer from 10 to 3072.
SQL Server
Constraints to the amount of storage for each storage type are the following:
General Purpose (SSD) storage (gp2):
Enterprise and Standard editions: Must be an integer from 200 to 16384.
Web and Express editions: Must be an integer from 20 to 16384.
Provisioned IOPS storage (io1):
Enterprise and Standard editions: Must be an integer from 200 to 16384.
Web and Express editions: Must be an integer from 100 to 16384.
Magnetic storage (standard):
Enterprise and Standard editions: Must be an integer from 200 to 1024.
Web and Express editions: Must be an integer from 20 to 1024.
public Integer getAllocatedStorage()
The amount of storage (in gigabytes) to be initially allocated for the database instance.
Type: Integer
Amazon Aurora
Not applicable. Aurora cluster volumes automatically grow as the amount of data in your database increases, though you are only charged for the space that you use in an Aurora cluster volume.
MySQL
Constraints to the amount of storage for each storage type are the following:
General Purpose (SSD) storage (gp2): Must be an integer from 5 to 6144.
Provisioned IOPS storage (io1): Must be an integer from 100 to 6144.
Magnetic storage (standard): Must be an integer from 5 to 3072.
MariaDB
Constraints to the amount of storage for each storage type are the following:
General Purpose (SSD) storage (gp2): Must be an integer from 5 to 6144.
Provisioned IOPS storage (io1): Must be an integer from 100 to 6144.
Magnetic storage (standard): Must be an integer from 5 to 3072.
PostgreSQL
Constraints to the amount of storage for each storage type are the following:
General Purpose (SSD) storage (gp2): Must be an integer from 5 to 6144.
Provisioned IOPS storage (io1): Must be an integer from 100 to 6144.
Magnetic storage (standard): Must be an integer from 5 to 3072.
Oracle
Constraints to the amount of storage for each storage type are the following:
General Purpose (SSD) storage (gp2): Must be an integer from 10 to 6144.
Provisioned IOPS storage (io1): Must be an integer from 100 to 6144.
Magnetic storage (standard): Must be an integer from 10 to 3072.
SQL Server
Constraints to the amount of storage for each storage type are the following:
General Purpose (SSD) storage (gp2):
Enterprise and Standard editions: Must be an integer from 200 to 16384.
Web and Express editions: Must be an integer from 20 to 16384.
Provisioned IOPS storage (io1):
Enterprise and Standard editions: Must be an integer from 200 to 16384.
Web and Express editions: Must be an integer from 100 to 16384.
Magnetic storage (standard):
Enterprise and Standard editions: Must be an integer from 200 to 1024.
Web and Express editions: Must be an integer from 20 to 1024.
Type: Integer
Amazon Aurora
Not applicable. Aurora cluster volumes automatically grow as the amount of data in your database increases, though you are only charged for the space that you use in an Aurora cluster volume.
MySQL
Constraints to the amount of storage for each storage type are the following:
General Purpose (SSD) storage (gp2): Must be an integer from 5 to 6144.
Provisioned IOPS storage (io1): Must be an integer from 100 to 6144.
Magnetic storage (standard): Must be an integer from 5 to 3072.
MariaDB
Constraints to the amount of storage for each storage type are the following:
General Purpose (SSD) storage (gp2): Must be an integer from 5 to 6144.
Provisioned IOPS storage (io1): Must be an integer from 100 to 6144.
Magnetic storage (standard): Must be an integer from 5 to 3072.
PostgreSQL
Constraints to the amount of storage for each storage type are the following:
General Purpose (SSD) storage (gp2): Must be an integer from 5 to 6144.
Provisioned IOPS storage (io1): Must be an integer from 100 to 6144.
Magnetic storage (standard): Must be an integer from 5 to 3072.
Oracle
Constraints to the amount of storage for each storage type are the following:
General Purpose (SSD) storage (gp2): Must be an integer from 10 to 6144.
Provisioned IOPS storage (io1): Must be an integer from 100 to 6144.
Magnetic storage (standard): Must be an integer from 10 to 3072.
SQL Server
Constraints to the amount of storage for each storage type are the following:
General Purpose (SSD) storage (gp2):
Enterprise and Standard editions: Must be an integer from 200 to 16384.
Web and Express editions: Must be an integer from 20 to 16384.
Provisioned IOPS storage (io1):
Enterprise and Standard editions: Must be an integer from 200 to 16384.
Web and Express editions: Must be an integer from 100 to 16384.
Magnetic storage (standard):
Enterprise and Standard editions: Must be an integer from 200 to 1024.
Web and Express editions: Must be an integer from 20 to 1024.
public CreateDBInstanceRequest withAllocatedStorage(Integer allocatedStorage)
The amount of storage (in gigabytes) to be initially allocated for the database instance.
Type: Integer
Amazon Aurora
Not applicable. Aurora cluster volumes automatically grow as the amount of data in your database increases, though you are only charged for the space that you use in an Aurora cluster volume.
MySQL
Constraints to the amount of storage for each storage type are the following:
General Purpose (SSD) storage (gp2): Must be an integer from 5 to 6144.
Provisioned IOPS storage (io1): Must be an integer from 100 to 6144.
Magnetic storage (standard): Must be an integer from 5 to 3072.
MariaDB
Constraints to the amount of storage for each storage type are the following:
General Purpose (SSD) storage (gp2): Must be an integer from 5 to 6144.
Provisioned IOPS storage (io1): Must be an integer from 100 to 6144.
Magnetic storage (standard): Must be an integer from 5 to 3072.
PostgreSQL
Constraints to the amount of storage for each storage type are the following:
General Purpose (SSD) storage (gp2): Must be an integer from 5 to 6144.
Provisioned IOPS storage (io1): Must be an integer from 100 to 6144.
Magnetic storage (standard): Must be an integer from 5 to 3072.
Oracle
Constraints to the amount of storage for each storage type are the following:
General Purpose (SSD) storage (gp2): Must be an integer from 10 to 6144.
Provisioned IOPS storage (io1): Must be an integer from 100 to 6144.
Magnetic storage (standard): Must be an integer from 10 to 3072.
SQL Server
Constraints to the amount of storage for each storage type are the following:
General Purpose (SSD) storage (gp2):
Enterprise and Standard editions: Must be an integer from 200 to 16384.
Web and Express editions: Must be an integer from 20 to 16384.
Provisioned IOPS storage (io1):
Enterprise and Standard editions: Must be an integer from 200 to 16384.
Web and Express editions: Must be an integer from 100 to 16384.
Magnetic storage (standard):
Enterprise and Standard editions: Must be an integer from 200 to 1024.
Web and Express editions: Must be an integer from 20 to 1024.
allocatedStorage
- The amount of storage (in gigabytes) to be initially allocated for the database instance.
Type: Integer
Amazon Aurora
Not applicable. Aurora cluster volumes automatically grow as the amount of data in your database increases, though you are only charged for the space that you use in an Aurora cluster volume.
MySQL
Constraints to the amount of storage for each storage type are the following:
General Purpose (SSD) storage (gp2): Must be an integer from 5 to 6144.
Provisioned IOPS storage (io1): Must be an integer from 100 to 6144.
Magnetic storage (standard): Must be an integer from 5 to 3072.
MariaDB
Constraints to the amount of storage for each storage type are the following:
General Purpose (SSD) storage (gp2): Must be an integer from 5 to 6144.
Provisioned IOPS storage (io1): Must be an integer from 100 to 6144.
Magnetic storage (standard): Must be an integer from 5 to 3072.
PostgreSQL
Constraints to the amount of storage for each storage type are the following:
General Purpose (SSD) storage (gp2): Must be an integer from 5 to 6144.
Provisioned IOPS storage (io1): Must be an integer from 100 to 6144.
Magnetic storage (standard): Must be an integer from 5 to 3072.
Oracle
Constraints to the amount of storage for each storage type are the following:
General Purpose (SSD) storage (gp2): Must be an integer from 10 to 6144.
Provisioned IOPS storage (io1): Must be an integer from 100 to 6144.
Magnetic storage (standard): Must be an integer from 10 to 3072.
SQL Server
Constraints to the amount of storage for each storage type are the following:
General Purpose (SSD) storage (gp2):
Enterprise and Standard editions: Must be an integer from 200 to 16384.
Web and Express editions: Must be an integer from 20 to 16384.
Provisioned IOPS storage (io1):
Enterprise and Standard editions: Must be an integer from 200 to 16384.
Web and Express editions: Must be an integer from 100 to 16384.
Magnetic storage (standard):
Enterprise and Standard editions: Must be an integer from 200 to 1024.
Web and Express editions: Must be an integer from 20 to 1024.
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 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.
dBInstanceClass
- The compute and memory capacity of the DB instance, for example, db.m4.large
. Not all DB
instance classes are available in all 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.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 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.
db.m4.large
. Not all DB
instance classes are available in all 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.public CreateDBInstanceRequest 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 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.
dBInstanceClass
- The compute and memory capacity of the DB instance, for example, db.m4.large
. Not all DB
instance classes are available in all 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.public void setEngine(String engine)
The name of the database engine to be used for this instance.
Not every database engine is available for every AWS Region.
Valid Values:
aurora
mariadb
mysql
oracle-ee
oracle-se2
oracle-se1
oracle-se
postgres
sqlserver-ee
sqlserver-se
sqlserver-ex
sqlserver-web
engine
- The name of the database engine to be used for this instance.
Not every database engine is available for every AWS Region.
Valid Values:
aurora
mariadb
mysql
oracle-ee
oracle-se2
oracle-se1
oracle-se
postgres
sqlserver-ee
sqlserver-se
sqlserver-ex
sqlserver-web
public String getEngine()
The name of the database engine to be used for this instance.
Not every database engine is available for every AWS Region.
Valid Values:
aurora
mariadb
mysql
oracle-ee
oracle-se2
oracle-se1
oracle-se
postgres
sqlserver-ee
sqlserver-se
sqlserver-ex
sqlserver-web
Not every database engine is available for every AWS Region.
Valid Values:
aurora
mariadb
mysql
oracle-ee
oracle-se2
oracle-se1
oracle-se
postgres
sqlserver-ee
sqlserver-se
sqlserver-ex
sqlserver-web
public CreateDBInstanceRequest withEngine(String engine)
The name of the database engine to be used for this instance.
Not every database engine is available for every AWS Region.
Valid Values:
aurora
mariadb
mysql
oracle-ee
oracle-se2
oracle-se1
oracle-se
postgres
sqlserver-ee
sqlserver-se
sqlserver-ex
sqlserver-web
engine
- The name of the database engine to be used for this instance.
Not every database engine is available for every AWS Region.
Valid Values:
aurora
mariadb
mysql
oracle-ee
oracle-se2
oracle-se1
oracle-se
postgres
sqlserver-ee
sqlserver-se
sqlserver-ex
sqlserver-web
public void setMasterUsername(String masterUsername)
The name for the master user.
Amazon Aurora
Not applicable. The name for the master user is managed by the DB cluster. For more information, see CreateDBCluster.
MariaDB
Constraints:
Required for MariaDB.
Must be 1 to 16 letters or numbers.
Cannot be a reserved word for the chosen database engine.
Microsoft SQL Server
Constraints:
Required for SQL Server.
Must be 1 to 128 letters or numbers.
The first character must be a letter.
Cannot be a reserved word for the chosen database engine.
MySQL
Constraints:
Required for MySQL.
Must be 1 to 16 letters or numbers.
First character must be a letter.
Cannot be a reserved word for the chosen database engine.
Oracle
Constraints:
Required for Oracle.
Must be 1 to 30 letters or numbers.
First character must be a letter.
Cannot be a reserved word for the chosen database engine.
PostgreSQL
Constraints:
Required for PostgreSQL.
Must be 1 to 63 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.
Amazon Aurora
Not applicable. The name for the master user is managed by the DB cluster. For more information, see CreateDBCluster.
MariaDB
Constraints:
Required for MariaDB.
Must be 1 to 16 letters or numbers.
Cannot be a reserved word for the chosen database engine.
Microsoft SQL Server
Constraints:
Required for SQL Server.
Must be 1 to 128 letters or numbers.
The first character must be a letter.
Cannot be a reserved word for the chosen database engine.
MySQL
Constraints:
Required for MySQL.
Must be 1 to 16 letters or numbers.
First character must be a letter.
Cannot be a reserved word for the chosen database engine.
Oracle
Constraints:
Required for Oracle.
Must be 1 to 30 letters or numbers.
First character must be a letter.
Cannot be a reserved word for the chosen database engine.
PostgreSQL
Constraints:
Required for PostgreSQL.
Must be 1 to 63 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.
Amazon Aurora
Not applicable. The name for the master user is managed by the DB cluster. For more information, see CreateDBCluster.
MariaDB
Constraints:
Required for MariaDB.
Must be 1 to 16 letters or numbers.
Cannot be a reserved word for the chosen database engine.
Microsoft SQL Server
Constraints:
Required for SQL Server.
Must be 1 to 128 letters or numbers.
The first character must be a letter.
Cannot be a reserved word for the chosen database engine.
MySQL
Constraints:
Required for MySQL.
Must be 1 to 16 letters or numbers.
First character must be a letter.
Cannot be a reserved word for the chosen database engine.
Oracle
Constraints:
Required for Oracle.
Must be 1 to 30 letters or numbers.
First character must be a letter.
Cannot be a reserved word for the chosen database engine.
PostgreSQL
Constraints:
Required for PostgreSQL.
Must be 1 to 63 letters or numbers.
First character must be a letter.
Cannot be a reserved word for the chosen database engine.
Amazon Aurora
Not applicable. The name for the master user is managed by the DB cluster. For more information, see CreateDBCluster.
MariaDB
Constraints:
Required for MariaDB.
Must be 1 to 16 letters or numbers.
Cannot be a reserved word for the chosen database engine.
Microsoft SQL Server
Constraints:
Required for SQL Server.
Must be 1 to 128 letters or numbers.
The first character must be a letter.
Cannot be a reserved word for the chosen database engine.
MySQL
Constraints:
Required for MySQL.
Must be 1 to 16 letters or numbers.
First character must be a letter.
Cannot be a reserved word for the chosen database engine.
Oracle
Constraints:
Required for Oracle.
Must be 1 to 30 letters or numbers.
First character must be a letter.
Cannot be a reserved word for the chosen database engine.
PostgreSQL
Constraints:
Required for PostgreSQL.
Must be 1 to 63 letters or numbers.
First character must be a letter.
Cannot be a reserved word for the chosen database engine.
public CreateDBInstanceRequest withMasterUsername(String masterUsername)
The name for the master user.
Amazon Aurora
Not applicable. The name for the master user is managed by the DB cluster. For more information, see CreateDBCluster.
MariaDB
Constraints:
Required for MariaDB.
Must be 1 to 16 letters or numbers.
Cannot be a reserved word for the chosen database engine.
Microsoft SQL Server
Constraints:
Required for SQL Server.
Must be 1 to 128 letters or numbers.
The first character must be a letter.
Cannot be a reserved word for the chosen database engine.
MySQL
Constraints:
Required for MySQL.
Must be 1 to 16 letters or numbers.
First character must be a letter.
Cannot be a reserved word for the chosen database engine.
Oracle
Constraints:
Required for Oracle.
Must be 1 to 30 letters or numbers.
First character must be a letter.
Cannot be a reserved word for the chosen database engine.
PostgreSQL
Constraints:
Required for PostgreSQL.
Must be 1 to 63 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.
Amazon Aurora
Not applicable. The name for the master user is managed by the DB cluster. For more information, see CreateDBCluster.
MariaDB
Constraints:
Required for MariaDB.
Must be 1 to 16 letters or numbers.
Cannot be a reserved word for the chosen database engine.
Microsoft SQL Server
Constraints:
Required for SQL Server.
Must be 1 to 128 letters or numbers.
The first character must be a letter.
Cannot be a reserved word for the chosen database engine.
MySQL
Constraints:
Required for MySQL.
Must be 1 to 16 letters or numbers.
First character must be a letter.
Cannot be a reserved word for the chosen database engine.
Oracle
Constraints:
Required for Oracle.
Must be 1 to 30 letters or numbers.
First character must be a letter.
Cannot be a reserved word for the chosen database engine.
PostgreSQL
Constraints:
Required for PostgreSQL.
Must be 1 to 63 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. Can be any printable ASCII character except "/", """, or "@".
Amazon Aurora
Not applicable. The password for the master user is managed by the DB cluster. For more information, see CreateDBCluster.
MariaDB
Constraints: Must contain from 8 to 41 characters.
Microsoft SQL Server
Constraints: Must contain from 8 to 128 characters.
MySQL
Constraints: Must contain from 8 to 41 characters.
Oracle
Constraints: Must contain from 8 to 30 characters.
PostgreSQL
Constraints: Must contain from 8 to 128 characters.
masterUserPassword
- The password for the master user. Can be any printable ASCII character except "/", """, or "@".
Amazon Aurora
Not applicable. The password for the master user is managed by the DB cluster. For more information, see CreateDBCluster.
MariaDB
Constraints: Must contain from 8 to 41 characters.
Microsoft SQL Server
Constraints: Must contain from 8 to 128 characters.
MySQL
Constraints: Must contain from 8 to 41 characters.
Oracle
Constraints: Must contain from 8 to 30 characters.
PostgreSQL
Constraints: Must contain from 8 to 128 characters.
public String getMasterUserPassword()
The password for the master user. Can be any printable ASCII character except "/", """, or "@".
Amazon Aurora
Not applicable. The password for the master user is managed by the DB cluster. For more information, see CreateDBCluster.
MariaDB
Constraints: Must contain from 8 to 41 characters.
Microsoft SQL Server
Constraints: Must contain from 8 to 128 characters.
MySQL
Constraints: Must contain from 8 to 41 characters.
Oracle
Constraints: Must contain from 8 to 30 characters.
PostgreSQL
Constraints: Must contain from 8 to 128 characters.
Amazon Aurora
Not applicable. The password for the master user is managed by the DB cluster. For more information, see CreateDBCluster.
MariaDB
Constraints: Must contain from 8 to 41 characters.
Microsoft SQL Server
Constraints: Must contain from 8 to 128 characters.
MySQL
Constraints: Must contain from 8 to 41 characters.
Oracle
Constraints: Must contain from 8 to 30 characters.
PostgreSQL
Constraints: Must contain from 8 to 128 characters.
public CreateDBInstanceRequest withMasterUserPassword(String masterUserPassword)
The password for the master user. Can be any printable ASCII character except "/", """, or "@".
Amazon Aurora
Not applicable. The password for the master user is managed by the DB cluster. For more information, see CreateDBCluster.
MariaDB
Constraints: Must contain from 8 to 41 characters.
Microsoft SQL Server
Constraints: Must contain from 8 to 128 characters.
MySQL
Constraints: Must contain from 8 to 41 characters.
Oracle
Constraints: Must contain from 8 to 30 characters.
PostgreSQL
Constraints: Must contain from 8 to 128 characters.
masterUserPassword
- The password for the master user. Can be any printable ASCII character except "/", """, or "@".
Amazon Aurora
Not applicable. The password for the master user is managed by the DB cluster. For more information, see CreateDBCluster.
MariaDB
Constraints: Must contain from 8 to 41 characters.
Microsoft SQL Server
Constraints: Must contain from 8 to 128 characters.
MySQL
Constraints: Must contain from 8 to 41 characters.
Oracle
Constraints: Must contain from 8 to 30 characters.
PostgreSQL
Constraints: 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 CreateDBInstanceRequest 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 CreateDBInstanceRequest 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 EC2 VPC security groups to associate with this DB instance.
Amazon Aurora
Not applicable. The associated list of EC2 VPC security groups is managed by the DB cluster. For more information, see CreateDBCluster.
Default: The default EC2 VPC security group for the DB subnet group's VPC.
Amazon Aurora
Not applicable. The associated list of EC2 VPC security groups is managed by the DB cluster. For more information, see CreateDBCluster.
Default: The default EC2 VPC security group for the DB subnet group's VPC.
public void setVpcSecurityGroupIds(Collection<String> vpcSecurityGroupIds)
A list of EC2 VPC security groups to associate with this DB instance.
Amazon Aurora
Not applicable. The associated list of EC2 VPC security groups is managed by the DB cluster. For more information, see CreateDBCluster.
Default: The default EC2 VPC security group for the DB subnet group's VPC.
vpcSecurityGroupIds
- A list of EC2 VPC security groups to associate with this DB instance.
Amazon Aurora
Not applicable. The associated list of EC2 VPC security groups is managed by the DB cluster. For more information, see CreateDBCluster.
Default: The default EC2 VPC security group for the DB subnet group's VPC.
public CreateDBInstanceRequest withVpcSecurityGroupIds(String... vpcSecurityGroupIds)
A list of EC2 VPC security groups to associate with this DB instance.
Amazon Aurora
Not applicable. The associated list of EC2 VPC security groups is managed by the DB cluster. For more information, see CreateDBCluster.
Default: The default EC2 VPC security group for the DB subnet group's VPC.
NOTE: This method appends the values to the existing list (if any). Use
setVpcSecurityGroupIds(java.util.Collection)
or withVpcSecurityGroupIds(java.util.Collection)
if you want to override the existing values.
vpcSecurityGroupIds
- A list of EC2 VPC security groups to associate with this DB instance.
Amazon Aurora
Not applicable. The associated list of EC2 VPC security groups is managed by the DB cluster. For more information, see CreateDBCluster.
Default: The default EC2 VPC security group for the DB subnet group's VPC.
public CreateDBInstanceRequest withVpcSecurityGroupIds(Collection<String> vpcSecurityGroupIds)
A list of EC2 VPC security groups to associate with this DB instance.
Amazon Aurora
Not applicable. The associated list of EC2 VPC security groups is managed by the DB cluster. For more information, see CreateDBCluster.
Default: The default EC2 VPC security group for the DB subnet group's VPC.
vpcSecurityGroupIds
- A list of EC2 VPC security groups to associate with this DB instance.
Amazon Aurora
Not applicable. The associated list of EC2 VPC security groups is managed by the DB cluster. For more information, see CreateDBCluster.
Default: The default EC2 VPC security group for the DB subnet group's VPC.
public void setAvailabilityZone(String availabilityZone)
The EC2 Availability Zone that the database instance is created in. For information on 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 cannot 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 EC2 Availability Zone that the database instance is created in. For information on 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 cannot 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 EC2 Availability Zone that the database instance is created in. For information on 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 cannot 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 cannot 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 CreateDBInstanceRequest withAvailabilityZone(String availabilityZone)
The EC2 Availability Zone that the database instance is created in. For information on 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 cannot 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 EC2 Availability Zone that the database instance is created in. For information on 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 cannot 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.
If there is no DB subnet group, then it is a non-VPC DB instance.
dBSubnetGroupName
- A DB subnet group to associate with this DB instance.
If there is no DB subnet group, then it is a non-VPC DB instance.
public String getDBSubnetGroupName()
A DB subnet group to associate with this DB instance.
If there is no DB subnet group, then it is a non-VPC DB instance.
If there is no DB subnet group, then it is a non-VPC DB instance.
public CreateDBInstanceRequest withDBSubnetGroupName(String dBSubnetGroupName)
A DB subnet group to associate with this DB instance.
If there is no DB subnet group, then it is a non-VPC DB instance.
dBSubnetGroupName
- A DB subnet group to associate with this DB instance.
If there is no DB subnet group, then it is a non-VPC DB instance.
public void setPreferredMaintenanceWindow(String preferredMaintenanceWindow)
The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC). For more information, see DB Instance Maintenance.
Format: ddd:hh24:mi-ddd:hh24:mi
Default: A 30-minute window selected at random from an 8-hour block of time per AWS Region, occurring on a random day of the week. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon RDS User Guide.
Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun
Constraints: Minimum 30-minute window.
preferredMaintenanceWindow
- The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC). For
more information, see DB Instance
Maintenance.
Format: ddd:hh24:mi-ddd:hh24:mi
Default: A 30-minute window selected at random from an 8-hour block of time per AWS Region, occurring on a random day of the week. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon RDS User Guide.
Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun
Constraints: Minimum 30-minute window.
public String getPreferredMaintenanceWindow()
The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC). For more information, see DB Instance Maintenance.
Format: ddd:hh24:mi-ddd:hh24:mi
Default: A 30-minute window selected at random from an 8-hour block of time per AWS Region, occurring on a random day of the week. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon RDS User Guide.
Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun
Constraints: Minimum 30-minute window.
Format: ddd:hh24:mi-ddd:hh24:mi
Default: A 30-minute window selected at random from an 8-hour block of time per AWS Region, occurring on a random day of the week. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon RDS User Guide.
Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun
Constraints: Minimum 30-minute window.
public CreateDBInstanceRequest withPreferredMaintenanceWindow(String preferredMaintenanceWindow)
The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC). For more information, see DB Instance Maintenance.
Format: ddd:hh24:mi-ddd:hh24:mi
Default: A 30-minute window selected at random from an 8-hour block of time per AWS Region, occurring on a random day of the week. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon RDS User Guide.
Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun
Constraints: Minimum 30-minute window.
preferredMaintenanceWindow
- The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC). For
more information, see DB Instance
Maintenance.
Format: ddd:hh24:mi-ddd:hh24:mi
Default: A 30-minute window selected at random from an 8-hour block of time per AWS Region, occurring on a random day of the week. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon RDS User Guide.
Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun
Constraints: Minimum 30-minute window.
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 DBParameterGroup for the specified engine is used.
Constraints:
Must be 1 to 255 letters, numbers, or hyphens.
First character must be a letter
Cannot end with a hyphen or contain two consecutive hyphens
dBParameterGroupName
- The name of the DB parameter group to associate with this DB instance. If this argument is omitted, the
default DBParameterGroup for the specified engine is used.
Constraints:
Must be 1 to 255 letters, numbers, or hyphens.
First character must be a letter
Cannot end with a hyphen or contain two consecutive hyphens
public String getDBParameterGroupName()
The name of the DB parameter group to associate with this DB instance. If this argument is omitted, the default DBParameterGroup for the specified engine is used.
Constraints:
Must be 1 to 255 letters, numbers, or hyphens.
First character must be a letter
Cannot end with a hyphen or contain two consecutive hyphens
Constraints:
Must be 1 to 255 letters, numbers, or hyphens.
First character must be a letter
Cannot end with a hyphen or contain two consecutive hyphens
public CreateDBInstanceRequest withDBParameterGroupName(String dBParameterGroupName)
The name of the DB parameter group to associate with this DB instance. If this argument is omitted, the default DBParameterGroup for the specified engine is used.
Constraints:
Must be 1 to 255 letters, numbers, or hyphens.
First character must be a letter
Cannot end with a hyphen or contain two consecutive hyphens
dBParameterGroupName
- The name of the DB parameter group to associate with this DB instance. If this argument is omitted, the
default DBParameterGroup for the specified engine is used.
Constraints:
Must be 1 to 255 letters, numbers, or hyphens.
First character must be a letter
Cannot end with a hyphen or contain two consecutive hyphens
public void setBackupRetentionPeriod(Integer backupRetentionPeriod)
The number of days for which automated backups are retained. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups.
Amazon Aurora
Not applicable. The retention period for automated backups is managed by the DB cluster. For more information, see CreateDBCluster.
Default: 1
Constraints:
Must be a value from 0 to 35
Cannot be set to 0 if the DB instance is a source to Read Replicas
backupRetentionPeriod
- The number of days for which automated backups are retained. Setting this parameter to a positive number
enables backups. Setting this parameter to 0 disables automated backups.
Amazon Aurora
Not applicable. The retention period for automated backups is managed by the DB cluster. For more information, see CreateDBCluster.
Default: 1
Constraints:
Must be a value from 0 to 35
Cannot be set to 0 if the DB instance is a source to Read Replicas
public Integer getBackupRetentionPeriod()
The number of days for which automated backups are retained. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups.
Amazon Aurora
Not applicable. The retention period for automated backups is managed by the DB cluster. For more information, see CreateDBCluster.
Default: 1
Constraints:
Must be a value from 0 to 35
Cannot be set to 0 if the DB instance is a source to Read Replicas
Amazon Aurora
Not applicable. The retention period for automated backups is managed by the DB cluster. For more information, see CreateDBCluster.
Default: 1
Constraints:
Must be a value from 0 to 35
Cannot be set to 0 if the DB instance is a source to Read Replicas
public CreateDBInstanceRequest withBackupRetentionPeriod(Integer backupRetentionPeriod)
The number of days for which automated backups are retained. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups.
Amazon Aurora
Not applicable. The retention period for automated backups is managed by the DB cluster. For more information, see CreateDBCluster.
Default: 1
Constraints:
Must be a value from 0 to 35
Cannot be set to 0 if the DB instance is a source to Read Replicas
backupRetentionPeriod
- The number of days for which automated backups are retained. Setting this parameter to a positive number
enables backups. Setting this parameter to 0 disables automated backups.
Amazon Aurora
Not applicable. The retention period for automated backups is managed by the DB cluster. For more information, see CreateDBCluster.
Default: 1
Constraints:
Must be a value from 0 to 35
Cannot be set to 0 if the DB instance is a source to Read Replicas
public void setPreferredBackupWindow(String preferredBackupWindow)
The daily time range during which automated backups are created if automated backups are enabled, using the
BackupRetentionPeriod
parameter. For more information, see DB
Instance Backups.
Amazon Aurora
Not applicable. The daily time range for creating automated backups is managed by the DB cluster. For more information, see CreateDBCluster.
Default: A 30-minute window selected at random from an 8-hour block of time per AWS Region. To see the time blocks available, see Adjusting the Preferred DB Instance Maintenance Window.
Constraints:
Must be in the format hh24:mi-hh24:mi
.
Times should be in Universal Coordinated Time (UTC).
Must not conflict with the preferred maintenance window.
Must be at least 30 minutes.
preferredBackupWindow
- The daily time range during which automated backups are created if automated backups are enabled, using
the BackupRetentionPeriod
parameter. For more information, see DB Instance Backups.
Amazon Aurora
Not applicable. The daily time range for creating automated backups is managed by the DB cluster. For more information, see CreateDBCluster.
Default: A 30-minute window selected at random from an 8-hour block of time per AWS Region. To see the time blocks available, see Adjusting the Preferred DB Instance Maintenance Window.
Constraints:
Must be in the format hh24:mi-hh24:mi
.
Times should be in Universal Coordinated Time (UTC).
Must not conflict with the preferred maintenance window.
Must be at least 30 minutes.
public String getPreferredBackupWindow()
The daily time range during which automated backups are created if automated backups are enabled, using the
BackupRetentionPeriod
parameter. For more information, see DB
Instance Backups.
Amazon Aurora
Not applicable. The daily time range for creating automated backups is managed by the DB cluster. For more information, see CreateDBCluster.
Default: A 30-minute window selected at random from an 8-hour block of time per AWS Region. To see the time blocks available, see Adjusting the Preferred DB Instance Maintenance Window.
Constraints:
Must be in the format hh24:mi-hh24:mi
.
Times should be in Universal Coordinated Time (UTC).
Must not conflict with the preferred maintenance window.
Must be at least 30 minutes.
BackupRetentionPeriod
parameter. For more information, see DB Instance Backups.
Amazon Aurora
Not applicable. The daily time range for creating automated backups is managed by the DB cluster. For more information, see CreateDBCluster.
Default: A 30-minute window selected at random from an 8-hour block of time per AWS Region. To see the time blocks available, see Adjusting the Preferred DB Instance Maintenance Window.
Constraints:
Must be in the format hh24:mi-hh24:mi
.
Times should be in Universal Coordinated Time (UTC).
Must not conflict with the preferred maintenance window.
Must be at least 30 minutes.
public CreateDBInstanceRequest withPreferredBackupWindow(String preferredBackupWindow)
The daily time range during which automated backups are created if automated backups are enabled, using the
BackupRetentionPeriod
parameter. For more information, see DB
Instance Backups.
Amazon Aurora
Not applicable. The daily time range for creating automated backups is managed by the DB cluster. For more information, see CreateDBCluster.
Default: A 30-minute window selected at random from an 8-hour block of time per AWS Region. To see the time blocks available, see Adjusting the Preferred DB Instance Maintenance Window.
Constraints:
Must be in the format hh24:mi-hh24:mi
.
Times should be in Universal Coordinated Time (UTC).
Must not conflict with the preferred maintenance window.
Must be at least 30 minutes.
preferredBackupWindow
- The daily time range during which automated backups are created if automated backups are enabled, using
the BackupRetentionPeriod
parameter. For more information, see DB Instance Backups.
Amazon Aurora
Not applicable. The daily time range for creating automated backups is managed by the DB cluster. For more information, see CreateDBCluster.
Default: A 30-minute window selected at random from an 8-hour block of time per AWS Region. To see the time blocks available, see Adjusting the Preferred DB Instance Maintenance Window.
Constraints:
Must be in the format hh24:mi-hh24:mi
.
Times should 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.
MySQL
Default: 3306
Valid Values: 1150-65535
Type: Integer
MariaDB
Default: 3306
Valid Values: 1150-65535
Type: Integer
PostgreSQL
Default: 5432
Valid Values: 1150-65535
Type: Integer
Oracle
Default: 1521
Valid Values: 1150-65535
SQL Server
Default: 1433
Valid Values: 1150-65535
except for 1434
, 3389
, 47001
,
49152
, and 49152
through 49156
.
Amazon Aurora
Default: 3306
Valid Values: 1150-65535
Type: Integer
port
- The port number on which the database accepts connections.
MySQL
Default: 3306
Valid Values: 1150-65535
Type: Integer
MariaDB
Default: 3306
Valid Values: 1150-65535
Type: Integer
PostgreSQL
Default: 5432
Valid Values: 1150-65535
Type: Integer
Oracle
Default: 1521
Valid Values: 1150-65535
SQL Server
Default: 1433
Valid Values: 1150-65535
except for 1434
, 3389
, 47001
,
49152
, and 49152
through 49156
.
Amazon Aurora
Default: 3306
Valid Values: 1150-65535
Type: Integer
public Integer getPort()
The port number on which the database accepts connections.
MySQL
Default: 3306
Valid Values: 1150-65535
Type: Integer
MariaDB
Default: 3306
Valid Values: 1150-65535
Type: Integer
PostgreSQL
Default: 5432
Valid Values: 1150-65535
Type: Integer
Oracle
Default: 1521
Valid Values: 1150-65535
SQL Server
Default: 1433
Valid Values: 1150-65535
except for 1434
, 3389
, 47001
,
49152
, and 49152
through 49156
.
Amazon Aurora
Default: 3306
Valid Values: 1150-65535
Type: Integer
MySQL
Default: 3306
Valid Values: 1150-65535
Type: Integer
MariaDB
Default: 3306
Valid Values: 1150-65535
Type: Integer
PostgreSQL
Default: 5432
Valid Values: 1150-65535
Type: Integer
Oracle
Default: 1521
Valid Values: 1150-65535
SQL Server
Default: 1433
Valid Values: 1150-65535
except for 1434
, 3389
, 47001
, 49152
, and 49152
through 49156
.
Amazon Aurora
Default: 3306
Valid Values: 1150-65535
Type: Integer
public CreateDBInstanceRequest withPort(Integer port)
The port number on which the database accepts connections.
MySQL
Default: 3306
Valid Values: 1150-65535
Type: Integer
MariaDB
Default: 3306
Valid Values: 1150-65535
Type: Integer
PostgreSQL
Default: 5432
Valid Values: 1150-65535
Type: Integer
Oracle
Default: 1521
Valid Values: 1150-65535
SQL Server
Default: 1433
Valid Values: 1150-65535
except for 1434
, 3389
, 47001
,
49152
, and 49152
through 49156
.
Amazon Aurora
Default: 3306
Valid Values: 1150-65535
Type: Integer
port
- The port number on which the database accepts connections.
MySQL
Default: 3306
Valid Values: 1150-65535
Type: Integer
MariaDB
Default: 3306
Valid Values: 1150-65535
Type: Integer
PostgreSQL
Default: 5432
Valid Values: 1150-65535
Type: Integer
Oracle
Default: 1521
Valid Values: 1150-65535
SQL Server
Default: 1433
Valid Values: 1150-65535
except for 1434
, 3389
, 47001
,
49152
, and 49152
through 49156
.
Amazon Aurora
Default: 3306
Valid Values: 1150-65535
Type: Integer
public void setMultiAZ(Boolean multiAZ)
Specifies if the DB instance is a Multi-AZ deployment. You cannot set the AvailabilityZone parameter if the MultiAZ parameter is set to true.
multiAZ
- Specifies if the DB instance is a Multi-AZ deployment. You cannot set the AvailabilityZone parameter if
the MultiAZ parameter is set to true.public Boolean getMultiAZ()
Specifies if the DB instance is a Multi-AZ deployment. You cannot set the AvailabilityZone parameter if the MultiAZ parameter is set to true.
public CreateDBInstanceRequest withMultiAZ(Boolean multiAZ)
Specifies if the DB instance is a Multi-AZ deployment. You cannot set the AvailabilityZone parameter if the MultiAZ parameter is set to true.
multiAZ
- Specifies if the DB instance is a Multi-AZ deployment. You cannot set the AvailabilityZone parameter if
the MultiAZ parameter is set to true.public Boolean isMultiAZ()
Specifies if the DB instance is a Multi-AZ deployment. You cannot set the AvailabilityZone parameter if the MultiAZ parameter is set to true.
public void setEngineVersion(String engineVersion)
The version number of the database engine to use.
The following are the database engines and major and minor versions that are available with Amazon RDS. Not every database engine is available for every AWS Region.
Amazon Aurora
Not applicable. The version number of the database engine to be used by the DB instance is managed by the DB cluster. For more information, see CreateDBCluster.
MariaDB
10.1.23
(supported in all AWS regions)
10.1.19
(supported in all AWS regions)
10.1.14
(supported in all regions except us-east-2)
10.0.31
(supported in all AWS regions)
10.0.28
(supported in all AWS regions)
10.0.24
(supported in all AWS regions)
10.0.17
(supported in all regions except us-east-2, ca-central-1, eu-west-2)
Microsoft SQL Server 2016
13.00.4422.0.v1
(supported for all editions, and all AWS regions)
13.00.2164.0.v1
(supported for all editions, and all AWS regions)
Microsoft SQL Server 2014
12.00.5546.0.v1
(supported for all editions, and all AWS regions)
12.00.5000.0.v1
(supported for all editions, and all AWS regions)
12.00.4422.0.v1
(supported for all editions except Enterprise Edition, and all AWS regions except
ca-central-1 and eu-west-2)
Microsoft SQL Server 2012
11.00.6594.0.v1
(supported for all editions, and all AWS regions)
11.00.6020.0.v1
(supported for all editions, and all AWS regions)
11.00.5058.0.v1
(supported for all editions, and all AWS regions except us-east-2, ca-central-1, and
eu-west-2)
11.00.2100.60.v1
(supported for all editions, and all AWS regions except us-east-2, ca-central-1,
and eu-west-2)
Microsoft SQL Server 2008 R2
10.50.6529.0.v1
(supported for all editions, and all AWS regions except us-east-2, ca-central-1, and
eu-west-2)
10.50.6000.34.v1
(supported for all editions, and all AWS regions except us-east-2, ca-central-1,
and eu-west-2)
10.50.2789.0.v1
(supported for all editions, and all AWS regions except us-east-2, ca-central-1, and
eu-west-2)
MySQL
5.7.19
(supported in all AWS regions)
5.7.17
(supported in all AWS regions)
5.7.16
(supported in all AWS regions)
5.7.11
(supported in all AWS regions)
5.6.37
(supported in all AWS regions)
5.6.35
(supported in all AWS regions)
5.6.34
(supported in all AWS regions)
5.6.29
(supported in all AWS regions)
5.6.27
(supported in all regions except us-east-2, ca-central-1, eu-west-2)
5.5.57
(supported in all AWS regions)
5.5.54
(supported in all AWS regions)
5.5.53
(supported in all AWS regions)
5.5.46
(supported in all AWS regions)
Oracle 12c
12.1.0.2.v9
(supported for EE in all AWS regions, and SE2 in all AWS regions except us-gov-west-1)
12.1.0.2.v8
(supported for EE in all AWS regions, and SE2 in all AWS regions except us-gov-west-1)
12.1.0.2.v7
(supported for EE in all AWS regions, and SE2 in all AWS regions except us-gov-west-1)
12.1.0.2.v6
(supported for EE in all AWS regions, and SE2 in all AWS regions except us-gov-west-1)
12.1.0.2.v5
(supported for EE in all AWS regions, and SE2 in all AWS regions except us-gov-west-1)
12.1.0.2.v4
(supported for EE in all AWS regions, and SE2 in all AWS regions except us-gov-west-1)
12.1.0.2.v3
(supported for EE in all AWS regions, and SE2 in all AWS regions except us-gov-west-1)
12.1.0.2.v2
(supported for EE in all AWS regions, and SE2 in all AWS regions except us-gov-west-1)
12.1.0.2.v1
(supported for EE in all AWS regions, and SE2 in all AWS regions except us-gov-west-1)
Oracle 11g
11.2.0.4.v13
(supported for EE, SE1, and SE, in all AWS regions)
11.2.0.4.v12
(supported for EE, SE1, and SE, in all AWS regions)
11.2.0.4.v11
(supported for EE, SE1, and SE, in all AWS regions)
11.2.0.4.v10
(supported for EE, SE1, and SE, in all AWS regions)
11.2.0.4.v9
(supported for EE, SE1, and SE, in all AWS regions)
11.2.0.4.v8
(supported for EE, SE1, and SE, in all AWS regions)
11.2.0.4.v7
(supported for EE, SE1, and SE, in all AWS regions)
11.2.0.4.v6
(supported for EE, SE1, and SE, in all AWS regions)
11.2.0.4.v5
(supported for EE, SE1, and SE, in all AWS regions)
11.2.0.4.v4
(supported for EE, SE1, and SE, in all AWS regions)
11.2.0.4.v3
(supported for EE, SE1, and SE, in all AWS regions)
11.2.0.4.v1
(supported for EE, SE1, and SE, in all AWS regions)
PostgreSQL
Version 9.6.x: 9.6.5 | 9.6.3 | 9.6.2 | 9.6.1
Version 9.5.x: 9.5.9 | 9.5.7 | 9.5.6 | 9.5.4 | 9.5.2
Version 9.4.x: 9.4.14 | 9.4.12 | 9.4.11 | 9.4.9 | 9.4.7
Version 9.3.x: 9.3.19 | 9.3.17 | 9.3.16 | 9.3.14 | 9.3.12
engineVersion
- The version number of the database engine to use.
The following are the database engines and major and minor versions that are available with Amazon RDS. Not every database engine is available for every AWS Region.
Amazon Aurora
Not applicable. The version number of the database engine to be used by the DB instance is managed by the DB cluster. For more information, see CreateDBCluster.
MariaDB
10.1.23
(supported in all AWS regions)
10.1.19
(supported in all AWS regions)
10.1.14
(supported in all regions except us-east-2)
10.0.31
(supported in all AWS regions)
10.0.28
(supported in all AWS regions)
10.0.24
(supported in all AWS regions)
10.0.17
(supported in all regions except us-east-2, ca-central-1, eu-west-2)
Microsoft SQL Server 2016
13.00.4422.0.v1
(supported for all editions, and all AWS regions)
13.00.2164.0.v1
(supported for all editions, and all AWS regions)
Microsoft SQL Server 2014
12.00.5546.0.v1
(supported for all editions, and all AWS regions)
12.00.5000.0.v1
(supported for all editions, and all AWS regions)
12.00.4422.0.v1
(supported for all editions except Enterprise Edition, and all AWS regions
except ca-central-1 and eu-west-2)
Microsoft SQL Server 2012
11.00.6594.0.v1
(supported for all editions, and all AWS regions)
11.00.6020.0.v1
(supported for all editions, and all AWS regions)
11.00.5058.0.v1
(supported for all editions, and all AWS regions except us-east-2,
ca-central-1, and eu-west-2)
11.00.2100.60.v1
(supported for all editions, and all AWS regions except us-east-2,
ca-central-1, and eu-west-2)
Microsoft SQL Server 2008 R2
10.50.6529.0.v1
(supported for all editions, and all AWS regions except us-east-2,
ca-central-1, and eu-west-2)
10.50.6000.34.v1
(supported for all editions, and all AWS regions except us-east-2,
ca-central-1, and eu-west-2)
10.50.2789.0.v1
(supported for all editions, and all AWS regions except us-east-2,
ca-central-1, and eu-west-2)
MySQL
5.7.19
(supported in all AWS regions)
5.7.17
(supported in all AWS regions)
5.7.16
(supported in all AWS regions)
5.7.11
(supported in all AWS regions)
5.6.37
(supported in all AWS regions)
5.6.35
(supported in all AWS regions)
5.6.34
(supported in all AWS regions)
5.6.29
(supported in all AWS regions)
5.6.27
(supported in all regions except us-east-2, ca-central-1, eu-west-2)
5.5.57
(supported in all AWS regions)
5.5.54
(supported in all AWS regions)
5.5.53
(supported in all AWS regions)
5.5.46
(supported in all AWS regions)
Oracle 12c
12.1.0.2.v9
(supported for EE in all AWS regions, and SE2 in all AWS regions except
us-gov-west-1)
12.1.0.2.v8
(supported for EE in all AWS regions, and SE2 in all AWS regions except
us-gov-west-1)
12.1.0.2.v7
(supported for EE in all AWS regions, and SE2 in all AWS regions except
us-gov-west-1)
12.1.0.2.v6
(supported for EE in all AWS regions, and SE2 in all AWS regions except
us-gov-west-1)
12.1.0.2.v5
(supported for EE in all AWS regions, and SE2 in all AWS regions except
us-gov-west-1)
12.1.0.2.v4
(supported for EE in all AWS regions, and SE2 in all AWS regions except
us-gov-west-1)
12.1.0.2.v3
(supported for EE in all AWS regions, and SE2 in all AWS regions except
us-gov-west-1)
12.1.0.2.v2
(supported for EE in all AWS regions, and SE2 in all AWS regions except
us-gov-west-1)
12.1.0.2.v1
(supported for EE in all AWS regions, and SE2 in all AWS regions except
us-gov-west-1)
Oracle 11g
11.2.0.4.v13
(supported for EE, SE1, and SE, in all AWS regions)
11.2.0.4.v12
(supported for EE, SE1, and SE, in all AWS regions)
11.2.0.4.v11
(supported for EE, SE1, and SE, in all AWS regions)
11.2.0.4.v10
(supported for EE, SE1, and SE, in all AWS regions)
11.2.0.4.v9
(supported for EE, SE1, and SE, in all AWS regions)
11.2.0.4.v8
(supported for EE, SE1, and SE, in all AWS regions)
11.2.0.4.v7
(supported for EE, SE1, and SE, in all AWS regions)
11.2.0.4.v6
(supported for EE, SE1, and SE, in all AWS regions)
11.2.0.4.v5
(supported for EE, SE1, and SE, in all AWS regions)
11.2.0.4.v4
(supported for EE, SE1, and SE, in all AWS regions)
11.2.0.4.v3
(supported for EE, SE1, and SE, in all AWS regions)
11.2.0.4.v1
(supported for EE, SE1, and SE, in all AWS regions)
PostgreSQL
Version 9.6.x: 9.6.5 | 9.6.3 | 9.6.2 | 9.6.1
Version 9.5.x: 9.5.9 | 9.5.7 | 9.5.6 | 9.5.4 | 9.5.2
Version 9.4.x: 9.4.14 | 9.4.12 | 9.4.11 | 9.4.9 | 9.4.7
Version 9.3.x: 9.3.19 | 9.3.17 | 9.3.16 | 9.3.14 | 9.3.12
public String getEngineVersion()
The version number of the database engine to use.
The following are the database engines and major and minor versions that are available with Amazon RDS. Not every database engine is available for every AWS Region.
Amazon Aurora
Not applicable. The version number of the database engine to be used by the DB instance is managed by the DB cluster. For more information, see CreateDBCluster.
MariaDB
10.1.23
(supported in all AWS regions)
10.1.19
(supported in all AWS regions)
10.1.14
(supported in all regions except us-east-2)
10.0.31
(supported in all AWS regions)
10.0.28
(supported in all AWS regions)
10.0.24
(supported in all AWS regions)
10.0.17
(supported in all regions except us-east-2, ca-central-1, eu-west-2)
Microsoft SQL Server 2016
13.00.4422.0.v1
(supported for all editions, and all AWS regions)
13.00.2164.0.v1
(supported for all editions, and all AWS regions)
Microsoft SQL Server 2014
12.00.5546.0.v1
(supported for all editions, and all AWS regions)
12.00.5000.0.v1
(supported for all editions, and all AWS regions)
12.00.4422.0.v1
(supported for all editions except Enterprise Edition, and all AWS regions except
ca-central-1 and eu-west-2)
Microsoft SQL Server 2012
11.00.6594.0.v1
(supported for all editions, and all AWS regions)
11.00.6020.0.v1
(supported for all editions, and all AWS regions)
11.00.5058.0.v1
(supported for all editions, and all AWS regions except us-east-2, ca-central-1, and
eu-west-2)
11.00.2100.60.v1
(supported for all editions, and all AWS regions except us-east-2, ca-central-1,
and eu-west-2)
Microsoft SQL Server 2008 R2
10.50.6529.0.v1
(supported for all editions, and all AWS regions except us-east-2, ca-central-1, and
eu-west-2)
10.50.6000.34.v1
(supported for all editions, and all AWS regions except us-east-2, ca-central-1,
and eu-west-2)
10.50.2789.0.v1
(supported for all editions, and all AWS regions except us-east-2, ca-central-1, and
eu-west-2)
MySQL
5.7.19
(supported in all AWS regions)
5.7.17
(supported in all AWS regions)
5.7.16
(supported in all AWS regions)
5.7.11
(supported in all AWS regions)
5.6.37
(supported in all AWS regions)
5.6.35
(supported in all AWS regions)
5.6.34
(supported in all AWS regions)
5.6.29
(supported in all AWS regions)
5.6.27
(supported in all regions except us-east-2, ca-central-1, eu-west-2)
5.5.57
(supported in all AWS regions)
5.5.54
(supported in all AWS regions)
5.5.53
(supported in all AWS regions)
5.5.46
(supported in all AWS regions)
Oracle 12c
12.1.0.2.v9
(supported for EE in all AWS regions, and SE2 in all AWS regions except us-gov-west-1)
12.1.0.2.v8
(supported for EE in all AWS regions, and SE2 in all AWS regions except us-gov-west-1)
12.1.0.2.v7
(supported for EE in all AWS regions, and SE2 in all AWS regions except us-gov-west-1)
12.1.0.2.v6
(supported for EE in all AWS regions, and SE2 in all AWS regions except us-gov-west-1)
12.1.0.2.v5
(supported for EE in all AWS regions, and SE2 in all AWS regions except us-gov-west-1)
12.1.0.2.v4
(supported for EE in all AWS regions, and SE2 in all AWS regions except us-gov-west-1)
12.1.0.2.v3
(supported for EE in all AWS regions, and SE2 in all AWS regions except us-gov-west-1)
12.1.0.2.v2
(supported for EE in all AWS regions, and SE2 in all AWS regions except us-gov-west-1)
12.1.0.2.v1
(supported for EE in all AWS regions, and SE2 in all AWS regions except us-gov-west-1)
Oracle 11g
11.2.0.4.v13
(supported for EE, SE1, and SE, in all AWS regions)
11.2.0.4.v12
(supported for EE, SE1, and SE, in all AWS regions)
11.2.0.4.v11
(supported for EE, SE1, and SE, in all AWS regions)
11.2.0.4.v10
(supported for EE, SE1, and SE, in all AWS regions)
11.2.0.4.v9
(supported for EE, SE1, and SE, in all AWS regions)
11.2.0.4.v8
(supported for EE, SE1, and SE, in all AWS regions)
11.2.0.4.v7
(supported for EE, SE1, and SE, in all AWS regions)
11.2.0.4.v6
(supported for EE, SE1, and SE, in all AWS regions)
11.2.0.4.v5
(supported for EE, SE1, and SE, in all AWS regions)
11.2.0.4.v4
(supported for EE, SE1, and SE, in all AWS regions)
11.2.0.4.v3
(supported for EE, SE1, and SE, in all AWS regions)
11.2.0.4.v1
(supported for EE, SE1, and SE, in all AWS regions)
PostgreSQL
Version 9.6.x: 9.6.5 | 9.6.3 | 9.6.2 | 9.6.1
Version 9.5.x: 9.5.9 | 9.5.7 | 9.5.6 | 9.5.4 | 9.5.2
Version 9.4.x: 9.4.14 | 9.4.12 | 9.4.11 | 9.4.9 | 9.4.7
Version 9.3.x: 9.3.19 | 9.3.17 | 9.3.16 | 9.3.14 | 9.3.12
The following are the database engines and major and minor versions that are available with Amazon RDS. Not every database engine is available for every AWS Region.
Amazon Aurora
Not applicable. The version number of the database engine to be used by the DB instance is managed by the DB cluster. For more information, see CreateDBCluster.
MariaDB
10.1.23
(supported in all AWS regions)
10.1.19
(supported in all AWS regions)
10.1.14
(supported in all regions except us-east-2)
10.0.31
(supported in all AWS regions)
10.0.28
(supported in all AWS regions)
10.0.24
(supported in all AWS regions)
10.0.17
(supported in all regions except us-east-2, ca-central-1, eu-west-2)
Microsoft SQL Server 2016
13.00.4422.0.v1
(supported for all editions, and all AWS regions)
13.00.2164.0.v1
(supported for all editions, and all AWS regions)
Microsoft SQL Server 2014
12.00.5546.0.v1
(supported for all editions, and all AWS regions)
12.00.5000.0.v1
(supported for all editions, and all AWS regions)
12.00.4422.0.v1
(supported for all editions except Enterprise Edition, and all AWS regions
except ca-central-1 and eu-west-2)
Microsoft SQL Server 2012
11.00.6594.0.v1
(supported for all editions, and all AWS regions)
11.00.6020.0.v1
(supported for all editions, and all AWS regions)
11.00.5058.0.v1
(supported for all editions, and all AWS regions except us-east-2,
ca-central-1, and eu-west-2)
11.00.2100.60.v1
(supported for all editions, and all AWS regions except us-east-2,
ca-central-1, and eu-west-2)
Microsoft SQL Server 2008 R2
10.50.6529.0.v1
(supported for all editions, and all AWS regions except us-east-2,
ca-central-1, and eu-west-2)
10.50.6000.34.v1
(supported for all editions, and all AWS regions except us-east-2,
ca-central-1, and eu-west-2)
10.50.2789.0.v1
(supported for all editions, and all AWS regions except us-east-2,
ca-central-1, and eu-west-2)
MySQL
5.7.19
(supported in all AWS regions)
5.7.17
(supported in all AWS regions)
5.7.16
(supported in all AWS regions)
5.7.11
(supported in all AWS regions)
5.6.37
(supported in all AWS regions)
5.6.35
(supported in all AWS regions)
5.6.34
(supported in all AWS regions)
5.6.29
(supported in all AWS regions)
5.6.27
(supported in all regions except us-east-2, ca-central-1, eu-west-2)
5.5.57
(supported in all AWS regions)
5.5.54
(supported in all AWS regions)
5.5.53
(supported in all AWS regions)
5.5.46
(supported in all AWS regions)
Oracle 12c
12.1.0.2.v9
(supported for EE in all AWS regions, and SE2 in all AWS regions except
us-gov-west-1)
12.1.0.2.v8
(supported for EE in all AWS regions, and SE2 in all AWS regions except
us-gov-west-1)
12.1.0.2.v7
(supported for EE in all AWS regions, and SE2 in all AWS regions except
us-gov-west-1)
12.1.0.2.v6
(supported for EE in all AWS regions, and SE2 in all AWS regions except
us-gov-west-1)
12.1.0.2.v5
(supported for EE in all AWS regions, and SE2 in all AWS regions except
us-gov-west-1)
12.1.0.2.v4
(supported for EE in all AWS regions, and SE2 in all AWS regions except
us-gov-west-1)
12.1.0.2.v3
(supported for EE in all AWS regions, and SE2 in all AWS regions except
us-gov-west-1)
12.1.0.2.v2
(supported for EE in all AWS regions, and SE2 in all AWS regions except
us-gov-west-1)
12.1.0.2.v1
(supported for EE in all AWS regions, and SE2 in all AWS regions except
us-gov-west-1)
Oracle 11g
11.2.0.4.v13
(supported for EE, SE1, and SE, in all AWS regions)
11.2.0.4.v12
(supported for EE, SE1, and SE, in all AWS regions)
11.2.0.4.v11
(supported for EE, SE1, and SE, in all AWS regions)
11.2.0.4.v10
(supported for EE, SE1, and SE, in all AWS regions)
11.2.0.4.v9
(supported for EE, SE1, and SE, in all AWS regions)
11.2.0.4.v8
(supported for EE, SE1, and SE, in all AWS regions)
11.2.0.4.v7
(supported for EE, SE1, and SE, in all AWS regions)
11.2.0.4.v6
(supported for EE, SE1, and SE, in all AWS regions)
11.2.0.4.v5
(supported for EE, SE1, and SE, in all AWS regions)
11.2.0.4.v4
(supported for EE, SE1, and SE, in all AWS regions)
11.2.0.4.v3
(supported for EE, SE1, and SE, in all AWS regions)
11.2.0.4.v1
(supported for EE, SE1, and SE, in all AWS regions)
PostgreSQL
Version 9.6.x: 9.6.5 | 9.6.3 | 9.6.2 | 9.6.1
Version 9.5.x: 9.5.9 | 9.5.7 | 9.5.6 | 9.5.4 | 9.5.2
Version 9.4.x: 9.4.14 | 9.4.12 | 9.4.11 | 9.4.9 | 9.4.7
Version 9.3.x: 9.3.19 | 9.3.17 | 9.3.16 | 9.3.14 | 9.3.12
public CreateDBInstanceRequest withEngineVersion(String engineVersion)
The version number of the database engine to use.
The following are the database engines and major and minor versions that are available with Amazon RDS. Not every database engine is available for every AWS Region.
Amazon Aurora
Not applicable. The version number of the database engine to be used by the DB instance is managed by the DB cluster. For more information, see CreateDBCluster.
MariaDB
10.1.23
(supported in all AWS regions)
10.1.19
(supported in all AWS regions)
10.1.14
(supported in all regions except us-east-2)
10.0.31
(supported in all AWS regions)
10.0.28
(supported in all AWS regions)
10.0.24
(supported in all AWS regions)
10.0.17
(supported in all regions except us-east-2, ca-central-1, eu-west-2)
Microsoft SQL Server 2016
13.00.4422.0.v1
(supported for all editions, and all AWS regions)
13.00.2164.0.v1
(supported for all editions, and all AWS regions)
Microsoft SQL Server 2014
12.00.5546.0.v1
(supported for all editions, and all AWS regions)
12.00.5000.0.v1
(supported for all editions, and all AWS regions)
12.00.4422.0.v1
(supported for all editions except Enterprise Edition, and all AWS regions except
ca-central-1 and eu-west-2)
Microsoft SQL Server 2012
11.00.6594.0.v1
(supported for all editions, and all AWS regions)
11.00.6020.0.v1
(supported for all editions, and all AWS regions)
11.00.5058.0.v1
(supported for all editions, and all AWS regions except us-east-2, ca-central-1, and
eu-west-2)
11.00.2100.60.v1
(supported for all editions, and all AWS regions except us-east-2, ca-central-1,
and eu-west-2)
Microsoft SQL Server 2008 R2
10.50.6529.0.v1
(supported for all editions, and all AWS regions except us-east-2, ca-central-1, and
eu-west-2)
10.50.6000.34.v1
(supported for all editions, and all AWS regions except us-east-2, ca-central-1,
and eu-west-2)
10.50.2789.0.v1
(supported for all editions, and all AWS regions except us-east-2, ca-central-1, and
eu-west-2)
MySQL
5.7.19
(supported in all AWS regions)
5.7.17
(supported in all AWS regions)
5.7.16
(supported in all AWS regions)
5.7.11
(supported in all AWS regions)
5.6.37
(supported in all AWS regions)
5.6.35
(supported in all AWS regions)
5.6.34
(supported in all AWS regions)
5.6.29
(supported in all AWS regions)
5.6.27
(supported in all regions except us-east-2, ca-central-1, eu-west-2)
5.5.57
(supported in all AWS regions)
5.5.54
(supported in all AWS regions)
5.5.53
(supported in all AWS regions)
5.5.46
(supported in all AWS regions)
Oracle 12c
12.1.0.2.v9
(supported for EE in all AWS regions, and SE2 in all AWS regions except us-gov-west-1)
12.1.0.2.v8
(supported for EE in all AWS regions, and SE2 in all AWS regions except us-gov-west-1)
12.1.0.2.v7
(supported for EE in all AWS regions, and SE2 in all AWS regions except us-gov-west-1)
12.1.0.2.v6
(supported for EE in all AWS regions, and SE2 in all AWS regions except us-gov-west-1)
12.1.0.2.v5
(supported for EE in all AWS regions, and SE2 in all AWS regions except us-gov-west-1)
12.1.0.2.v4
(supported for EE in all AWS regions, and SE2 in all AWS regions except us-gov-west-1)
12.1.0.2.v3
(supported for EE in all AWS regions, and SE2 in all AWS regions except us-gov-west-1)
12.1.0.2.v2
(supported for EE in all AWS regions, and SE2 in all AWS regions except us-gov-west-1)
12.1.0.2.v1
(supported for EE in all AWS regions, and SE2 in all AWS regions except us-gov-west-1)
Oracle 11g
11.2.0.4.v13
(supported for EE, SE1, and SE, in all AWS regions)
11.2.0.4.v12
(supported for EE, SE1, and SE, in all AWS regions)
11.2.0.4.v11
(supported for EE, SE1, and SE, in all AWS regions)
11.2.0.4.v10
(supported for EE, SE1, and SE, in all AWS regions)
11.2.0.4.v9
(supported for EE, SE1, and SE, in all AWS regions)
11.2.0.4.v8
(supported for EE, SE1, and SE, in all AWS regions)
11.2.0.4.v7
(supported for EE, SE1, and SE, in all AWS regions)
11.2.0.4.v6
(supported for EE, SE1, and SE, in all AWS regions)
11.2.0.4.v5
(supported for EE, SE1, and SE, in all AWS regions)
11.2.0.4.v4
(supported for EE, SE1, and SE, in all AWS regions)
11.2.0.4.v3
(supported for EE, SE1, and SE, in all AWS regions)
11.2.0.4.v1
(supported for EE, SE1, and SE, in all AWS regions)
PostgreSQL
Version 9.6.x: 9.6.5 | 9.6.3 | 9.6.2 | 9.6.1
Version 9.5.x: 9.5.9 | 9.5.7 | 9.5.6 | 9.5.4 | 9.5.2
Version 9.4.x: 9.4.14 | 9.4.12 | 9.4.11 | 9.4.9 | 9.4.7
Version 9.3.x: 9.3.19 | 9.3.17 | 9.3.16 | 9.3.14 | 9.3.12
engineVersion
- The version number of the database engine to use.
The following are the database engines and major and minor versions that are available with Amazon RDS. Not every database engine is available for every AWS Region.
Amazon Aurora
Not applicable. The version number of the database engine to be used by the DB instance is managed by the DB cluster. For more information, see CreateDBCluster.
MariaDB
10.1.23
(supported in all AWS regions)
10.1.19
(supported in all AWS regions)
10.1.14
(supported in all regions except us-east-2)
10.0.31
(supported in all AWS regions)
10.0.28
(supported in all AWS regions)
10.0.24
(supported in all AWS regions)
10.0.17
(supported in all regions except us-east-2, ca-central-1, eu-west-2)
Microsoft SQL Server 2016
13.00.4422.0.v1
(supported for all editions, and all AWS regions)
13.00.2164.0.v1
(supported for all editions, and all AWS regions)
Microsoft SQL Server 2014
12.00.5546.0.v1
(supported for all editions, and all AWS regions)
12.00.5000.0.v1
(supported for all editions, and all AWS regions)
12.00.4422.0.v1
(supported for all editions except Enterprise Edition, and all AWS regions
except ca-central-1 and eu-west-2)
Microsoft SQL Server 2012
11.00.6594.0.v1
(supported for all editions, and all AWS regions)
11.00.6020.0.v1
(supported for all editions, and all AWS regions)
11.00.5058.0.v1
(supported for all editions, and all AWS regions except us-east-2,
ca-central-1, and eu-west-2)
11.00.2100.60.v1
(supported for all editions, and all AWS regions except us-east-2,
ca-central-1, and eu-west-2)
Microsoft SQL Server 2008 R2
10.50.6529.0.v1
(supported for all editions, and all AWS regions except us-east-2,
ca-central-1, and eu-west-2)
10.50.6000.34.v1
(supported for all editions, and all AWS regions except us-east-2,
ca-central-1, and eu-west-2)
10.50.2789.0.v1
(supported for all editions, and all AWS regions except us-east-2,
ca-central-1, and eu-west-2)
MySQL
5.7.19
(supported in all AWS regions)
5.7.17
(supported in all AWS regions)
5.7.16
(supported in all AWS regions)
5.7.11
(supported in all AWS regions)
5.6.37
(supported in all AWS regions)
5.6.35
(supported in all AWS regions)
5.6.34
(supported in all AWS regions)
5.6.29
(supported in all AWS regions)
5.6.27
(supported in all regions except us-east-2, ca-central-1, eu-west-2)
5.5.57
(supported in all AWS regions)
5.5.54
(supported in all AWS regions)
5.5.53
(supported in all AWS regions)
5.5.46
(supported in all AWS regions)
Oracle 12c
12.1.0.2.v9
(supported for EE in all AWS regions, and SE2 in all AWS regions except
us-gov-west-1)
12.1.0.2.v8
(supported for EE in all AWS regions, and SE2 in all AWS regions except
us-gov-west-1)
12.1.0.2.v7
(supported for EE in all AWS regions, and SE2 in all AWS regions except
us-gov-west-1)
12.1.0.2.v6
(supported for EE in all AWS regions, and SE2 in all AWS regions except
us-gov-west-1)
12.1.0.2.v5
(supported for EE in all AWS regions, and SE2 in all AWS regions except
us-gov-west-1)
12.1.0.2.v4
(supported for EE in all AWS regions, and SE2 in all AWS regions except
us-gov-west-1)
12.1.0.2.v3
(supported for EE in all AWS regions, and SE2 in all AWS regions except
us-gov-west-1)
12.1.0.2.v2
(supported for EE in all AWS regions, and SE2 in all AWS regions except
us-gov-west-1)
12.1.0.2.v1
(supported for EE in all AWS regions, and SE2 in all AWS regions except
us-gov-west-1)
Oracle 11g
11.2.0.4.v13
(supported for EE, SE1, and SE, in all AWS regions)
11.2.0.4.v12
(supported for EE, SE1, and SE, in all AWS regions)
11.2.0.4.v11
(supported for EE, SE1, and SE, in all AWS regions)
11.2.0.4.v10
(supported for EE, SE1, and SE, in all AWS regions)
11.2.0.4.v9
(supported for EE, SE1, and SE, in all AWS regions)
11.2.0.4.v8
(supported for EE, SE1, and SE, in all AWS regions)
11.2.0.4.v7
(supported for EE, SE1, and SE, in all AWS regions)
11.2.0.4.v6
(supported for EE, SE1, and SE, in all AWS regions)
11.2.0.4.v5
(supported for EE, SE1, and SE, in all AWS regions)
11.2.0.4.v4
(supported for EE, SE1, and SE, in all AWS regions)
11.2.0.4.v3
(supported for EE, SE1, and SE, in all AWS regions)
11.2.0.4.v1
(supported for EE, SE1, and SE, in all AWS regions)
PostgreSQL
Version 9.6.x: 9.6.5 | 9.6.3 | 9.6.2 | 9.6.1
Version 9.5.x: 9.5.9 | 9.5.7 | 9.5.6 | 9.5.4 | 9.5.2
Version 9.4.x: 9.4.14 | 9.4.12 | 9.4.11 | 9.4.9 | 9.4.7
Version 9.3.x: 9.3.19 | 9.3.17 | 9.3.16 | 9.3.14 | 9.3.12
public void setAutoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade)
Indicates that minor engine upgrades are applied automatically to the DB instance during the maintenance window.
Default: true
autoMinorVersionUpgrade
- Indicates that minor engine upgrades are applied automatically to the DB instance during the maintenance
window.
Default: true
public Boolean getAutoMinorVersionUpgrade()
Indicates that minor engine upgrades are applied automatically to the DB instance during the maintenance window.
Default: true
Default: true
public CreateDBInstanceRequest withAutoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade)
Indicates that minor engine upgrades are applied automatically to the DB instance during the maintenance window.
Default: true
autoMinorVersionUpgrade
- Indicates that minor engine upgrades are applied automatically to the DB instance during the maintenance
window.
Default: true
public Boolean isAutoMinorVersionUpgrade()
Indicates that minor engine upgrades are applied automatically to the DB instance during the maintenance window.
Default: true
Default: true
public void setLicenseModel(String licenseModel)
License model information for this DB instance.
Valid values: license-included
| bring-your-own-license
|
general-public-license
licenseModel
- License model information for this DB instance.
Valid values: license-included
| bring-your-own-license
|
general-public-license
public String getLicenseModel()
License model information for this DB instance.
Valid values: license-included
| bring-your-own-license
|
general-public-license
Valid values: license-included
| bring-your-own-license
|
general-public-license
public CreateDBInstanceRequest withLicenseModel(String licenseModel)
License model information for this DB instance.
Valid values: license-included
| bring-your-own-license
|
general-public-license
licenseModel
- License model information for this DB instance.
Valid values: license-included
| bring-your-own-license
|
general-public-license
public void setIops(Integer iops)
The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB instance.
Constraints: Must be a multiple between 3 and 10 of the storage amount for the DB instance. Must also be an
integer multiple of 1000. For example, if the size of your DB instance is 500 GB, then your Iops
value can be 2000, 3000, 4000, or 5000.
iops
- The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB
instance.
Constraints: Must be a multiple between 3 and 10 of the storage amount for the DB instance. Must also be
an integer multiple of 1000. For example, if the size of your DB instance is 500 GB, then your
Iops
value can be 2000, 3000, 4000, or 5000.
public Integer getIops()
The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB instance.
Constraints: Must be a multiple between 3 and 10 of the storage amount for the DB instance. Must also be an
integer multiple of 1000. For example, if the size of your DB instance is 500 GB, then your Iops
value can be 2000, 3000, 4000, or 5000.
Constraints: Must be a multiple between 3 and 10 of the storage amount for the DB instance. Must also be
an integer multiple of 1000. For example, if the size of your DB instance is 500 GB, then your
Iops
value can be 2000, 3000, 4000, or 5000.
public CreateDBInstanceRequest withIops(Integer iops)
The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB instance.
Constraints: Must be a multiple between 3 and 10 of the storage amount for the DB instance. Must also be an
integer multiple of 1000. For example, if the size of your DB instance is 500 GB, then your Iops
value can be 2000, 3000, 4000, or 5000.
iops
- The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB
instance.
Constraints: Must be a multiple between 3 and 10 of the storage amount for the DB instance. Must also be
an integer multiple of 1000. For example, if the size of your DB instance is 500 GB, then your
Iops
value can be 2000, 3000, 4000, or 5000.
public void setOptionGroupName(String optionGroupName)
Indicates that the DB instance should be associated with the specified option group.
Permanent options, such as the TDE option for Oracle Advanced Security TDE, cannot be removed from an option group, and that option group cannot be removed from a DB instance once it is associated with a DB instance
optionGroupName
- Indicates that the DB instance should be associated with the specified option group.
Permanent options, such as the TDE option for Oracle Advanced Security TDE, cannot be removed from an option group, and that option group cannot be removed from a DB instance once it is associated with a DB instance
public String getOptionGroupName()
Indicates that the DB instance should be associated with the specified option group.
Permanent options, such as the TDE option for Oracle Advanced Security TDE, cannot be removed from an option group, and that option group cannot be removed from a DB instance once it is associated with a DB instance
Permanent options, such as the TDE option for Oracle Advanced Security TDE, cannot be removed from an option group, and that option group cannot be removed from a DB instance once it is associated with a DB instance
public CreateDBInstanceRequest withOptionGroupName(String optionGroupName)
Indicates that the DB instance should be associated with the specified option group.
Permanent options, such as the TDE option for Oracle Advanced Security TDE, cannot be removed from an option group, and that option group cannot be removed from a DB instance once it is associated with a DB instance
optionGroupName
- Indicates that the DB instance should be associated with the specified option group.
Permanent options, such as the TDE option for Oracle Advanced Security TDE, cannot be removed from an option group, and that option group cannot be removed from a DB instance once it is associated with a DB instance
public void setCharacterSetName(String characterSetName)
For supported engines, indicates that the DB instance should be associated with the specified CharacterSet.
Amazon Aurora
Not applicable. The character set is managed by the DB cluster. For more information, see CreateDBCluster.
characterSetName
- For supported engines, indicates that the DB instance should be associated with the specified
CharacterSet.
Amazon Aurora
Not applicable. The character set is managed by the DB cluster. For more information, see CreateDBCluster.
public String getCharacterSetName()
For supported engines, indicates that the DB instance should be associated with the specified CharacterSet.
Amazon Aurora
Not applicable. The character set is managed by the DB cluster. For more information, see CreateDBCluster.
Amazon Aurora
Not applicable. The character set is managed by the DB cluster. For more information, see CreateDBCluster.
public CreateDBInstanceRequest withCharacterSetName(String characterSetName)
For supported engines, indicates that the DB instance should be associated with the specified CharacterSet.
Amazon Aurora
Not applicable. The character set is managed by the DB cluster. For more information, see CreateDBCluster.
characterSetName
- For supported engines, indicates that the DB instance should be associated with the specified
CharacterSet.
Amazon Aurora
Not applicable. The character set is managed by the DB cluster. For more information, see CreateDBCluster.
public void setPubliclyAccessible(Boolean publiclyAccessible)
Specifies the accessibility options for the DB instance. A value of true specifies an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address. A value of false specifies an internal instance with a DNS name that resolves to a private IP address.
Default: The default behavior varies depending on whether a VPC has been requested or not. The following list shows the default behavior in each case.
Default VPC: true
VPC: false
If no DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance is publicly accessible. If a specific DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance is private.
publiclyAccessible
- Specifies the accessibility options for the DB instance. A value of true specifies an Internet-facing
instance with a publicly resolvable DNS name, which resolves to a public IP address. A value of false
specifies an internal instance with a DNS name that resolves to a private IP address.
Default: The default behavior varies depending on whether a VPC has been requested or not. The following list shows the default behavior in each case.
Default VPC: true
VPC: false
If no DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance is publicly accessible. If a specific DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance is private.
public Boolean getPubliclyAccessible()
Specifies the accessibility options for the DB instance. A value of true specifies an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address. A value of false specifies an internal instance with a DNS name that resolves to a private IP address.
Default: The default behavior varies depending on whether a VPC has been requested or not. The following list shows the default behavior in each case.
Default VPC: true
VPC: false
If no DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance is publicly accessible. If a specific DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance is private.
Default: The default behavior varies depending on whether a VPC has been requested or not. The following list shows the default behavior in each case.
Default VPC: true
VPC: false
If no DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance is publicly accessible. If a specific DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance is private.
public CreateDBInstanceRequest withPubliclyAccessible(Boolean publiclyAccessible)
Specifies the accessibility options for the DB instance. A value of true specifies an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address. A value of false specifies an internal instance with a DNS name that resolves to a private IP address.
Default: The default behavior varies depending on whether a VPC has been requested or not. The following list shows the default behavior in each case.
Default VPC: true
VPC: false
If no DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance is publicly accessible. If a specific DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance is private.
publiclyAccessible
- Specifies the accessibility options for the DB instance. A value of true specifies an Internet-facing
instance with a publicly resolvable DNS name, which resolves to a public IP address. A value of false
specifies an internal instance with a DNS name that resolves to a private IP address.
Default: The default behavior varies depending on whether a VPC has been requested or not. The following list shows the default behavior in each case.
Default VPC: true
VPC: false
If no DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance is publicly accessible. If a specific DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance is private.
public Boolean isPubliclyAccessible()
Specifies the accessibility options for the DB instance. A value of true specifies an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address. A value of false specifies an internal instance with a DNS name that resolves to a private IP address.
Default: The default behavior varies depending on whether a VPC has been requested or not. The following list shows the default behavior in each case.
Default VPC: true
VPC: false
If no DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance is publicly accessible. If a specific DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance is private.
Default: The default behavior varies depending on whether a VPC has been requested or not. The following list shows the default behavior in each case.
Default VPC: true
VPC: false
If no DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance is publicly accessible. If a specific DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance is private.
public void setTags(Collection<Tag> tags)
tags
- public CreateDBInstanceRequest withTags(Tag... tags)
NOTE: This method appends the values to the existing list (if any). Use
setTags(java.util.Collection)
or withTags(java.util.Collection)
if you want to override the
existing values.
tags
- public CreateDBInstanceRequest withTags(Collection<Tag> tags)
tags
- public void setDBClusterIdentifier(String dBClusterIdentifier)
The identifier of the DB cluster that the instance will belong to.
For information on creating a DB cluster, see CreateDBCluster.
Type: String
dBClusterIdentifier
- The identifier of the DB cluster that the instance will belong to.
For information on creating a DB cluster, see CreateDBCluster.
Type: String
public String getDBClusterIdentifier()
The identifier of the DB cluster that the instance will belong to.
For information on creating a DB cluster, see CreateDBCluster.
Type: String
For information on creating a DB cluster, see CreateDBCluster.
Type: String
public CreateDBInstanceRequest withDBClusterIdentifier(String dBClusterIdentifier)
The identifier of the DB cluster that the instance will belong to.
For information on creating a DB cluster, see CreateDBCluster.
Type: String
dBClusterIdentifier
- The identifier of the DB cluster that the instance will belong to.
For information on creating a DB cluster, see CreateDBCluster.
Type: String
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 CreateDBInstanceRequest 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 setTdeCredentialArn(String tdeCredentialArn)
The ARN from the Key Store with which to associate the instance for TDE encryption.
tdeCredentialArn
- The ARN from the Key Store with which to associate the instance for TDE encryption.public String getTdeCredentialArn()
The ARN from the Key Store with which to associate the instance for TDE encryption.
public CreateDBInstanceRequest withTdeCredentialArn(String tdeCredentialArn)
The ARN from the Key Store with which to associate the instance for TDE encryption.
tdeCredentialArn
- The ARN from the Key Store with which to associate the instance for TDE encryption.public void setTdeCredentialPassword(String tdeCredentialPassword)
The password for the given ARN from the Key Store in order to access the device.
tdeCredentialPassword
- The password for the given ARN from the Key Store in order to access the device.public String getTdeCredentialPassword()
The password for the given ARN from the Key Store in order to access the device.
public CreateDBInstanceRequest withTdeCredentialPassword(String tdeCredentialPassword)
The password for the given ARN from the Key Store in order to access the device.
tdeCredentialPassword
- The password for the given ARN from the Key Store in order to access the device.public void setStorageEncrypted(Boolean storageEncrypted)
Specifies whether the DB instance is encrypted.
Amazon Aurora
Not applicable. The encryption for DB instances is managed by the DB cluster. For more information, see CreateDBCluster.
Default: false
storageEncrypted
- Specifies whether the DB instance is encrypted.
Amazon Aurora
Not applicable. The encryption for DB instances is managed by the DB cluster. For more information, see CreateDBCluster.
Default: false
public Boolean getStorageEncrypted()
Specifies whether the DB instance is encrypted.
Amazon Aurora
Not applicable. The encryption for DB instances is managed by the DB cluster. For more information, see CreateDBCluster.
Default: false
Amazon Aurora
Not applicable. The encryption for DB instances is managed by the DB cluster. For more information, see CreateDBCluster.
Default: false
public CreateDBInstanceRequest withStorageEncrypted(Boolean storageEncrypted)
Specifies whether the DB instance is encrypted.
Amazon Aurora
Not applicable. The encryption for DB instances is managed by the DB cluster. For more information, see CreateDBCluster.
Default: false
storageEncrypted
- Specifies whether the DB instance is encrypted.
Amazon Aurora
Not applicable. The encryption for DB instances is managed by the DB cluster. For more information, see CreateDBCluster.
Default: false
public Boolean isStorageEncrypted()
Specifies whether the DB instance is encrypted.
Amazon Aurora
Not applicable. The encryption for DB instances is managed by the DB cluster. For more information, see CreateDBCluster.
Default: false
Amazon Aurora
Not applicable. The encryption for DB instances is managed by the DB cluster. For more information, see CreateDBCluster.
Default: false
public void setKmsKeyId(String kmsKeyId)
The 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.
Amazon Aurora
Not applicable. The KMS key identifier is managed by the DB cluster. For more information, see CreateDBCluster.
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 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.
Amazon Aurora
Not applicable. The KMS key identifier is managed by the DB cluster. For more information, see CreateDBCluster.
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 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.
Amazon Aurora
Not applicable. The KMS key identifier is managed by the DB cluster. For more information, see CreateDBCluster.
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.
Amazon Aurora
Not applicable. The KMS key identifier is managed by the DB cluster. For more information, see CreateDBCluster.
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 CreateDBInstanceRequest withKmsKeyId(String kmsKeyId)
The 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.
Amazon Aurora
Not applicable. The KMS key identifier is managed by the DB cluster. For more information, see CreateDBCluster.
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 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.
Amazon Aurora
Not applicable. The KMS key identifier is managed by the DB cluster. For more information, see CreateDBCluster.
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 setDomain(String domain)
Specify the Active Directory Domain to create the instance in.
domain
- Specify the Active Directory Domain to create the instance in.public String getDomain()
Specify the Active Directory Domain to create the instance in.
public CreateDBInstanceRequest withDomain(String domain)
Specify the Active Directory Domain to create the instance in.
domain
- Specify the Active Directory Domain to create the instance in.public void setCopyTagsToSnapshot(Boolean copyTagsToSnapshot)
True to copy all tags from the DB instance to snapshots of the DB instance; otherwise false. The default is false.
copyTagsToSnapshot
- True to copy all tags from the DB instance to snapshots of the DB instance; otherwise false. The default
is false.public Boolean getCopyTagsToSnapshot()
True to copy all tags from the DB instance to snapshots of the DB instance; otherwise false. The default is false.
public CreateDBInstanceRequest withCopyTagsToSnapshot(Boolean copyTagsToSnapshot)
True to copy all tags from the DB instance to snapshots of the DB instance; otherwise false. The default is false.
copyTagsToSnapshot
- True to copy all tags from the DB instance to snapshots of the DB instance; otherwise false. The default
is false.public Boolean isCopyTagsToSnapshot()
True to copy all tags from the DB instance to snapshots of the DB instance; otherwise false. The default is 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. The default is 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
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. The default is 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
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. The default is 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
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
public CreateDBInstanceRequest 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. The default is 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
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. The default is 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
public void setMonitoringRoleArn(String monitoringRoleArn)
The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to CloudWatch Logs. For example,
arn:aws:iam:123456789012:role/emaccess
. For information on creating a monitoring role, go to
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 CloudWatch Logs. For
example, arn:aws:iam:123456789012:role/emaccess
. For information on creating a monitoring
role, go to 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 CloudWatch Logs. For example,
arn:aws:iam:123456789012:role/emaccess
. For information on creating a monitoring role, go to
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, go to Setting Up and Enabling Enhanced Monitoring.
If MonitoringInterval
is set to a value other than 0, then you must supply a
MonitoringRoleArn
value.
public CreateDBInstanceRequest withMonitoringRoleArn(String monitoringRoleArn)
The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to CloudWatch Logs. For example,
arn:aws:iam:123456789012:role/emaccess
. For information on creating a monitoring role, go to
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 CloudWatch Logs. For
example, arn:aws:iam:123456789012:role/emaccess
. For information on creating a monitoring
role, go to 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 setDomainIAMRoleName(String domainIAMRoleName)
Specify the name of the IAM role to be used when making API calls to the Directory Service.
domainIAMRoleName
- Specify the name of the IAM role to be used when making API calls to the Directory Service.public String getDomainIAMRoleName()
Specify the name of the IAM role to be used when making API calls to the Directory Service.
public CreateDBInstanceRequest withDomainIAMRoleName(String domainIAMRoleName)
Specify the name of the IAM role to be used when making API calls to the Directory Service.
domainIAMRoleName
- Specify the name of the IAM role to be used when making API calls to the Directory Service.public void setPromotionTier(Integer promotionTier)
A value that specifies the order in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance. For more information, see Fault Tolerance for an Aurora DB Cluster.
Default: 1
Valid Values: 0 - 15
promotionTier
- A value that specifies the order in which an Aurora Replica is promoted to the primary instance after a
failure of the existing primary instance. For more information, see Fault Tolerance for an Aurora DB Cluster.
Default: 1
Valid Values: 0 - 15
public Integer getPromotionTier()
A value that specifies the order in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance. For more information, see Fault Tolerance for an Aurora DB Cluster.
Default: 1
Valid Values: 0 - 15
Default: 1
Valid Values: 0 - 15
public CreateDBInstanceRequest withPromotionTier(Integer promotionTier)
A value that specifies the order in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance. For more information, see Fault Tolerance for an Aurora DB Cluster.
Default: 1
Valid Values: 0 - 15
promotionTier
- A value that specifies the order in which an Aurora Replica is promoted to the primary instance after a
failure of the existing primary instance. For more information, see Fault Tolerance for an Aurora DB Cluster.
Default: 1
Valid Values: 0 - 15
public void setTimezone(String timezone)
The time zone of the DB instance. The time zone parameter is currently supported only by Microsoft SQL Server.
timezone
- The time zone of the DB instance. The time zone parameter is currently supported only by Microsoft SQL Server.public String getTimezone()
The time zone of the DB instance. The time zone parameter is currently supported only by Microsoft SQL Server.
public CreateDBInstanceRequest withTimezone(String timezone)
The time zone of the DB instance. The time zone parameter is currently supported only by Microsoft SQL Server.
timezone
- The time zone of the DB instance. The time zone parameter is currently supported only by Microsoft SQL Server.public void setEnableIAMDatabaseAuthentication(Boolean enableIAMDatabaseAuthentication)
True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts; otherwise false.
You can enable IAM database authentication for the following database engines:
Amazon Aurora
Not applicable. Mapping AWS IAM accounts to database accounts is managed by the DB cluster. For more information, see CreateDBCluster.
MySQL
For MySQL 5.6, minor version 5.6.34 or higher
For MySQL 5.7, minor version 5.7.16 or higher
Default: false
enableIAMDatabaseAuthentication
- True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts;
otherwise false.
You can enable IAM database authentication for the following database engines:
Amazon Aurora
Not applicable. Mapping AWS IAM accounts to database accounts is managed by the DB cluster. For more information, see CreateDBCluster.
MySQL
For MySQL 5.6, minor version 5.6.34 or higher
For MySQL 5.7, minor version 5.7.16 or higher
Default: false
public Boolean getEnableIAMDatabaseAuthentication()
True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts; otherwise false.
You can enable IAM database authentication for the following database engines:
Amazon Aurora
Not applicable. Mapping AWS IAM accounts to database accounts is managed by the DB cluster. For more information, see CreateDBCluster.
MySQL
For MySQL 5.6, minor version 5.6.34 or higher
For MySQL 5.7, minor version 5.7.16 or higher
Default: false
You can enable IAM database authentication for the following database engines:
Amazon Aurora
Not applicable. Mapping AWS IAM accounts to database accounts is managed by the DB cluster. For more information, see CreateDBCluster.
MySQL
For MySQL 5.6, minor version 5.6.34 or higher
For MySQL 5.7, minor version 5.7.16 or higher
Default: false
public CreateDBInstanceRequest withEnableIAMDatabaseAuthentication(Boolean enableIAMDatabaseAuthentication)
True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts; otherwise false.
You can enable IAM database authentication for the following database engines:
Amazon Aurora
Not applicable. Mapping AWS IAM accounts to database accounts is managed by the DB cluster. For more information, see CreateDBCluster.
MySQL
For MySQL 5.6, minor version 5.6.34 or higher
For MySQL 5.7, minor version 5.7.16 or higher
Default: false
enableIAMDatabaseAuthentication
- True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts;
otherwise false.
You can enable IAM database authentication for the following database engines:
Amazon Aurora
Not applicable. Mapping AWS IAM accounts to database accounts is managed by the DB cluster. For more information, see CreateDBCluster.
MySQL
For MySQL 5.6, minor version 5.6.34 or higher
For MySQL 5.7, minor version 5.7.16 or higher
Default: false
public Boolean isEnableIAMDatabaseAuthentication()
True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts; otherwise false.
You can enable IAM database authentication for the following database engines:
Amazon Aurora
Not applicable. Mapping AWS IAM accounts to database accounts is managed by the DB cluster. For more information, see CreateDBCluster.
MySQL
For MySQL 5.6, minor version 5.6.34 or higher
For MySQL 5.7, minor version 5.7.16 or higher
Default: false
You can enable IAM database authentication for the following database engines:
Amazon Aurora
Not applicable. Mapping AWS IAM accounts to database accounts is managed by the DB cluster. For more information, see CreateDBCluster.
MySQL
For MySQL 5.6, minor version 5.6.34 or higher
For MySQL 5.7, minor version 5.7.16 or higher
Default: false
public void setEnablePerformanceInsights(Boolean enablePerformanceInsights)
True to enable Performance Insights for the DB instance; otherwise false.
enablePerformanceInsights
- True to enable Performance Insights for the DB instance; otherwise false.public Boolean getEnablePerformanceInsights()
True to enable Performance Insights for the DB instance; otherwise false.
public CreateDBInstanceRequest withEnablePerformanceInsights(Boolean enablePerformanceInsights)
True to enable Performance Insights for the DB instance; otherwise false.
enablePerformanceInsights
- True to enable Performance Insights for the DB instance; otherwise false.public Boolean isEnablePerformanceInsights()
True to enable Performance Insights for the DB instance; otherwise false.
public void setPerformanceInsightsKMSKeyId(String performanceInsightsKMSKeyId)
The KMS key identifier for encryption of Performance Insights data. The KMS key ID is the Amazon Resource Name (ARN), KMS key identifier, or the KMS key alias for the KMS encryption key.
performanceInsightsKMSKeyId
- The KMS key identifier for encryption of Performance Insights data. The KMS key ID is the Amazon Resource
Name (ARN), KMS key identifier, or the KMS key alias for the KMS encryption key.public String getPerformanceInsightsKMSKeyId()
The KMS key identifier for encryption of Performance Insights data. The KMS key ID is the Amazon Resource Name (ARN), KMS key identifier, or the KMS key alias for the KMS encryption key.
public CreateDBInstanceRequest withPerformanceInsightsKMSKeyId(String performanceInsightsKMSKeyId)
The KMS key identifier for encryption of Performance Insights data. The KMS key ID is the Amazon Resource Name (ARN), KMS key identifier, or the KMS key alias for the KMS encryption key.
performanceInsightsKMSKeyId
- The KMS key identifier for encryption of Performance Insights data. The KMS key ID is the Amazon Resource
Name (ARN), KMS key identifier, or the KMS key alias for the KMS encryption key.public String toString()
toString
in class Object
Object.toString()
public CreateDBInstanceRequest clone()
AmazonWebServiceRequest
clone
in class AmazonWebServiceRequest
Object.clone()
Copyright © 2013 Amazon Web Services, Inc. All Rights Reserved.