Class CreateDBInstanceRequest
- java.lang.Object
-
- com.amazonaws.AmazonWebServiceRequest
-
- com.amazonaws.services.rds.model.CreateDBInstanceRequest
-
- All Implemented Interfaces:
ReadLimitInfo
,Serializable
,Cloneable
public class CreateDBInstanceRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
- See Also:
- Serialized Form
-
-
Field Summary
-
Fields inherited from class com.amazonaws.AmazonWebServiceRequest
NOOP
-
-
Constructor Summary
Constructors Constructor 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.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description CreateDBInstanceRequest
clone()
Creates a shallow clone of this request.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 will be applied automatically to the DB instance during the maintenance window.String
getAvailabilityZone()
The EC2 Availability Zone that the database instance will be 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.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.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 of master user for the client DB instance.String
getMasterUserPassword()
The password for the master database 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.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 theBackupRetentionPeriod
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.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 will be 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
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 will be applied automatically to the DB instance during the maintenance window.void
setAvailabilityZone(String availabilityZone)
The EC2 Availability Zone that the database instance will be 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.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
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 of master user for the client DB instance.void
setMasterUserPassword(String masterUserPassword)
The password for the master database 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
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 theBackupRetentionPeriod
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
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 will be applied automatically to the DB instance during the maintenance window.CreateDBInstanceRequest
withAvailabilityZone(String availabilityZone)
The EC2 Availability Zone that the database instance will be 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.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(String... dBSecurityGroups)
A list of DB security groups to associate with this DB instance.CreateDBInstanceRequest
withDBSecurityGroups(Collection<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
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 of master user for the client DB instance.CreateDBInstanceRequest
withMasterUserPassword(String masterUserPassword)
The password for the master database 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
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 theBackupRetentionPeriod
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(Tag... tags)
NOTE: This method appends the values to the existing list (if any).CreateDBInstanceRequest
withTags(Collection<Tag> tags)
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
withVpcSecurityGroupIds(String... vpcSecurityGroupIds)
A list of EC2 VPC security groups to associate with this DB instance.CreateDBInstanceRequest
withVpcSecurityGroupIds(Collection<String> vpcSecurityGroupIds)
A list of EC2 VPC security groups to associate with this DB instance.-
Methods inherited from class com.amazonaws.AmazonWebServiceRequest
copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout
-
-
-
-
Constructor Detail
-
CreateDBInstanceRequest
public CreateDBInstanceRequest()
Default constructor for CreateDBInstanceRequest object. Callers should use the setter or fluent setter (with...) methods to initialize the object after creating it.
-
CreateDBInstanceRequest
public CreateDBInstanceRequest(String dBInstanceIdentifier, Integer allocatedStorage, String dBInstanceClass, String engine, String masterUsername, String masterUserPassword)
Constructs a new CreateDBInstanceRequest object. Callers should use the setter or fluent setter (with...) methods to initialize any additional object members.- Parameters:
dBInstanceIdentifier
- The DB instance identifier. This parameter is stored as a lowercase string.Constraints:
- Must contain from 1 to 63 alphanumeric characters or hyphens (1 to 15 for SQL Server).
- 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
MySQL
Constraints: Must be an integer from 5 to 6144.
MariaDB
Constraints: Must be an integer from 5 to 6144.
PostgreSQL
Constraints: Must be an integer from 5 to 6144.
Oracle
Constraints: Must be an integer from 10 to 6144.
SQL Server
Constraints: Must be an integer from 200 to 4096 (Standard Edition and Enterprise Edition) or from 20 to 4096 (Express Edition and Web Edition)
dBInstanceClass
- The compute and memory capacity of the DB instance.Valid Values:
db.t1.micro | db.m1.small | db.m1.medium | db.m1.large | db.m1.xlarge | db.m2.xlarge |db.m2.2xlarge | db.m2.4xlarge | db.m3.medium | db.m3.large | db.m3.xlarge | db.m3.2xlarge | db.m4.large | db.m4.xlarge | db.m4.2xlarge | db.m4.4xlarge | db.m4.10xlarge | db.r3.large | db.r3.xlarge | db.r3.2xlarge | db.r3.4xlarge | db.r3.8xlarge | db.t2.micro | db.t2.small | db.t2.medium | db.t2.large
engine
- The name of the database engine to be used for this instance.Valid Values:
MySQL
|mariadb
|oracle-se1
|oracle-se
|oracle-ee
|sqlserver-ee
|sqlserver-se
|sqlserver-ex
|sqlserver-web
|postgres
|aurora
Not every database engine is available for every AWS region.
masterUsername
- The name of master user for the client DB instance.MySQL
Constraints:
- Must be 1 to 16 alphanumeric characters.
- First character must be a letter.
- Cannot be a reserved word for the chosen database engine.
MariaDB
Constraints:
- Must be 1 to 16 alphanumeric characters.
- Cannot be a reserved word for the chosen database engine.
Type: String
Oracle
Constraints:
- Must be 1 to 30 alphanumeric characters.
- First character must be a letter.
- Cannot be a reserved word for the chosen database engine.
SQL Server
Constraints:
- Must be 1 to 128 alphanumeric characters.
- First character must be a letter.
- Cannot be a reserved word for the chosen database engine.
PostgreSQL
Constraints:
- Must be 1 to 63 alphanumeric characters.
- First character must be a letter.
- Cannot be a reserved word for the chosen database engine.
masterUserPassword
- The password for the master database user. Can be any printable ASCII character except "/", """, or "@".Type: String
MySQL
Constraints: Must contain from 8 to 41 characters.
MariaDB
Constraints: Must contain from 8 to 41 characters.
Oracle
Constraints: Must contain from 8 to 30 characters.
SQL Server
Constraints: Must contain from 8 to 128 characters.
PostgreSQL
Constraints: Must contain from 8 to 128 characters.
Amazon Aurora
Constraints: Must contain from 8 to 41 characters.
-
-
Method Detail
-
setDBName
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 alphanumeric characters
- 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 alphanumeric characters
- 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 alphanumeric characters
- 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.
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 alphanumeric characters
- Cannot be a word reserved by the specified database engine
- Parameters:
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 alphanumeric characters
- 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 alphanumeric characters
- 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 alphanumeric characters
- 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.
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 alphanumeric characters
- Cannot be a word reserved by the specified database engine
-
getDBName
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 alphanumeric characters
- 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 alphanumeric characters
- 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 alphanumeric characters
- 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.
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 alphanumeric characters
- Cannot be a word reserved by the specified database engine
- Returns:
- 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 alphanumeric characters
- 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 alphanumeric characters
- 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 alphanumeric characters
- 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.
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 alphanumeric characters
- Cannot be a word reserved by the specified database engine
-
withDBName
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 alphanumeric characters
- 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 alphanumeric characters
- 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 alphanumeric characters
- 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.
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 alphanumeric characters
- Cannot be a word reserved by the specified database engine
- Parameters:
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 alphanumeric characters
- 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 alphanumeric characters
- 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 alphanumeric characters
- 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.
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 alphanumeric characters
- Cannot be a word reserved by the specified database engine
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setDBInstanceIdentifier
public void setDBInstanceIdentifier(String dBInstanceIdentifier)
The DB instance identifier. This parameter is stored as a lowercase string.
Constraints:
- Must contain from 1 to 63 alphanumeric characters or hyphens (1 to 15 for SQL Server).
- First character must be a letter.
- Cannot end with a hyphen or contain two consecutive hyphens.
Example:
mydbinstance
- Parameters:
dBInstanceIdentifier
- The DB instance identifier. This parameter is stored as a lowercase string.Constraints:
- Must contain from 1 to 63 alphanumeric characters or hyphens (1 to 15 for SQL Server).
- First character must be a letter.
- Cannot end with a hyphen or contain two consecutive hyphens.
Example:
mydbinstance
-
getDBInstanceIdentifier
public String getDBInstanceIdentifier()
The DB instance identifier. This parameter is stored as a lowercase string.
Constraints:
- Must contain from 1 to 63 alphanumeric characters or hyphens (1 to 15 for SQL Server).
- First character must be a letter.
- Cannot end with a hyphen or contain two consecutive hyphens.
Example:
mydbinstance
- Returns:
- The DB instance identifier. This parameter is stored as a
lowercase string.
Constraints:
- Must contain from 1 to 63 alphanumeric characters or hyphens (1 to 15 for SQL Server).
- First character must be a letter.
- Cannot end with a hyphen or contain two consecutive hyphens.
Example:
mydbinstance
-
withDBInstanceIdentifier
public CreateDBInstanceRequest withDBInstanceIdentifier(String dBInstanceIdentifier)
The DB instance identifier. This parameter is stored as a lowercase string.
Constraints:
- Must contain from 1 to 63 alphanumeric characters or hyphens (1 to 15 for SQL Server).
- First character must be a letter.
- Cannot end with a hyphen or contain two consecutive hyphens.
Example:
mydbinstance
- Parameters:
dBInstanceIdentifier
- The DB instance identifier. This parameter is stored as a lowercase string.Constraints:
- Must contain from 1 to 63 alphanumeric characters or hyphens (1 to 15 for SQL Server).
- First character must be a letter.
- Cannot end with a hyphen or contain two consecutive hyphens.
Example:
mydbinstance
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setAllocatedStorage
public void setAllocatedStorage(Integer allocatedStorage)
The amount of storage (in gigabytes) to be initially allocated for the database instance.
Type: Integer
MySQL
Constraints: Must be an integer from 5 to 6144.
MariaDB
Constraints: Must be an integer from 5 to 6144.
PostgreSQL
Constraints: Must be an integer from 5 to 6144.
Oracle
Constraints: Must be an integer from 10 to 6144.
SQL Server
Constraints: Must be an integer from 200 to 4096 (Standard Edition and Enterprise Edition) or from 20 to 4096 (Express Edition and Web Edition)
- Parameters:
allocatedStorage
- The amount of storage (in gigabytes) to be initially allocated for the database instance.Type: Integer
MySQL
Constraints: Must be an integer from 5 to 6144.
MariaDB
Constraints: Must be an integer from 5 to 6144.
PostgreSQL
Constraints: Must be an integer from 5 to 6144.
Oracle
Constraints: Must be an integer from 10 to 6144.
SQL Server
Constraints: Must be an integer from 200 to 4096 (Standard Edition and Enterprise Edition) or from 20 to 4096 (Express Edition and Web Edition)
-
getAllocatedStorage
public Integer getAllocatedStorage()
The amount of storage (in gigabytes) to be initially allocated for the database instance.
Type: Integer
MySQL
Constraints: Must be an integer from 5 to 6144.
MariaDB
Constraints: Must be an integer from 5 to 6144.
PostgreSQL
Constraints: Must be an integer from 5 to 6144.
Oracle
Constraints: Must be an integer from 10 to 6144.
SQL Server
Constraints: Must be an integer from 200 to 4096 (Standard Edition and Enterprise Edition) or from 20 to 4096 (Express Edition and Web Edition)
- Returns:
- The amount of storage (in gigabytes) to be initially allocated
for the database instance.
Type: Integer
MySQL
Constraints: Must be an integer from 5 to 6144.
MariaDB
Constraints: Must be an integer from 5 to 6144.
PostgreSQL
Constraints: Must be an integer from 5 to 6144.
Oracle
Constraints: Must be an integer from 10 to 6144.
SQL Server
Constraints: Must be an integer from 200 to 4096 (Standard Edition and Enterprise Edition) or from 20 to 4096 (Express Edition and Web Edition)
-
withAllocatedStorage
public CreateDBInstanceRequest withAllocatedStorage(Integer allocatedStorage)
The amount of storage (in gigabytes) to be initially allocated for the database instance.
Type: Integer
MySQL
Constraints: Must be an integer from 5 to 6144.
MariaDB
Constraints: Must be an integer from 5 to 6144.
PostgreSQL
Constraints: Must be an integer from 5 to 6144.
Oracle
Constraints: Must be an integer from 10 to 6144.
SQL Server
Constraints: Must be an integer from 200 to 4096 (Standard Edition and Enterprise Edition) or from 20 to 4096 (Express Edition and Web Edition)
- Parameters:
allocatedStorage
- The amount of storage (in gigabytes) to be initially allocated for the database instance.Type: Integer
MySQL
Constraints: Must be an integer from 5 to 6144.
MariaDB
Constraints: Must be an integer from 5 to 6144.
PostgreSQL
Constraints: Must be an integer from 5 to 6144.
Oracle
Constraints: Must be an integer from 10 to 6144.
SQL Server
Constraints: Must be an integer from 200 to 4096 (Standard Edition and Enterprise Edition) or from 20 to 4096 (Express Edition and Web Edition)
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setDBInstanceClass
public void setDBInstanceClass(String dBInstanceClass)
The compute and memory capacity of the DB instance.
Valid Values:
db.t1.micro | db.m1.small | db.m1.medium | db.m1.large | db.m1.xlarge | db.m2.xlarge |db.m2.2xlarge | db.m2.4xlarge | db.m3.medium | db.m3.large | db.m3.xlarge | db.m3.2xlarge | db.m4.large | db.m4.xlarge | db.m4.2xlarge | db.m4.4xlarge | db.m4.10xlarge | db.r3.large | db.r3.xlarge | db.r3.2xlarge | db.r3.4xlarge | db.r3.8xlarge | db.t2.micro | db.t2.small | db.t2.medium | db.t2.large
- Parameters:
dBInstanceClass
- The compute and memory capacity of the DB instance.Valid Values:
db.t1.micro | db.m1.small | db.m1.medium | db.m1.large | db.m1.xlarge | db.m2.xlarge |db.m2.2xlarge | db.m2.4xlarge | db.m3.medium | db.m3.large | db.m3.xlarge | db.m3.2xlarge | db.m4.large | db.m4.xlarge | db.m4.2xlarge | db.m4.4xlarge | db.m4.10xlarge | db.r3.large | db.r3.xlarge | db.r3.2xlarge | db.r3.4xlarge | db.r3.8xlarge | db.t2.micro | db.t2.small | db.t2.medium | db.t2.large
-
getDBInstanceClass
public String getDBInstanceClass()
The compute and memory capacity of the DB instance.
Valid Values:
db.t1.micro | db.m1.small | db.m1.medium | db.m1.large | db.m1.xlarge | db.m2.xlarge |db.m2.2xlarge | db.m2.4xlarge | db.m3.medium | db.m3.large | db.m3.xlarge | db.m3.2xlarge | db.m4.large | db.m4.xlarge | db.m4.2xlarge | db.m4.4xlarge | db.m4.10xlarge | db.r3.large | db.r3.xlarge | db.r3.2xlarge | db.r3.4xlarge | db.r3.8xlarge | db.t2.micro | db.t2.small | db.t2.medium | db.t2.large
- Returns:
- The compute and memory capacity of the DB instance.
Valid Values:
db.t1.micro | db.m1.small | db.m1.medium | db.m1.large | db.m1.xlarge | db.m2.xlarge |db.m2.2xlarge | db.m2.4xlarge | db.m3.medium | db.m3.large | db.m3.xlarge | db.m3.2xlarge | db.m4.large | db.m4.xlarge | db.m4.2xlarge | db.m4.4xlarge | db.m4.10xlarge | db.r3.large | db.r3.xlarge | db.r3.2xlarge | db.r3.4xlarge | db.r3.8xlarge | db.t2.micro | db.t2.small | db.t2.medium | db.t2.large
-
withDBInstanceClass
public CreateDBInstanceRequest withDBInstanceClass(String dBInstanceClass)
The compute and memory capacity of the DB instance.
Valid Values:
db.t1.micro | db.m1.small | db.m1.medium | db.m1.large | db.m1.xlarge | db.m2.xlarge |db.m2.2xlarge | db.m2.4xlarge | db.m3.medium | db.m3.large | db.m3.xlarge | db.m3.2xlarge | db.m4.large | db.m4.xlarge | db.m4.2xlarge | db.m4.4xlarge | db.m4.10xlarge | db.r3.large | db.r3.xlarge | db.r3.2xlarge | db.r3.4xlarge | db.r3.8xlarge | db.t2.micro | db.t2.small | db.t2.medium | db.t2.large
- Parameters:
dBInstanceClass
- The compute and memory capacity of the DB instance.Valid Values:
db.t1.micro | db.m1.small | db.m1.medium | db.m1.large | db.m1.xlarge | db.m2.xlarge |db.m2.2xlarge | db.m2.4xlarge | db.m3.medium | db.m3.large | db.m3.xlarge | db.m3.2xlarge | db.m4.large | db.m4.xlarge | db.m4.2xlarge | db.m4.4xlarge | db.m4.10xlarge | db.r3.large | db.r3.xlarge | db.r3.2xlarge | db.r3.4xlarge | db.r3.8xlarge | db.t2.micro | db.t2.small | db.t2.medium | db.t2.large
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setEngine
public void setEngine(String engine)
The name of the database engine to be used for this instance.
Valid Values:
MySQL
|mariadb
|oracle-se1
|oracle-se
|oracle-ee
|sqlserver-ee
|sqlserver-se
|sqlserver-ex
|sqlserver-web
|postgres
|aurora
Not every database engine is available for every AWS region.
- Parameters:
engine
- The name of the database engine to be used for this instance.Valid Values:
MySQL
|mariadb
|oracle-se1
|oracle-se
|oracle-ee
|sqlserver-ee
|sqlserver-se
|sqlserver-ex
|sqlserver-web
|postgres
|aurora
Not every database engine is available for every AWS region.
-
getEngine
public String getEngine()
The name of the database engine to be used for this instance.
Valid Values:
MySQL
|mariadb
|oracle-se1
|oracle-se
|oracle-ee
|sqlserver-ee
|sqlserver-se
|sqlserver-ex
|sqlserver-web
|postgres
|aurora
Not every database engine is available for every AWS region.
- Returns:
- The name of the database engine to be used for this instance.
Valid Values:
MySQL
|mariadb
|oracle-se1
|oracle-se
|oracle-ee
|sqlserver-ee
|sqlserver-se
|sqlserver-ex
|sqlserver-web
|postgres
|aurora
Not every database engine is available for every AWS region.
-
withEngine
public CreateDBInstanceRequest withEngine(String engine)
The name of the database engine to be used for this instance.
Valid Values:
MySQL
|mariadb
|oracle-se1
|oracle-se
|oracle-ee
|sqlserver-ee
|sqlserver-se
|sqlserver-ex
|sqlserver-web
|postgres
|aurora
Not every database engine is available for every AWS region.
- Parameters:
engine
- The name of the database engine to be used for this instance.Valid Values:
MySQL
|mariadb
|oracle-se1
|oracle-se
|oracle-ee
|sqlserver-ee
|sqlserver-se
|sqlserver-ex
|sqlserver-web
|postgres
|aurora
Not every database engine is available for every AWS region.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setMasterUsername
public void setMasterUsername(String masterUsername)
The name of master user for the client DB instance.
MySQL
Constraints:
- Must be 1 to 16 alphanumeric characters.
- First character must be a letter.
- Cannot be a reserved word for the chosen database engine.
MariaDB
Constraints:
- Must be 1 to 16 alphanumeric characters.
- Cannot be a reserved word for the chosen database engine.
Type: String
Oracle
Constraints:
- Must be 1 to 30 alphanumeric characters.
- First character must be a letter.
- Cannot be a reserved word for the chosen database engine.
SQL Server
Constraints:
- Must be 1 to 128 alphanumeric characters.
- First character must be a letter.
- Cannot be a reserved word for the chosen database engine.
PostgreSQL
Constraints:
- Must be 1 to 63 alphanumeric characters.
- First character must be a letter.
- Cannot be a reserved word for the chosen database engine.
- Parameters:
masterUsername
- The name of master user for the client DB instance.MySQL
Constraints:
- Must be 1 to 16 alphanumeric characters.
- First character must be a letter.
- Cannot be a reserved word for the chosen database engine.
MariaDB
Constraints:
- Must be 1 to 16 alphanumeric characters.
- Cannot be a reserved word for the chosen database engine.
Type: String
Oracle
Constraints:
- Must be 1 to 30 alphanumeric characters.
- First character must be a letter.
- Cannot be a reserved word for the chosen database engine.
SQL Server
Constraints:
- Must be 1 to 128 alphanumeric characters.
- First character must be a letter.
- Cannot be a reserved word for the chosen database engine.
PostgreSQL
Constraints:
- Must be 1 to 63 alphanumeric characters.
- First character must be a letter.
- Cannot be a reserved word for the chosen database engine.
-
getMasterUsername
public String getMasterUsername()
The name of master user for the client DB instance.
MySQL
Constraints:
- Must be 1 to 16 alphanumeric characters.
- First character must be a letter.
- Cannot be a reserved word for the chosen database engine.
MariaDB
Constraints:
- Must be 1 to 16 alphanumeric characters.
- Cannot be a reserved word for the chosen database engine.
Type: String
Oracle
Constraints:
- Must be 1 to 30 alphanumeric characters.
- First character must be a letter.
- Cannot be a reserved word for the chosen database engine.
SQL Server
Constraints:
- Must be 1 to 128 alphanumeric characters.
- First character must be a letter.
- Cannot be a reserved word for the chosen database engine.
PostgreSQL
Constraints:
- Must be 1 to 63 alphanumeric characters.
- First character must be a letter.
- Cannot be a reserved word for the chosen database engine.
- Returns:
- The name of master user for the client DB instance.
MySQL
Constraints:
- Must be 1 to 16 alphanumeric characters.
- First character must be a letter.
- Cannot be a reserved word for the chosen database engine.
MariaDB
Constraints:
- Must be 1 to 16 alphanumeric characters.
- Cannot be a reserved word for the chosen database engine.
Type: String
Oracle
Constraints:
- Must be 1 to 30 alphanumeric characters.
- First character must be a letter.
- Cannot be a reserved word for the chosen database engine.
SQL Server
Constraints:
- Must be 1 to 128 alphanumeric characters.
- First character must be a letter.
- Cannot be a reserved word for the chosen database engine.
PostgreSQL
Constraints:
- Must be 1 to 63 alphanumeric characters.
- First character must be a letter.
- Cannot be a reserved word for the chosen database engine.
-
withMasterUsername
public CreateDBInstanceRequest withMasterUsername(String masterUsername)
The name of master user for the client DB instance.
MySQL
Constraints:
- Must be 1 to 16 alphanumeric characters.
- First character must be a letter.
- Cannot be a reserved word for the chosen database engine.
MariaDB
Constraints:
- Must be 1 to 16 alphanumeric characters.
- Cannot be a reserved word for the chosen database engine.
Type: String
Oracle
Constraints:
- Must be 1 to 30 alphanumeric characters.
- First character must be a letter.
- Cannot be a reserved word for the chosen database engine.
SQL Server
Constraints:
- Must be 1 to 128 alphanumeric characters.
- First character must be a letter.
- Cannot be a reserved word for the chosen database engine.
PostgreSQL
Constraints:
- Must be 1 to 63 alphanumeric characters.
- First character must be a letter.
- Cannot be a reserved word for the chosen database engine.
- Parameters:
masterUsername
- The name of master user for the client DB instance.MySQL
Constraints:
- Must be 1 to 16 alphanumeric characters.
- First character must be a letter.
- Cannot be a reserved word for the chosen database engine.
MariaDB
Constraints:
- Must be 1 to 16 alphanumeric characters.
- Cannot be a reserved word for the chosen database engine.
Type: String
Oracle
Constraints:
- Must be 1 to 30 alphanumeric characters.
- First character must be a letter.
- Cannot be a reserved word for the chosen database engine.
SQL Server
Constraints:
- Must be 1 to 128 alphanumeric characters.
- First character must be a letter.
- Cannot be a reserved word for the chosen database engine.
PostgreSQL
Constraints:
- Must be 1 to 63 alphanumeric characters.
- First character must be a letter.
- Cannot be a reserved word for the chosen database engine.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setMasterUserPassword
public void setMasterUserPassword(String masterUserPassword)
The password for the master database user. Can be any printable ASCII character except "/", """, or "@".
Type: String
MySQL
Constraints: Must contain from 8 to 41 characters.
MariaDB
Constraints: Must contain from 8 to 41 characters.
Oracle
Constraints: Must contain from 8 to 30 characters.
SQL Server
Constraints: Must contain from 8 to 128 characters.
PostgreSQL
Constraints: Must contain from 8 to 128 characters.
Amazon Aurora
Constraints: Must contain from 8 to 41 characters.
- Parameters:
masterUserPassword
- The password for the master database user. Can be any printable ASCII character except "/", """, or "@".Type: String
MySQL
Constraints: Must contain from 8 to 41 characters.
MariaDB
Constraints: Must contain from 8 to 41 characters.
Oracle
Constraints: Must contain from 8 to 30 characters.
SQL Server
Constraints: Must contain from 8 to 128 characters.
PostgreSQL
Constraints: Must contain from 8 to 128 characters.
Amazon Aurora
Constraints: Must contain from 8 to 41 characters.
-
getMasterUserPassword
public String getMasterUserPassword()
The password for the master database user. Can be any printable ASCII character except "/", """, or "@".
Type: String
MySQL
Constraints: Must contain from 8 to 41 characters.
MariaDB
Constraints: Must contain from 8 to 41 characters.
Oracle
Constraints: Must contain from 8 to 30 characters.
SQL Server
Constraints: Must contain from 8 to 128 characters.
PostgreSQL
Constraints: Must contain from 8 to 128 characters.
Amazon Aurora
Constraints: Must contain from 8 to 41 characters.
- Returns:
- The password for the master database user. Can be any printable
ASCII character except "/", """, or "@".
Type: String
MySQL
Constraints: Must contain from 8 to 41 characters.
MariaDB
Constraints: Must contain from 8 to 41 characters.
Oracle
Constraints: Must contain from 8 to 30 characters.
SQL Server
Constraints: Must contain from 8 to 128 characters.
PostgreSQL
Constraints: Must contain from 8 to 128 characters.
Amazon Aurora
Constraints: Must contain from 8 to 41 characters.
-
withMasterUserPassword
public CreateDBInstanceRequest withMasterUserPassword(String masterUserPassword)
The password for the master database user. Can be any printable ASCII character except "/", """, or "@".
Type: String
MySQL
Constraints: Must contain from 8 to 41 characters.
MariaDB
Constraints: Must contain from 8 to 41 characters.
Oracle
Constraints: Must contain from 8 to 30 characters.
SQL Server
Constraints: Must contain from 8 to 128 characters.
PostgreSQL
Constraints: Must contain from 8 to 128 characters.
Amazon Aurora
Constraints: Must contain from 8 to 41 characters.
- Parameters:
masterUserPassword
- The password for the master database user. Can be any printable ASCII character except "/", """, or "@".Type: String
MySQL
Constraints: Must contain from 8 to 41 characters.
MariaDB
Constraints: Must contain from 8 to 41 characters.
Oracle
Constraints: Must contain from 8 to 30 characters.
SQL Server
Constraints: Must contain from 8 to 128 characters.
PostgreSQL
Constraints: Must contain from 8 to 128 characters.
Amazon Aurora
Constraints: Must contain from 8 to 41 characters.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
getDBSecurityGroups
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.
- Returns:
- A list of DB security groups to associate with this DB instance.
Default: The default DB security group for the database engine.
-
setDBSecurityGroups
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.
- Parameters:
dBSecurityGroups
- A list of DB security groups to associate with this DB instance.Default: The default DB security group for the database engine.
-
withDBSecurityGroups
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)
orwithDBSecurityGroups(java.util.Collection)
if you want to override the existing values.- Parameters:
dBSecurityGroups
- A list of DB security groups to associate with this DB instance.Default: The default DB security group for the database engine.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
withDBSecurityGroups
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.
- Parameters:
dBSecurityGroups
- A list of DB security groups to associate with this DB instance.Default: The default DB security group for the database engine.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
getVpcSecurityGroupIds
public List<String> getVpcSecurityGroupIds()
A list of EC2 VPC security groups to associate with this DB instance.
Default: The default EC2 VPC security group for the DB subnet group's VPC.
- Returns:
- A list of EC2 VPC security groups to associate with this DB
instance.
Default: The default EC2 VPC security group for the DB subnet group's VPC.
-
setVpcSecurityGroupIds
public void setVpcSecurityGroupIds(Collection<String> vpcSecurityGroupIds)
A list of EC2 VPC security groups to associate with this DB instance.
Default: The default EC2 VPC security group for the DB subnet group's VPC.
- Parameters:
vpcSecurityGroupIds
- A list of EC2 VPC security groups to associate with this DB instance.Default: The default EC2 VPC security group for the DB subnet group's VPC.
-
withVpcSecurityGroupIds
public CreateDBInstanceRequest withVpcSecurityGroupIds(String... vpcSecurityGroupIds)
A list of EC2 VPC security groups to associate with this DB instance.
Default: The default EC2 VPC security group for the DB subnet group's VPC.
NOTE: This method appends the values to the existing list (if any). Use
setVpcSecurityGroupIds(java.util.Collection)
orwithVpcSecurityGroupIds(java.util.Collection)
if you want to override the existing values.- Parameters:
vpcSecurityGroupIds
- A list of EC2 VPC security groups to associate with this DB instance.Default: The default EC2 VPC security group for the DB subnet group's VPC.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
withVpcSecurityGroupIds
public CreateDBInstanceRequest withVpcSecurityGroupIds(Collection<String> vpcSecurityGroupIds)
A list of EC2 VPC security groups to associate with this DB instance.
Default: The default EC2 VPC security group for the DB subnet group's VPC.
- Parameters:
vpcSecurityGroupIds
- A list of EC2 VPC security groups to associate with this DB instance.Default: The default EC2 VPC security group for the DB subnet group's VPC.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setAvailabilityZone
public void setAvailabilityZone(String availabilityZone)
The EC2 Availability Zone that the database instance will be 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 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 region as the current endpoint.- Parameters:
availabilityZone
- The EC2 Availability Zone that the database instance will be 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 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 region as the current endpoint.
-
getAvailabilityZone
public String getAvailabilityZone()
The EC2 Availability Zone that the database instance will be 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 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 region as the current endpoint.- Returns:
- The EC2 Availability Zone that the database instance will be
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 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 region as the current endpoint.
-
withAvailabilityZone
public CreateDBInstanceRequest withAvailabilityZone(String availabilityZone)
The EC2 Availability Zone that the database instance will be 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 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 region as the current endpoint.- Parameters:
availabilityZone
- The EC2 Availability Zone that the database instance will be 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 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 region as the current endpoint.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setDBSubnetGroupName
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.
- Parameters:
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.
-
getDBSubnetGroupName
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.
- Returns:
- 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.
-
withDBSubnetGroupName
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.
- Parameters:
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.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setPreferredMaintenanceWindow
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 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.
- Parameters:
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 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.
-
getPreferredMaintenanceWindow
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 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.
- Returns:
- 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 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.
-
withPreferredMaintenanceWindow
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 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.
- Parameters:
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 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.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setDBParameterGroupName
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 will be used.
Constraints:
- Must be 1 to 255 alphanumeric characters
- First character must be a letter
- Cannot end with a hyphen or contain two consecutive hyphens
- Parameters:
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 will be used.Constraints:
- Must be 1 to 255 alphanumeric characters
- First character must be a letter
- Cannot end with a hyphen or contain two consecutive hyphens
-
getDBParameterGroupName
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 will be used.
Constraints:
- Must be 1 to 255 alphanumeric characters
- First character must be a letter
- Cannot end with a hyphen or contain two consecutive hyphens
- Returns:
- 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 will be used.
Constraints:
- Must be 1 to 255 alphanumeric characters
- First character must be a letter
- Cannot end with a hyphen or contain two consecutive hyphens
-
withDBParameterGroupName
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 will be used.
Constraints:
- Must be 1 to 255 alphanumeric characters
- First character must be a letter
- Cannot end with a hyphen or contain two consecutive hyphens
- Parameters:
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 will be used.Constraints:
- Must be 1 to 255 alphanumeric characters
- First character must be a letter
- Cannot end with a hyphen or contain two consecutive hyphens
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setBackupRetentionPeriod
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.
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
- Parameters:
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.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
-
getBackupRetentionPeriod
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.
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
- Returns:
- 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.
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
-
withBackupRetentionPeriod
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.
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
- Parameters:
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.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
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setPreferredBackupWindow
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.Default: A 30-minute window selected at random from an 8-hour block of time per region. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon RDS User Guide.
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.
- Parameters:
preferredBackupWindow
- The daily time range during which automated backups are created if automated backups are enabled, using theBackupRetentionPeriod
parameter. For more information, see DB Instance Backups.Default: A 30-minute window selected at random from an 8-hour block of time per region. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon RDS User Guide.
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.
- Must be in the format
- Must be in the format
-
getPreferredBackupWindow
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.Default: A 30-minute window selected at random from an 8-hour block of time per region. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon RDS User Guide.
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.
- Returns:
- 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.Default: A 30-minute window selected at random from an 8-hour block of time per region. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon RDS User Guide.
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.
- Must be in the format
- Must be in the format
-
withPreferredBackupWindow
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.Default: A 30-minute window selected at random from an 8-hour block of time per region. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon RDS User Guide.
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.
- Parameters:
preferredBackupWindow
- The daily time range during which automated backups are created if automated backups are enabled, using theBackupRetentionPeriod
parameter. For more information, see DB Instance Backups.Default: A 30-minute window selected at random from an 8-hour block of time per region. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon RDS User Guide.
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.
- Must be in the format
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- Must be in the format
-
setPort
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 for1434
,3389
,47001
,49152
, and49152
through49156
.Amazon Aurora
Default:
3306
Valid Values:
1150-65535
Type: Integer
- Parameters:
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 for1434
,3389
,47001
,49152
, and49152
through49156
.Amazon Aurora
Default:
3306
Valid Values:
1150-65535
Type: Integer
-
getPort
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 for1434
,3389
,47001
,49152
, and49152
through49156
.Amazon Aurora
Default:
3306
Valid Values:
1150-65535
Type: Integer
- Returns:
- 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 for1434
,3389
,47001
,49152
, and49152
through49156
.Amazon Aurora
Default:
3306
Valid Values:
1150-65535
Type: Integer
-
withPort
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 for1434
,3389
,47001
,49152
, and49152
through49156
.Amazon Aurora
Default:
3306
Valid Values:
1150-65535
Type: Integer
- Parameters:
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 for1434
,3389
,47001
,49152
, and49152
through49156
.Amazon Aurora
Default:
3306
Valid Values:
1150-65535
Type: Integer
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setMultiAZ
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. Do not set this value if you want a Multi-AZ deployment for a SQL Server DB instance. Multi-AZ for SQL Server is set using the Mirroring option in an option group.
- Parameters:
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. Do not set this value if you want a Multi-AZ deployment for a SQL Server DB instance. Multi-AZ for SQL Server is set using the Mirroring option in an option group.
-
getMultiAZ
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. Do not set this value if you want a Multi-AZ deployment for a SQL Server DB instance. Multi-AZ for SQL Server is set using the Mirroring option in an option group.
- Returns:
- Specifies if the DB instance is a Multi-AZ deployment. You cannot set the AvailabilityZone parameter if the MultiAZ parameter is set to true. Do not set this value if you want a Multi-AZ deployment for a SQL Server DB instance. Multi-AZ for SQL Server is set using the Mirroring option in an option group.
-
withMultiAZ
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. Do not set this value if you want a Multi-AZ deployment for a SQL Server DB instance. Multi-AZ for SQL Server is set using the Mirroring option in an option group.
- Parameters:
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. Do not set this value if you want a Multi-AZ deployment for a SQL Server DB instance. Multi-AZ for SQL Server is set using the Mirroring option in an option group.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
isMultiAZ
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. Do not set this value if you want a Multi-AZ deployment for a SQL Server DB instance. Multi-AZ for SQL Server is set using the Mirroring option in an option group.
- Returns:
- Specifies if the DB instance is a Multi-AZ deployment. You cannot set the AvailabilityZone parameter if the MultiAZ parameter is set to true. Do not set this value if you want a Multi-AZ deployment for a SQL Server DB instance. Multi-AZ for SQL Server is set using the Mirroring option in an option group.
-
setEngineVersion
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.
MySQL
- Version 5.1 (Only available in the following regions:
ap-northeast-1, ap-southeast-1, ap-southeast-2, eu-west-1, sa-east-1,
us-west-1, us-west-2):
5.1.73a | 5.1.73b
- Version 5.5 (Only available in the following regions:
ap-northeast-1, ap-southeast-1, ap-southeast-2, eu-west-1, sa-east-1,
us-west-1, us-west-2):
5.5.40 | 5.5.40a
- Version 5.5 (Available in all regions):
5.5.40b | 5.5.41 | 5.5.42
- Version 5.6 (Available in all regions):
5.6.19a | 5.6.19b | 5.6.21 | 5.6.21b | 5.6.22 | 5.6.23 | 5.6.27
- Version 5.7 (Available in all regions):
5.7.10
MariaDB
- Version 10.0 (Available in all regions except AWS GovCloud (US)
Region (us-gov-west-1)):
10.0.17
Oracle Database Enterprise Edition (oracle-ee)
- Version 11.2 (Only available in the following regions:
ap-northeast-1, ap-southeast-1, ap-southeast-2, eu-west-1, sa-east-1,
us-west-1, us-west-2):
11.2.0.2.v3 | 11.2.0.2.v4 | 11.2.0.2.v5 | 11.2.0.2.v6 | 11.2.0.2.v7
- Version 11.2 (Available in all regions):
11.2.0.3.v1 | 11.2.0.3.v2 | 11.2.0.3.v3 | 11.2.0.4.v1 | 11.2.0.4.v3 | 11.2.0.4.v4
- Version 12.1 (Available in all regions):
12.1.0.1.v1 | 12.1.0.1.v2 | 12.1.0.2.v1
Oracle Database Standard Edition (oracle-se)
- Version 11.2 (Only available in the following regions:
us-west-1):
11.2.0.2.v3 | 11.2.0.2.v4 | 11.2.0.2.v5 | 11.2.0.2.v6 | 11.2.0.2.v7
- Version 11.2 (Only available in the following regions:
eu-central-1, us-west-1):
11.2.0.3.v1 | 11.2.0.3.v2 | 11.2.0.3.v3 | 11.2.0.4.v1 | 11.2.0.4.v3 | 11.2.0.4.v4
- Version 12.1 (Only available in the following regions:
eu-central-1, us-west-1):
12.1.0.1.v1 | 12.1.0.1.v2
Oracle Database Standard Edition One (oracle-se1)
- Version 11.2 (Only available in the following regions:
us-west-1):
11.2.0.2.v3 | 11.2.0.2.v4 | 11.2.0.2.v5 | 11.2.0.2.v6 | 11.2.0.2.v7
- Version 11.2 (Only available in the following regions:
eu-central-1, us-west-1):
11.2.0.3.v1 | 11.2.0.3.v2 | 11.2.0.3.v3 | 11.2.0.4.v1 | 11.2.0.4.v3 | 11.2.0.4.v4
- Version 12.1 (Only available in the following regions:
eu-central-1, us-west-1):
12.1.0.1.v1 | 12.1.0.1.v2
PostgreSQL
- Version 9.3 (Only available in the following regions:
ap-northeast-1, ap-southeast-1, ap-southeast-2, eu-west-1, sa-east-1,
us-west-1, us-west-2):
9.3.1 | 9.3.2
- Version 9.3 (Available in all regions):
9.3.3 | 9.3.5 | 9.3.6 | 9.3.9 | 9.3.10
- Version 9.4 (Available in all regions):
9.4.1 | 9.4.4 | 9.4.5
Microsoft SQL Server Enterprise Edition (sqlserver-ee)
- Version 10.50 (Available in all regions):
10.50.2789.0.v1
- Version 10.50 (Available in all regions):
10.50.6000.34.v1
- Version 11.00 (Available in all regions):
11.00.2100.60.v1
- Version 11.00 (Available in all regions):
11.00.5058.0.v1
Microsoft SQL Server Express Edition (sqlserver-ex)
- Version 10.50 (Available in all regions):
10.50.2789.0.v1
- Version 10.50 (Available in all regions):
10.50.6000.34.v1
- Version 11.00 (Available in all regions):
11.00.2100.60.v1
- Version 11.00 (Available in all regions):
11.00.5058.0.v1
- Version 12.00 (Available in all regions):
12.00.4422.0.v1
Microsoft SQL Server Standard Edition (sqlserver-se)
- Version 10.50 (Available in all regions):
10.50.2789.0.v1
- Version 10.50 (Available in all regions):
10.50.6000.34.v1
- Version 11.00 (Available in all regions):
11.00.2100.60.v1
- Version 11.00 (Available in all regions):
11.00.5058.0.v1
- Version 12.00 (Available in all regions):
12.00.4422.0.v1
Microsoft SQL Server Web Edition (sqlserver-web)
- Version 10.50 (Available in all regions):
10.50.2789.0.v1
- Version 10.50 (Available in all regions):
10.50.6000.34.v1
- Version 11.00 (Available in all regions):
11.00.2100.60.v1
- Version 11.00 (Available in all regions):
11.00.5058.0.v1
- Version 12.00 (Available in all regions):
12.00.4422.0.v1
- Parameters:
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.
MySQL
- Version 5.1 (Only available in the following regions:
ap-northeast-1, ap-southeast-1, ap-southeast-2, eu-west-1,
sa-east-1, us-west-1, us-west-2):
5.1.73a | 5.1.73b
- Version 5.5 (Only available in the following regions:
ap-northeast-1, ap-southeast-1, ap-southeast-2, eu-west-1,
sa-east-1, us-west-1, us-west-2):
5.5.40 | 5.5.40a
- Version 5.5 (Available in all regions):
5.5.40b | 5.5.41 | 5.5.42
- Version 5.6 (Available in all regions):
5.6.19a | 5.6.19b | 5.6.21 | 5.6.21b | 5.6.22 | 5.6.23 | 5.6.27
- Version 5.7 (Available in all regions):
5.7.10
MariaDB
- Version 10.0 (Available in all regions except AWS GovCloud
(US) Region (us-gov-west-1)):
10.0.17
Oracle Database Enterprise Edition (oracle-ee)
- Version 11.2 (Only available in the following regions:
ap-northeast-1, ap-southeast-1, ap-southeast-2, eu-west-1,
sa-east-1, us-west-1, us-west-2):
11.2.0.2.v3 | 11.2.0.2.v4 | 11.2.0.2.v5 | 11.2.0.2.v6 | 11.2.0.2.v7
- Version 11.2 (Available in all regions):
11.2.0.3.v1 | 11.2.0.3.v2 | 11.2.0.3.v3 | 11.2.0.4.v1 | 11.2.0.4.v3 | 11.2.0.4.v4
- Version 12.1 (Available in all regions):
12.1.0.1.v1 | 12.1.0.1.v2 | 12.1.0.2.v1
Oracle Database Standard Edition (oracle-se)
- Version 11.2 (Only available in the following regions:
us-west-1):
11.2.0.2.v3 | 11.2.0.2.v4 | 11.2.0.2.v5 | 11.2.0.2.v6 | 11.2.0.2.v7
- Version 11.2 (Only available in the following regions:
eu-central-1, us-west-1):
11.2.0.3.v1 | 11.2.0.3.v2 | 11.2.0.3.v3 | 11.2.0.4.v1 | 11.2.0.4.v3 | 11.2.0.4.v4
- Version 12.1 (Only available in the following regions:
eu-central-1, us-west-1):
12.1.0.1.v1 | 12.1.0.1.v2
Oracle Database Standard Edition One (oracle-se1)
- Version 11.2 (Only available in the following regions:
us-west-1):
11.2.0.2.v3 | 11.2.0.2.v4 | 11.2.0.2.v5 | 11.2.0.2.v6 | 11.2.0.2.v7
- Version 11.2 (Only available in the following regions:
eu-central-1, us-west-1):
11.2.0.3.v1 | 11.2.0.3.v2 | 11.2.0.3.v3 | 11.2.0.4.v1 | 11.2.0.4.v3 | 11.2.0.4.v4
- Version 12.1 (Only available in the following regions:
eu-central-1, us-west-1):
12.1.0.1.v1 | 12.1.0.1.v2
PostgreSQL
- Version 9.3 (Only available in the following regions:
ap-northeast-1, ap-southeast-1, ap-southeast-2, eu-west-1,
sa-east-1, us-west-1, us-west-2):
9.3.1 | 9.3.2
- Version 9.3 (Available in all regions):
9.3.3 | 9.3.5 | 9.3.6 | 9.3.9 | 9.3.10
- Version 9.4 (Available in all regions):
9.4.1 | 9.4.4 | 9.4.5
Microsoft SQL Server Enterprise Edition (sqlserver-ee)
- Version 10.50 (Available in all regions):
10.50.2789.0.v1
- Version 10.50 (Available in all regions):
10.50.6000.34.v1
- Version 11.00 (Available in all regions):
11.00.2100.60.v1
- Version 11.00 (Available in all regions):
11.00.5058.0.v1
Microsoft SQL Server Express Edition (sqlserver-ex)
- Version 10.50 (Available in all regions):
10.50.2789.0.v1
- Version 10.50 (Available in all regions):
10.50.6000.34.v1
- Version 11.00 (Available in all regions):
11.00.2100.60.v1
- Version 11.00 (Available in all regions):
11.00.5058.0.v1
- Version 12.00 (Available in all regions):
12.00.4422.0.v1
Microsoft SQL Server Standard Edition (sqlserver-se)
- Version 10.50 (Available in all regions):
10.50.2789.0.v1
- Version 10.50 (Available in all regions):
10.50.6000.34.v1
- Version 11.00 (Available in all regions):
11.00.2100.60.v1
- Version 11.00 (Available in all regions):
11.00.5058.0.v1
- Version 12.00 (Available in all regions):
12.00.4422.0.v1
Microsoft SQL Server Web Edition (sqlserver-web)
- Version 10.50 (Available in all regions):
10.50.2789.0.v1
- Version 10.50 (Available in all regions):
10.50.6000.34.v1
- Version 11.00 (Available in all regions):
11.00.2100.60.v1
- Version 11.00 (Available in all regions):
11.00.5058.0.v1
- Version 12.00 (Available in all regions):
12.00.4422.0.v1
- Version 5.1 (Only available in the following regions:
ap-northeast-1, ap-southeast-1, ap-southeast-2, eu-west-1,
sa-east-1, us-west-1, us-west-2):
- Version 5.1 (Only available in the following regions:
ap-northeast-1, ap-southeast-1, ap-southeast-2, eu-west-1, sa-east-1,
us-west-1, us-west-2):
-
getEngineVersion
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.
MySQL
- Version 5.1 (Only available in the following regions:
ap-northeast-1, ap-southeast-1, ap-southeast-2, eu-west-1, sa-east-1,
us-west-1, us-west-2):
5.1.73a | 5.1.73b
- Version 5.5 (Only available in the following regions:
ap-northeast-1, ap-southeast-1, ap-southeast-2, eu-west-1, sa-east-1,
us-west-1, us-west-2):
5.5.40 | 5.5.40a
- Version 5.5 (Available in all regions):
5.5.40b | 5.5.41 | 5.5.42
- Version 5.6 (Available in all regions):
5.6.19a | 5.6.19b | 5.6.21 | 5.6.21b | 5.6.22 | 5.6.23 | 5.6.27
- Version 5.7 (Available in all regions):
5.7.10
MariaDB
- Version 10.0 (Available in all regions except AWS GovCloud (US)
Region (us-gov-west-1)):
10.0.17
Oracle Database Enterprise Edition (oracle-ee)
- Version 11.2 (Only available in the following regions:
ap-northeast-1, ap-southeast-1, ap-southeast-2, eu-west-1, sa-east-1,
us-west-1, us-west-2):
11.2.0.2.v3 | 11.2.0.2.v4 | 11.2.0.2.v5 | 11.2.0.2.v6 | 11.2.0.2.v7
- Version 11.2 (Available in all regions):
11.2.0.3.v1 | 11.2.0.3.v2 | 11.2.0.3.v3 | 11.2.0.4.v1 | 11.2.0.4.v3 | 11.2.0.4.v4
- Version 12.1 (Available in all regions):
12.1.0.1.v1 | 12.1.0.1.v2 | 12.1.0.2.v1
Oracle Database Standard Edition (oracle-se)
- Version 11.2 (Only available in the following regions:
us-west-1):
11.2.0.2.v3 | 11.2.0.2.v4 | 11.2.0.2.v5 | 11.2.0.2.v6 | 11.2.0.2.v7
- Version 11.2 (Only available in the following regions:
eu-central-1, us-west-1):
11.2.0.3.v1 | 11.2.0.3.v2 | 11.2.0.3.v3 | 11.2.0.4.v1 | 11.2.0.4.v3 | 11.2.0.4.v4
- Version 12.1 (Only available in the following regions:
eu-central-1, us-west-1):
12.1.0.1.v1 | 12.1.0.1.v2
Oracle Database Standard Edition One (oracle-se1)
- Version 11.2 (Only available in the following regions:
us-west-1):
11.2.0.2.v3 | 11.2.0.2.v4 | 11.2.0.2.v5 | 11.2.0.2.v6 | 11.2.0.2.v7
- Version 11.2 (Only available in the following regions:
eu-central-1, us-west-1):
11.2.0.3.v1 | 11.2.0.3.v2 | 11.2.0.3.v3 | 11.2.0.4.v1 | 11.2.0.4.v3 | 11.2.0.4.v4
- Version 12.1 (Only available in the following regions:
eu-central-1, us-west-1):
12.1.0.1.v1 | 12.1.0.1.v2
PostgreSQL
- Version 9.3 (Only available in the following regions:
ap-northeast-1, ap-southeast-1, ap-southeast-2, eu-west-1, sa-east-1,
us-west-1, us-west-2):
9.3.1 | 9.3.2
- Version 9.3 (Available in all regions):
9.3.3 | 9.3.5 | 9.3.6 | 9.3.9 | 9.3.10
- Version 9.4 (Available in all regions):
9.4.1 | 9.4.4 | 9.4.5
Microsoft SQL Server Enterprise Edition (sqlserver-ee)
- Version 10.50 (Available in all regions):
10.50.2789.0.v1
- Version 10.50 (Available in all regions):
10.50.6000.34.v1
- Version 11.00 (Available in all regions):
11.00.2100.60.v1
- Version 11.00 (Available in all regions):
11.00.5058.0.v1
Microsoft SQL Server Express Edition (sqlserver-ex)
- Version 10.50 (Available in all regions):
10.50.2789.0.v1
- Version 10.50 (Available in all regions):
10.50.6000.34.v1
- Version 11.00 (Available in all regions):
11.00.2100.60.v1
- Version 11.00 (Available in all regions):
11.00.5058.0.v1
- Version 12.00 (Available in all regions):
12.00.4422.0.v1
Microsoft SQL Server Standard Edition (sqlserver-se)
- Version 10.50 (Available in all regions):
10.50.2789.0.v1
- Version 10.50 (Available in all regions):
10.50.6000.34.v1
- Version 11.00 (Available in all regions):
11.00.2100.60.v1
- Version 11.00 (Available in all regions):
11.00.5058.0.v1
- Version 12.00 (Available in all regions):
12.00.4422.0.v1
Microsoft SQL Server Web Edition (sqlserver-web)
- Version 10.50 (Available in all regions):
10.50.2789.0.v1
- Version 10.50 (Available in all regions):
10.50.6000.34.v1
- Version 11.00 (Available in all regions):
11.00.2100.60.v1
- Version 11.00 (Available in all regions):
11.00.5058.0.v1
- Version 12.00 (Available in all regions):
12.00.4422.0.v1
- Returns:
- 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.
MySQL
- Version 5.1 (Only available in the following regions:
ap-northeast-1, ap-southeast-1, ap-southeast-2, eu-west-1,
sa-east-1, us-west-1, us-west-2):
5.1.73a | 5.1.73b
- Version 5.5 (Only available in the following regions:
ap-northeast-1, ap-southeast-1, ap-southeast-2, eu-west-1,
sa-east-1, us-west-1, us-west-2):
5.5.40 | 5.5.40a
- Version 5.5 (Available in all regions):
5.5.40b | 5.5.41 | 5.5.42
- Version 5.6 (Available in all regions):
5.6.19a | 5.6.19b | 5.6.21 | 5.6.21b | 5.6.22 | 5.6.23 | 5.6.27
- Version 5.7 (Available in all regions):
5.7.10
MariaDB
- Version 10.0 (Available in all regions except AWS GovCloud
(US) Region (us-gov-west-1)):
10.0.17
Oracle Database Enterprise Edition (oracle-ee)
- Version 11.2 (Only available in the following regions:
ap-northeast-1, ap-southeast-1, ap-southeast-2, eu-west-1,
sa-east-1, us-west-1, us-west-2):
11.2.0.2.v3 | 11.2.0.2.v4 | 11.2.0.2.v5 | 11.2.0.2.v6 | 11.2.0.2.v7
- Version 11.2 (Available in all regions):
11.2.0.3.v1 | 11.2.0.3.v2 | 11.2.0.3.v3 | 11.2.0.4.v1 | 11.2.0.4.v3 | 11.2.0.4.v4
- Version 12.1 (Available in all regions):
12.1.0.1.v1 | 12.1.0.1.v2 | 12.1.0.2.v1
Oracle Database Standard Edition (oracle-se)
- Version 11.2 (Only available in the following regions:
us-west-1):
11.2.0.2.v3 | 11.2.0.2.v4 | 11.2.0.2.v5 | 11.2.0.2.v6 | 11.2.0.2.v7
- Version 11.2 (Only available in the following regions:
eu-central-1, us-west-1):
11.2.0.3.v1 | 11.2.0.3.v2 | 11.2.0.3.v3 | 11.2.0.4.v1 | 11.2.0.4.v3 | 11.2.0.4.v4
- Version 12.1 (Only available in the following regions:
eu-central-1, us-west-1):
12.1.0.1.v1 | 12.1.0.1.v2
Oracle Database Standard Edition One (oracle-se1)
- Version 11.2 (Only available in the following regions:
us-west-1):
11.2.0.2.v3 | 11.2.0.2.v4 | 11.2.0.2.v5 | 11.2.0.2.v6 | 11.2.0.2.v7
- Version 11.2 (Only available in the following regions:
eu-central-1, us-west-1):
11.2.0.3.v1 | 11.2.0.3.v2 | 11.2.0.3.v3 | 11.2.0.4.v1 | 11.2.0.4.v3 | 11.2.0.4.v4
- Version 12.1 (Only available in the following regions:
eu-central-1, us-west-1):
12.1.0.1.v1 | 12.1.0.1.v2
PostgreSQL
- Version 9.3 (Only available in the following regions:
ap-northeast-1, ap-southeast-1, ap-southeast-2, eu-west-1,
sa-east-1, us-west-1, us-west-2):
9.3.1 | 9.3.2
- Version 9.3 (Available in all regions):
9.3.3 | 9.3.5 | 9.3.6 | 9.3.9 | 9.3.10
- Version 9.4 (Available in all regions):
9.4.1 | 9.4.4 | 9.4.5
Microsoft SQL Server Enterprise Edition (sqlserver-ee)
- Version 10.50 (Available in all regions):
10.50.2789.0.v1
- Version 10.50 (Available in all regions):
10.50.6000.34.v1
- Version 11.00 (Available in all regions):
11.00.2100.60.v1
- Version 11.00 (Available in all regions):
11.00.5058.0.v1
Microsoft SQL Server Express Edition (sqlserver-ex)
- Version 10.50 (Available in all regions):
10.50.2789.0.v1
- Version 10.50 (Available in all regions):
10.50.6000.34.v1
- Version 11.00 (Available in all regions):
11.00.2100.60.v1
- Version 11.00 (Available in all regions):
11.00.5058.0.v1
- Version 12.00 (Available in all regions):
12.00.4422.0.v1
Microsoft SQL Server Standard Edition (sqlserver-se)
- Version 10.50 (Available in all regions):
10.50.2789.0.v1
- Version 10.50 (Available in all regions):
10.50.6000.34.v1
- Version 11.00 (Available in all regions):
11.00.2100.60.v1
- Version 11.00 (Available in all regions):
11.00.5058.0.v1
- Version 12.00 (Available in all regions):
12.00.4422.0.v1
Microsoft SQL Server Web Edition (sqlserver-web)
- Version 10.50 (Available in all regions):
10.50.2789.0.v1
- Version 10.50 (Available in all regions):
10.50.6000.34.v1
- Version 11.00 (Available in all regions):
11.00.2100.60.v1
- Version 11.00 (Available in all regions):
11.00.5058.0.v1
- Version 12.00 (Available in all regions):
12.00.4422.0.v1
- Version 5.1 (Only available in the following regions:
ap-northeast-1, ap-southeast-1, ap-southeast-2, eu-west-1,
sa-east-1, us-west-1, us-west-2):
- Version 5.1 (Only available in the following regions:
ap-northeast-1, ap-southeast-1, ap-southeast-2, eu-west-1, sa-east-1,
us-west-1, us-west-2):
-
withEngineVersion
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.
MySQL
- Version 5.1 (Only available in the following regions:
ap-northeast-1, ap-southeast-1, ap-southeast-2, eu-west-1, sa-east-1,
us-west-1, us-west-2):
5.1.73a | 5.1.73b
- Version 5.5 (Only available in the following regions:
ap-northeast-1, ap-southeast-1, ap-southeast-2, eu-west-1, sa-east-1,
us-west-1, us-west-2):
5.5.40 | 5.5.40a
- Version 5.5 (Available in all regions):
5.5.40b | 5.5.41 | 5.5.42
- Version 5.6 (Available in all regions):
5.6.19a | 5.6.19b | 5.6.21 | 5.6.21b | 5.6.22 | 5.6.23 | 5.6.27
- Version 5.7 (Available in all regions):
5.7.10
MariaDB
- Version 10.0 (Available in all regions except AWS GovCloud (US)
Region (us-gov-west-1)):
10.0.17
Oracle Database Enterprise Edition (oracle-ee)
- Version 11.2 (Only available in the following regions:
ap-northeast-1, ap-southeast-1, ap-southeast-2, eu-west-1, sa-east-1,
us-west-1, us-west-2):
11.2.0.2.v3 | 11.2.0.2.v4 | 11.2.0.2.v5 | 11.2.0.2.v6 | 11.2.0.2.v7
- Version 11.2 (Available in all regions):
11.2.0.3.v1 | 11.2.0.3.v2 | 11.2.0.3.v3 | 11.2.0.4.v1 | 11.2.0.4.v3 | 11.2.0.4.v4
- Version 12.1 (Available in all regions):
12.1.0.1.v1 | 12.1.0.1.v2 | 12.1.0.2.v1
Oracle Database Standard Edition (oracle-se)
- Version 11.2 (Only available in the following regions:
us-west-1):
11.2.0.2.v3 | 11.2.0.2.v4 | 11.2.0.2.v5 | 11.2.0.2.v6 | 11.2.0.2.v7
- Version 11.2 (Only available in the following regions:
eu-central-1, us-west-1):
11.2.0.3.v1 | 11.2.0.3.v2 | 11.2.0.3.v3 | 11.2.0.4.v1 | 11.2.0.4.v3 | 11.2.0.4.v4
- Version 12.1 (Only available in the following regions:
eu-central-1, us-west-1):
12.1.0.1.v1 | 12.1.0.1.v2
Oracle Database Standard Edition One (oracle-se1)
- Version 11.2 (Only available in the following regions:
us-west-1):
11.2.0.2.v3 | 11.2.0.2.v4 | 11.2.0.2.v5 | 11.2.0.2.v6 | 11.2.0.2.v7
- Version 11.2 (Only available in the following regions:
eu-central-1, us-west-1):
11.2.0.3.v1 | 11.2.0.3.v2 | 11.2.0.3.v3 | 11.2.0.4.v1 | 11.2.0.4.v3 | 11.2.0.4.v4
- Version 12.1 (Only available in the following regions:
eu-central-1, us-west-1):
12.1.0.1.v1 | 12.1.0.1.v2
PostgreSQL
- Version 9.3 (Only available in the following regions:
ap-northeast-1, ap-southeast-1, ap-southeast-2, eu-west-1, sa-east-1,
us-west-1, us-west-2):
9.3.1 | 9.3.2
- Version 9.3 (Available in all regions):
9.3.3 | 9.3.5 | 9.3.6 | 9.3.9 | 9.3.10
- Version 9.4 (Available in all regions):
9.4.1 | 9.4.4 | 9.4.5
Microsoft SQL Server Enterprise Edition (sqlserver-ee)
- Version 10.50 (Available in all regions):
10.50.2789.0.v1
- Version 10.50 (Available in all regions):
10.50.6000.34.v1
- Version 11.00 (Available in all regions):
11.00.2100.60.v1
- Version 11.00 (Available in all regions):
11.00.5058.0.v1
Microsoft SQL Server Express Edition (sqlserver-ex)
- Version 10.50 (Available in all regions):
10.50.2789.0.v1
- Version 10.50 (Available in all regions):
10.50.6000.34.v1
- Version 11.00 (Available in all regions):
11.00.2100.60.v1
- Version 11.00 (Available in all regions):
11.00.5058.0.v1
- Version 12.00 (Available in all regions):
12.00.4422.0.v1
Microsoft SQL Server Standard Edition (sqlserver-se)
- Version 10.50 (Available in all regions):
10.50.2789.0.v1
- Version 10.50 (Available in all regions):
10.50.6000.34.v1
- Version 11.00 (Available in all regions):
11.00.2100.60.v1
- Version 11.00 (Available in all regions):
11.00.5058.0.v1
- Version 12.00 (Available in all regions):
12.00.4422.0.v1
Microsoft SQL Server Web Edition (sqlserver-web)
- Version 10.50 (Available in all regions):
10.50.2789.0.v1
- Version 10.50 (Available in all regions):
10.50.6000.34.v1
- Version 11.00 (Available in all regions):
11.00.2100.60.v1
- Version 11.00 (Available in all regions):
11.00.5058.0.v1
- Version 12.00 (Available in all regions):
12.00.4422.0.v1
- Parameters:
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.
MySQL
- Version 5.1 (Only available in the following regions:
ap-northeast-1, ap-southeast-1, ap-southeast-2, eu-west-1,
sa-east-1, us-west-1, us-west-2):
5.1.73a | 5.1.73b
- Version 5.5 (Only available in the following regions:
ap-northeast-1, ap-southeast-1, ap-southeast-2, eu-west-1,
sa-east-1, us-west-1, us-west-2):
5.5.40 | 5.5.40a
- Version 5.5 (Available in all regions):
5.5.40b | 5.5.41 | 5.5.42
- Version 5.6 (Available in all regions):
5.6.19a | 5.6.19b | 5.6.21 | 5.6.21b | 5.6.22 | 5.6.23 | 5.6.27
- Version 5.7 (Available in all regions):
5.7.10
MariaDB
- Version 10.0 (Available in all regions except AWS GovCloud
(US) Region (us-gov-west-1)):
10.0.17
Oracle Database Enterprise Edition (oracle-ee)
- Version 11.2 (Only available in the following regions:
ap-northeast-1, ap-southeast-1, ap-southeast-2, eu-west-1,
sa-east-1, us-west-1, us-west-2):
11.2.0.2.v3 | 11.2.0.2.v4 | 11.2.0.2.v5 | 11.2.0.2.v6 | 11.2.0.2.v7
- Version 11.2 (Available in all regions):
11.2.0.3.v1 | 11.2.0.3.v2 | 11.2.0.3.v3 | 11.2.0.4.v1 | 11.2.0.4.v3 | 11.2.0.4.v4
- Version 12.1 (Available in all regions):
12.1.0.1.v1 | 12.1.0.1.v2 | 12.1.0.2.v1
Oracle Database Standard Edition (oracle-se)
- Version 11.2 (Only available in the following regions:
us-west-1):
11.2.0.2.v3 | 11.2.0.2.v4 | 11.2.0.2.v5 | 11.2.0.2.v6 | 11.2.0.2.v7
- Version 11.2 (Only available in the following regions:
eu-central-1, us-west-1):
11.2.0.3.v1 | 11.2.0.3.v2 | 11.2.0.3.v3 | 11.2.0.4.v1 | 11.2.0.4.v3 | 11.2.0.4.v4
- Version 12.1 (Only available in the following regions:
eu-central-1, us-west-1):
12.1.0.1.v1 | 12.1.0.1.v2
Oracle Database Standard Edition One (oracle-se1)
- Version 11.2 (Only available in the following regions:
us-west-1):
11.2.0.2.v3 | 11.2.0.2.v4 | 11.2.0.2.v5 | 11.2.0.2.v6 | 11.2.0.2.v7
- Version 11.2 (Only available in the following regions:
eu-central-1, us-west-1):
11.2.0.3.v1 | 11.2.0.3.v2 | 11.2.0.3.v3 | 11.2.0.4.v1 | 11.2.0.4.v3 | 11.2.0.4.v4
- Version 12.1 (Only available in the following regions:
eu-central-1, us-west-1):
12.1.0.1.v1 | 12.1.0.1.v2
PostgreSQL
- Version 9.3 (Only available in the following regions:
ap-northeast-1, ap-southeast-1, ap-southeast-2, eu-west-1,
sa-east-1, us-west-1, us-west-2):
9.3.1 | 9.3.2
- Version 9.3 (Available in all regions):
9.3.3 | 9.3.5 | 9.3.6 | 9.3.9 | 9.3.10
- Version 9.4 (Available in all regions):
9.4.1 | 9.4.4 | 9.4.5
Microsoft SQL Server Enterprise Edition (sqlserver-ee)
- Version 10.50 (Available in all regions):
10.50.2789.0.v1
- Version 10.50 (Available in all regions):
10.50.6000.34.v1
- Version 11.00 (Available in all regions):
11.00.2100.60.v1
- Version 11.00 (Available in all regions):
11.00.5058.0.v1
Microsoft SQL Server Express Edition (sqlserver-ex)
- Version 10.50 (Available in all regions):
10.50.2789.0.v1
- Version 10.50 (Available in all regions):
10.50.6000.34.v1
- Version 11.00 (Available in all regions):
11.00.2100.60.v1
- Version 11.00 (Available in all regions):
11.00.5058.0.v1
- Version 12.00 (Available in all regions):
12.00.4422.0.v1
Microsoft SQL Server Standard Edition (sqlserver-se)
- Version 10.50 (Available in all regions):
10.50.2789.0.v1
- Version 10.50 (Available in all regions):
10.50.6000.34.v1
- Version 11.00 (Available in all regions):
11.00.2100.60.v1
- Version 11.00 (Available in all regions):
11.00.5058.0.v1
- Version 12.00 (Available in all regions):
12.00.4422.0.v1
Microsoft SQL Server Web Edition (sqlserver-web)
- Version 10.50 (Available in all regions):
10.50.2789.0.v1
- Version 10.50 (Available in all regions):
10.50.6000.34.v1
- Version 11.00 (Available in all regions):
11.00.2100.60.v1
- Version 11.00 (Available in all regions):
11.00.5058.0.v1
- Version 12.00 (Available in all regions):
12.00.4422.0.v1
- Version 5.1 (Only available in the following regions:
ap-northeast-1, ap-southeast-1, ap-southeast-2, eu-west-1,
sa-east-1, us-west-1, us-west-2):
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- Version 5.1 (Only available in the following regions:
ap-northeast-1, ap-southeast-1, ap-southeast-2, eu-west-1, sa-east-1,
us-west-1, us-west-2):
-
setAutoMinorVersionUpgrade
public void setAutoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade)
Indicates that minor engine upgrades will be applied automatically to the DB instance during the maintenance window.
Default:
true
- Parameters:
autoMinorVersionUpgrade
- Indicates that minor engine upgrades will be applied automatically to the DB instance during the maintenance window.Default:
true
-
getAutoMinorVersionUpgrade
public Boolean getAutoMinorVersionUpgrade()
Indicates that minor engine upgrades will be applied automatically to the DB instance during the maintenance window.
Default:
true
- Returns:
- Indicates that minor engine upgrades will be applied
automatically to the DB instance during the maintenance window.
Default:
true
-
withAutoMinorVersionUpgrade
public CreateDBInstanceRequest withAutoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade)
Indicates that minor engine upgrades will be applied automatically to the DB instance during the maintenance window.
Default:
true
- Parameters:
autoMinorVersionUpgrade
- Indicates that minor engine upgrades will be applied automatically to the DB instance during the maintenance window.Default:
true
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
isAutoMinorVersionUpgrade
public Boolean isAutoMinorVersionUpgrade()
Indicates that minor engine upgrades will be applied automatically to the DB instance during the maintenance window.
Default:
true
- Returns:
- Indicates that minor engine upgrades will be applied
automatically to the DB instance during the maintenance window.
Default:
true
-
setLicenseModel
public void setLicenseModel(String licenseModel)
License model information for this DB instance.
Valid values:
license-included
|bring-your-own-license
|general-public-license
- Parameters:
licenseModel
- License model information for this DB instance.Valid values:
license-included
|bring-your-own-license
|general-public-license
-
getLicenseModel
public String getLicenseModel()
License model information for this DB instance.
Valid values:
license-included
|bring-your-own-license
|general-public-license
- Returns:
- License model information for this DB instance.
Valid values:
license-included
|bring-your-own-license
|general-public-license
-
withLicenseModel
public CreateDBInstanceRequest withLicenseModel(String licenseModel)
License model information for this DB instance.
Valid values:
license-included
|bring-your-own-license
|general-public-license
- Parameters:
licenseModel
- License model information for this DB instance.Valid values:
license-included
|bring-your-own-license
|general-public-license
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setIops
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.- Parameters:
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.
-
getIops
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.- Returns:
- 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.
-
withIops
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.- Parameters:
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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setOptionGroupName
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
- Parameters:
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
-
getOptionGroupName
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
- Returns:
- 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
-
withOptionGroupName
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
- Parameters:
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
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setCharacterSetName
public void setCharacterSetName(String characterSetName)
For supported engines, indicates that the DB instance should be associated with the specified CharacterSet.
- Parameters:
characterSetName
- For supported engines, indicates that the DB instance should be associated with the specified CharacterSet.
-
getCharacterSetName
public String getCharacterSetName()
For supported engines, indicates that the DB instance should be associated with the specified CharacterSet.
- Returns:
- For supported engines, indicates that the DB instance should be associated with the specified CharacterSet.
-
withCharacterSetName
public CreateDBInstanceRequest withCharacterSetName(String characterSetName)
For supported engines, indicates that the DB instance should be associated with the specified CharacterSet.
- Parameters:
characterSetName
- For supported engines, indicates that the DB instance should be associated with the specified CharacterSet.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setPubliclyAccessible
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 will be 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 will be private.
- Parameters:
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 will be 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 will be private.
-
getPubliclyAccessible
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 will be 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 will be private.
- Returns:
- 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 will be 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 will be private.
-
withPubliclyAccessible
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 will be 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 will be private.
- Parameters:
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 will be 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 will be private.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
isPubliclyAccessible
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 will be 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 will be private.
- Returns:
- 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 will be 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 will be private.
-
setTags
public void setTags(Collection<Tag> tags)
- Parameters:
tags
-
-
withTags
public CreateDBInstanceRequest withTags(Tag... tags)
NOTE: This method appends the values to the existing list (if any). Use
setTags(java.util.Collection)
orwithTags(java.util.Collection)
if you want to override the existing values.- Parameters:
tags
-- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
withTags
public CreateDBInstanceRequest withTags(Collection<Tag> tags)
- Parameters:
tags
-- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setDBClusterIdentifier
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
- Parameters:
dBClusterIdentifier
- The identifier of the DB cluster that the instance will belong to.For information on creating a DB cluster, see CreateDBCluster.
Type: String
-
getDBClusterIdentifier
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
- Returns:
- The identifier of the DB cluster that the instance will belong
to.
For information on creating a DB cluster, see CreateDBCluster.
Type: String
-
withDBClusterIdentifier
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
- Parameters:
dBClusterIdentifier
- The identifier of the DB cluster that the instance will belong to.For information on creating a DB cluster, see CreateDBCluster.
Type: String
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setStorageType
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 theIops
parameter.Default:
io1
if theIops
parameter is specified; otherwisestandard
- Parameters:
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 theIops
parameter.Default:
io1
if theIops
parameter is specified; otherwisestandard
-
getStorageType
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 theIops
parameter.Default:
io1
if theIops
parameter is specified; otherwisestandard
- Returns:
- 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 theIops
parameter.Default:
io1
if theIops
parameter is specified; otherwisestandard
-
withStorageType
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 theIops
parameter.Default:
io1
if theIops
parameter is specified; otherwisestandard
- Parameters:
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 theIops
parameter.Default:
io1
if theIops
parameter is specified; otherwisestandard
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setTdeCredentialArn
public void setTdeCredentialArn(String tdeCredentialArn)
The ARN from the Key Store with which to associate the instance for TDE encryption.
- Parameters:
tdeCredentialArn
- The ARN from the Key Store with which to associate the instance for TDE encryption.
-
getTdeCredentialArn
public String getTdeCredentialArn()
The ARN from the Key Store with which to associate the instance for TDE encryption.
- Returns:
- The ARN from the Key Store with which to associate the instance for TDE encryption.
-
withTdeCredentialArn
public CreateDBInstanceRequest withTdeCredentialArn(String tdeCredentialArn)
The ARN from the Key Store with which to associate the instance for TDE encryption.
- Parameters:
tdeCredentialArn
- The ARN from the Key Store with which to associate the instance for TDE encryption.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setTdeCredentialPassword
public void setTdeCredentialPassword(String tdeCredentialPassword)
The password for the given ARN from the Key Store in order to access the device.
- Parameters:
tdeCredentialPassword
- The password for the given ARN from the Key Store in order to access the device.
-
getTdeCredentialPassword
public String getTdeCredentialPassword()
The password for the given ARN from the Key Store in order to access the device.
- Returns:
- The password for the given ARN from the Key Store in order to access the device.
-
withTdeCredentialPassword
public CreateDBInstanceRequest withTdeCredentialPassword(String tdeCredentialPassword)
The password for the given ARN from the Key Store in order to access the device.
- Parameters:
tdeCredentialPassword
- The password for the given ARN from the Key Store in order to access the device.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setStorageEncrypted
public void setStorageEncrypted(Boolean storageEncrypted)
Specifies whether the DB instance is encrypted.
Default: false
- Parameters:
storageEncrypted
- Specifies whether the DB instance is encrypted.Default: false
-
getStorageEncrypted
public Boolean getStorageEncrypted()
Specifies whether the DB instance is encrypted.
Default: false
- Returns:
- Specifies whether the DB instance is encrypted.
Default: false
-
withStorageEncrypted
public CreateDBInstanceRequest withStorageEncrypted(Boolean storageEncrypted)
Specifies whether the DB instance is encrypted.
Default: false
- Parameters:
storageEncrypted
- Specifies whether the DB instance is encrypted.Default: false
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
isStorageEncrypted
public Boolean isStorageEncrypted()
Specifies whether the DB instance is encrypted.
Default: false
- Returns:
- Specifies whether the DB instance is encrypted.
Default: false
-
setKmsKeyId
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.
If the
StorageEncrypted
parameter is true, and you do not specify a value for theKmsKeyId
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.- Parameters:
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.
If the
StorageEncrypted
parameter is true, and you do not specify a value for theKmsKeyId
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.
-
getKmsKeyId
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.
If the
StorageEncrypted
parameter is true, and you do not specify a value for theKmsKeyId
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.- Returns:
- 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.
If the
StorageEncrypted
parameter is true, and you do not specify a value for theKmsKeyId
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.
-
withKmsKeyId
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.
If the
StorageEncrypted
parameter is true, and you do not specify a value for theKmsKeyId
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.- Parameters:
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.
If the
StorageEncrypted
parameter is true, and you do not specify a value for theKmsKeyId
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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setDomain
public void setDomain(String domain)
Specify the Active Directory Domain to create the instance in.
- Parameters:
domain
- Specify the Active Directory Domain to create the instance in.
-
getDomain
public String getDomain()
Specify the Active Directory Domain to create the instance in.
- Returns:
- Specify the Active Directory Domain to create the instance in.
-
withDomain
public CreateDBInstanceRequest withDomain(String domain)
Specify the Active Directory Domain to create the instance in.
- Parameters:
domain
- Specify the Active Directory Domain to create the instance in.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setCopyTagsToSnapshot
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.
- Parameters:
copyTagsToSnapshot
- True to copy all tags from the DB instance to snapshots of the DB instance; otherwise false. The default is false.
-
getCopyTagsToSnapshot
public Boolean getCopyTagsToSnapshot()
True to copy all tags from the DB instance to snapshots of the DB instance; otherwise false. The default is false.
- Returns:
- True to copy all tags from the DB instance to snapshots of the DB instance; otherwise false. The default is false.
-
withCopyTagsToSnapshot
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.
- Parameters:
copyTagsToSnapshot
- True to copy all tags from the DB instance to snapshots of the DB instance; otherwise false. The default is false.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
isCopyTagsToSnapshot
public Boolean isCopyTagsToSnapshot()
True to copy all tags from the DB instance to snapshots of the DB instance; otherwise false. The default is false.
- Returns:
- True to copy all tags from the DB instance to snapshots of the DB instance; otherwise false. The default is false.
-
setMonitoringInterval
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 60.
If
MonitoringRoleArn
is specified, then you must also setMonitoringInterval
to a value other than 0.Valid Values:
0, 1, 5, 10, 15, 30, 60
- Parameters:
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 60.If
MonitoringRoleArn
is specified, then you must also setMonitoringInterval
to a value other than 0.Valid Values:
0, 1, 5, 10, 15, 30, 60
-
getMonitoringInterval
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 60.
If
MonitoringRoleArn
is specified, then you must also setMonitoringInterval
to a value other than 0.Valid Values:
0, 1, 5, 10, 15, 30, 60
- Returns:
- 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 60.
If
MonitoringRoleArn
is specified, then you must also setMonitoringInterval
to a value other than 0.Valid Values:
0, 1, 5, 10, 15, 30, 60
-
withMonitoringInterval
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 60.
If
MonitoringRoleArn
is specified, then you must also setMonitoringInterval
to a value other than 0.Valid Values:
0, 1, 5, 10, 15, 30, 60
- Parameters:
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 60.If
MonitoringRoleArn
is specified, then you must also setMonitoringInterval
to a value other than 0.Valid Values:
0, 1, 5, 10, 15, 30, 60
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setMonitoringRoleArn
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 To create an IAM role for Amazon RDS Enhanced Monitoring.If
MonitoringInterval
is set to a value other than 0, then you must supply aMonitoringRoleArn
value.- Parameters:
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 To create an IAM role for Amazon RDS Enhanced Monitoring.If
MonitoringInterval
is set to a value other than 0, then you must supply aMonitoringRoleArn
value.
-
getMonitoringRoleArn
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 To create an IAM role for Amazon RDS Enhanced Monitoring.If
MonitoringInterval
is set to a value other than 0, then you must supply aMonitoringRoleArn
value.- Returns:
- 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 To create an IAM role for Amazon RDS Enhanced Monitoring.If
MonitoringInterval
is set to a value other than 0, then you must supply aMonitoringRoleArn
value.
-
withMonitoringRoleArn
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 To create an IAM role for Amazon RDS Enhanced Monitoring.If
MonitoringInterval
is set to a value other than 0, then you must supply aMonitoringRoleArn
value.- Parameters:
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 To create an IAM role for Amazon RDS Enhanced Monitoring.If
MonitoringInterval
is set to a value other than 0, then you must supply aMonitoringRoleArn
value.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setDomainIAMRoleName
public void setDomainIAMRoleName(String domainIAMRoleName)
Specify the name of the IAM role to be used when making API calls to the Directory Service.
- Parameters:
domainIAMRoleName
- Specify the name of the IAM role to be used when making API calls to the Directory Service.
-
getDomainIAMRoleName
public String getDomainIAMRoleName()
Specify the name of the IAM role to be used when making API calls to the Directory Service.
- Returns:
- Specify the name of the IAM role to be used when making API calls to the Directory Service.
-
withDomainIAMRoleName
public CreateDBInstanceRequest withDomainIAMRoleName(String domainIAMRoleName)
Specify the name of the IAM role to be used when making API calls to the Directory Service.
- Parameters:
domainIAMRoleName
- Specify the name of the IAM role to be used when making API calls to the Directory Service.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setPromotionTier
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
- Parameters:
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
-
getPromotionTier
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
- Returns:
- 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
-
withPromotionTier
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
- Parameters:
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
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
toString
public String toString()
Returns a string representation of this object; useful for testing and debugging.- Overrides:
toString
in classObject
- Returns:
- A string representation of this object.
- See Also:
Object.toString()
-
clone
public CreateDBInstanceRequest clone()
Description copied from class:AmazonWebServiceRequest
Creates a shallow clone of this request. Explicitly does not clone the deep structure of the request object.- Overrides:
clone
in classAmazonWebServiceRequest
- See Also:
Object.clone()
-
-