public class CreateDBInstanceRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
CreateDBInstance operation
.
Creates a new DB instance.
NOOP
Constructor and Description |
---|
CreateDBInstanceRequest()
Default constructor for a new CreateDBInstanceRequest object.
|
CreateDBInstanceRequest(String dBInstanceIdentifier,
Integer allocatedStorage,
String dBInstanceClass,
String engine,
String masterUsername,
String masterUserPassword)
Constructs a new CreateDBInstanceRequest object.
|
Modifier and Type | Method and Description |
---|---|
CreateDBInstanceRequest |
clone()
Creates a shallow clone of this 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 |
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.
|
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 the
BackupRetentionPeriod parameter. |
String |
getPreferredMaintenanceWindow()
The weekly time range during which system maintenance can occur, in
Universal Coordinated Time (UTC).
|
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()
A list of tags.
|
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 |
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 |
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 the
BackupRetentionPeriod parameter. |
void |
setPreferredMaintenanceWindow(String preferredMaintenanceWindow)
The weekly time range during which system maintenance can occur, in
Universal Coordinated Time (UTC).
|
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)
A list of 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(Collection<String> dBSecurityGroups)
A list of DB security groups to associate with this DB instance.
|
CreateDBInstanceRequest |
withDBSecurityGroups(String... dBSecurityGroups)
A list of DB security groups to associate with this DB instance.
|
CreateDBInstanceRequest |
withDBSubnetGroupName(String dBSubnetGroupName)
A DB subnet group to associate with this DB instance.
|
CreateDBInstanceRequest |
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 |
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 the
BackupRetentionPeriod parameter. |
CreateDBInstanceRequest |
withPreferredMaintenanceWindow(String preferredMaintenanceWindow)
The weekly time range during which system maintenance can occur, in
Universal Coordinated Time (UTC).
|
CreateDBInstanceRequest |
withPubliclyAccessible(Boolean publiclyAccessible)
Specifies the accessibility options for the DB instance.
|
CreateDBInstanceRequest |
withStorageEncrypted(Boolean storageEncrypted)
Specifies whether the DB instance is encrypted.
|
CreateDBInstanceRequest |
withStorageType(String storageType)
Specifies the storage type to be associated with the DB instance.
|
CreateDBInstanceRequest |
withTags(Collection<Tag> tags)
A list of tags.
|
CreateDBInstanceRequest |
withTags(Tag... tags)
A list of 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(Collection<String> vpcSecurityGroupIds)
A list of EC2 VPC security groups to associate with this DB instance.
|
CreateDBInstanceRequest |
withVpcSecurityGroupIds(String... vpcSecurityGroupIds)
A list of EC2 VPC security groups to associate with this DB instance.
|
copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout
public CreateDBInstanceRequest()
public CreateDBInstanceRequest(String dBInstanceIdentifier, Integer allocatedStorage, String dBInstanceClass, String engine, String masterUsername, String masterUserPassword)
dBInstanceIdentifier
- The DB instance identifier. This parameter
is stored as a lowercase string. Constraints:
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
Not every database engine is available for every AWS region.
masterUsername
- The name of master user for the client DB
instance. MySQL
Constraints:
MariaDB
Constraints:
Type: String
Oracle
Constraints:
SQL Server
Constraints:
PostgreSQL
Constraints:
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.
public String getDBName()
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:
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:
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:
Oracle
The Oracle System ID (SID) of the created DB instance.
Default: ORCL
Constraints:
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:
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:
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:
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:
Oracle
The Oracle System ID (SID) of the created DB instance.
Default: ORCL
Constraints:
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:
public void setDBName(String dBName)
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:
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:
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:
Oracle
The Oracle System ID (SID) of the created DB instance.
Default: ORCL
Constraints:
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:
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:
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:
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:
Oracle
The Oracle System ID (SID) of the created DB instance.
Default: ORCL
Constraints:
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:
public CreateDBInstanceRequest withDBName(String dBName)
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:
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:
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:
Oracle
The Oracle System ID (SID) of the created DB instance.
Default: ORCL
Constraints:
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:
Returns a reference to this object so that method calls can be chained together.
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:
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:
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:
Oracle
The Oracle System ID (SID) of the created DB instance.
Default: ORCL
Constraints:
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:
public String getDBInstanceIdentifier()
Constraints:
Example:
mydbinstance
Constraints:
Example:
mydbinstance
public void setDBInstanceIdentifier(String dBInstanceIdentifier)
Constraints:
Example:
mydbinstance
dBInstanceIdentifier
- The DB instance identifier. This parameter is stored as a lowercase
string. Constraints:
Example:
mydbinstance
public CreateDBInstanceRequest withDBInstanceIdentifier(String dBInstanceIdentifier)
Constraints:
Example:
mydbinstance
Returns a reference to this object so that method calls can be chained together.
dBInstanceIdentifier
- The DB instance identifier. This parameter is stored as a lowercase
string. Constraints:
Example:
mydbinstance
public Integer getAllocatedStorage()
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)
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)
public void setAllocatedStorage(Integer allocatedStorage)
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)
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)
public CreateDBInstanceRequest withAllocatedStorage(Integer allocatedStorage)
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 a reference to this object so that method calls can be chained together.
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)
public String getDBInstanceClass()
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
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
public void setDBInstanceClass(String dBInstanceClass)
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
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
public CreateDBInstanceRequest withDBInstanceClass(String dBInstanceClass)
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 a reference to this object so that method calls can be chained together.
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
public String getEngine()
Valid Values: MySQL
| mariadb
|
oracle-se1
| oracle-se
|
oracle-ee
| sqlserver-ee
|
sqlserver-se
| sqlserver-ex
|
sqlserver-web
| postgres
Not every database engine is available for every AWS region.
Valid Values: MySQL
| mariadb
|
oracle-se1
| oracle-se
|
oracle-ee
| sqlserver-ee
|
sqlserver-se
| sqlserver-ex
|
sqlserver-web
| postgres
Not every database engine is available for every AWS region.
public void setEngine(String engine)
Valid Values: MySQL
| mariadb
|
oracle-se1
| oracle-se
|
oracle-ee
| sqlserver-ee
|
sqlserver-se
| sqlserver-ex
|
sqlserver-web
| postgres
Not every database engine is available for every AWS region.
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
Not every database engine is available for every AWS region.
public CreateDBInstanceRequest withEngine(String engine)
Valid Values: MySQL
| mariadb
|
oracle-se1
| oracle-se
|
oracle-ee
| sqlserver-ee
|
sqlserver-se
| sqlserver-ex
|
sqlserver-web
| postgres
Not every database engine is available for every AWS region.
Returns a reference to this object so that method calls can be chained together.
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
Not every database engine is available for every AWS region.
public String getMasterUsername()
MySQL
Constraints:
MariaDB
Constraints:
Type: String
Oracle
Constraints:
SQL Server
Constraints:
PostgreSQL
Constraints:
MySQL
Constraints:
MariaDB
Constraints:
Type: String
Oracle
Constraints:
SQL Server
Constraints:
PostgreSQL
Constraints:
public void setMasterUsername(String masterUsername)
MySQL
Constraints:
MariaDB
Constraints:
Type: String
Oracle
Constraints:
SQL Server
Constraints:
PostgreSQL
Constraints:
masterUsername
- The name of master user for the client DB instance. MySQL
Constraints:
MariaDB
Constraints:
Type: String
Oracle
Constraints:
SQL Server
Constraints:
PostgreSQL
Constraints:
public CreateDBInstanceRequest withMasterUsername(String masterUsername)
MySQL
Constraints:
MariaDB
Constraints:
Type: String
Oracle
Constraints:
SQL Server
Constraints:
PostgreSQL
Constraints:
Returns a reference to this object so that method calls can be chained together.
masterUsername
- The name of master user for the client DB instance. MySQL
Constraints:
MariaDB
Constraints:
Type: String
Oracle
Constraints:
SQL Server
Constraints:
PostgreSQL
Constraints:
public String getMasterUserPassword()
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.
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.
public void setMasterUserPassword(String masterUserPassword)
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.
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.
public CreateDBInstanceRequest withMasterUserPassword(String masterUserPassword)
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 a reference to this object so that method calls can be chained together.
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.
public List<String> getDBSecurityGroups()
Default: The default DB security group for the database engine.
Default: The default DB security group for the database engine.
public void setDBSecurityGroups(Collection<String> dBSecurityGroups)
Default: The default DB security group for the database engine.
dBSecurityGroups
- A list of DB security groups to associate with this DB instance. Default: The default DB security group for the database engine.
public CreateDBInstanceRequest withDBSecurityGroups(String... dBSecurityGroups)
Default: The default DB security group for the database engine.
NOTE: This method appends the values to the existing list (if
any). Use setDBSecurityGroups(java.util.Collection)
or withDBSecurityGroups(java.util.Collection)
if you want to override
the existing values.
Returns a reference to this object so that method calls can be chained together.
dBSecurityGroups
- A list of DB security groups to associate with this DB instance. Default: The default DB security group for the database engine.
public CreateDBInstanceRequest withDBSecurityGroups(Collection<String> dBSecurityGroups)
Default: The default DB security group for the database engine.
Returns a reference to this object so that method calls can be chained together.
dBSecurityGroups
- A list of DB security groups to associate with this DB instance. Default: The default DB security group for the database engine.
public List<String> getVpcSecurityGroupIds()
Default: The default EC2 VPC security group for the DB subnet group's VPC.
Default: The default EC2 VPC security group for the DB subnet group's VPC.
public void setVpcSecurityGroupIds(Collection<String> vpcSecurityGroupIds)
Default: The default EC2 VPC security group for the DB subnet group's VPC.
vpcSecurityGroupIds
- A list of EC2 VPC security groups to associate with this DB instance.
Default: The default EC2 VPC security group for the DB subnet group's VPC.
public CreateDBInstanceRequest withVpcSecurityGroupIds(String... vpcSecurityGroupIds)
Default: The default EC2 VPC security group for the DB subnet group's VPC.
NOTE: This method appends the values to the existing list (if
any). Use setVpcSecurityGroupIds(java.util.Collection)
or
withVpcSecurityGroupIds(java.util.Collection)
if you want to
override the existing values.
Returns a reference to this object so that method calls can be chained together.
vpcSecurityGroupIds
- A list of EC2 VPC security groups to associate with this DB instance.
Default: The default EC2 VPC security group for the DB subnet group's VPC.
public CreateDBInstanceRequest withVpcSecurityGroupIds(Collection<String> vpcSecurityGroupIds)
Default: The default EC2 VPC security group for the DB subnet group's VPC.
Returns a reference to this object so that method calls can be chained together.
vpcSecurityGroupIds
- A list of EC2 VPC security groups to associate with this DB instance.
Default: The default EC2 VPC security group for the DB subnet group's VPC.
public String getAvailabilityZone()
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.
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.
public void setAvailabilityZone(String availabilityZone)
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.
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.
public CreateDBInstanceRequest withAvailabilityZone(String availabilityZone)
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 a reference to this object so that method calls can be chained together.
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.
public String getDBSubnetGroupName()
If there is no DB subnet group, then it is a non-VPC DB instance.
If there is no DB subnet group, then it is a non-VPC DB instance.
public void setDBSubnetGroupName(String dBSubnetGroupName)
If there is no DB subnet group, then it is a non-VPC DB instance.
dBSubnetGroupName
- A DB subnet group to associate with this DB instance. If there is no DB subnet group, then it is a non-VPC DB instance.
public CreateDBInstanceRequest withDBSubnetGroupName(String dBSubnetGroupName)
If there is no DB subnet group, then it is a non-VPC DB instance.
Returns a reference to this object so that method calls can be chained together.
dBSubnetGroupName
- A DB subnet group to associate with this DB instance. If there is no DB subnet group, then it is a non-VPC DB instance.
public String getPreferredMaintenanceWindow()
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.
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.
public void setPreferredMaintenanceWindow(String preferredMaintenanceWindow)
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.
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.
public CreateDBInstanceRequest withPreferredMaintenanceWindow(String preferredMaintenanceWindow)
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 a reference to this object so that method calls can be chained together.
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.
public String getDBParameterGroupName()
Constraints:
Constraints:
public void setDBParameterGroupName(String dBParameterGroupName)
Constraints:
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:
public CreateDBInstanceRequest withDBParameterGroupName(String dBParameterGroupName)
Constraints:
Returns a reference to this object so that method calls can be chained together.
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:
public Integer getBackupRetentionPeriod()
Default: 1
Constraints:
Default: 1
Constraints:
public void setBackupRetentionPeriod(Integer backupRetentionPeriod)
Default: 1
Constraints:
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:
public CreateDBInstanceRequest withBackupRetentionPeriod(Integer backupRetentionPeriod)
Default: 1
Constraints:
Returns a reference to this object so that method calls can be chained together.
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:
public String getPreferredBackupWindow()
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:
hh24:mi-hh24:mi
.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:
hh24:mi-hh24:mi
.public void setPreferredBackupWindow(String preferredBackupWindow)
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:
hh24:mi-hh24:mi
.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:
hh24:mi-hh24:mi
.public CreateDBInstanceRequest withPreferredBackupWindow(String preferredBackupWindow)
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:
hh24:mi-hh24:mi
.Returns a reference to this object so that method calls can be chained together.
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:
hh24:mi-hh24:mi
.public Integer getPort()
MySQL
Default: 3306
Valid Values:
1150-65535
Type: Integer
MariaDB
Default: 3306
Valid Values: 1150-65535
Type: Integer
PostgreSQL
Default: 5432
Valid Values: 1150-65535
Type: Integer
Oracle
Default: 1521
Valid Values:
1150-65535
SQL Server
Default:
1433
Valid Values: 1150-65535
except for
1434
, 3389
, 47001
,
49152
, and 49152
through 49156
.
Amazon Aurora
Default: 3306
Valid
Values: 1150-65535
Type: Integer
MySQL
Default: 3306
Valid Values:
1150-65535
Type: Integer
MariaDB
Default: 3306
Valid Values: 1150-65535
Type: Integer
PostgreSQL
Default: 5432
Valid Values: 1150-65535
Type: Integer
Oracle
Default: 1521
Valid Values:
1150-65535
SQL Server
Default:
1433
Valid Values: 1150-65535
except for
1434
, 3389
, 47001
,
49152
, and 49152
through 49156
.
Amazon Aurora
Default: 3306
Valid
Values: 1150-65535
Type: Integer
public void setPort(Integer port)
MySQL
Default: 3306
Valid Values:
1150-65535
Type: Integer
MariaDB
Default: 3306
Valid Values: 1150-65535
Type: Integer
PostgreSQL
Default: 5432
Valid Values: 1150-65535
Type: Integer
Oracle
Default: 1521
Valid Values:
1150-65535
SQL Server
Default:
1433
Valid Values: 1150-65535
except for
1434
, 3389
, 47001
,
49152
, and 49152
through 49156
.
Amazon Aurora
Default: 3306
Valid
Values: 1150-65535
Type: Integer
port
- The port number on which the database accepts connections. MySQL
Default: 3306
Valid Values:
1150-65535
Type: Integer
MariaDB
Default: 3306
Valid Values: 1150-65535
Type: Integer
PostgreSQL
Default: 5432
Valid Values: 1150-65535
Type: Integer
Oracle
Default: 1521
Valid Values:
1150-65535
SQL Server
Default:
1433
Valid Values: 1150-65535
except for
1434
, 3389
, 47001
,
49152
, and 49152
through 49156
.
Amazon Aurora
Default: 3306
Valid
Values: 1150-65535
Type: Integer
public CreateDBInstanceRequest withPort(Integer port)
MySQL
Default: 3306
Valid Values:
1150-65535
Type: Integer
MariaDB
Default: 3306
Valid Values: 1150-65535
Type: Integer
PostgreSQL
Default: 5432
Valid Values: 1150-65535
Type: Integer
Oracle
Default: 1521
Valid Values:
1150-65535
SQL Server
Default:
1433
Valid Values: 1150-65535
except for
1434
, 3389
, 47001
,
49152
, and 49152
through 49156
.
Amazon Aurora
Default: 3306
Valid
Values: 1150-65535
Type: Integer
Returns a reference to this object so that method calls can be chained together.
port
- The port number on which the database accepts connections. MySQL
Default: 3306
Valid Values:
1150-65535
Type: Integer
MariaDB
Default: 3306
Valid Values: 1150-65535
Type: Integer
PostgreSQL
Default: 5432
Valid Values: 1150-65535
Type: Integer
Oracle
Default: 1521
Valid Values:
1150-65535
SQL Server
Default:
1433
Valid Values: 1150-65535
except for
1434
, 3389
, 47001
,
49152
, and 49152
through 49156
.
Amazon Aurora
Default: 3306
Valid
Values: 1150-65535
Type: Integer
public Boolean isMultiAZ()
public void setMultiAZ(Boolean multiAZ)
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.public CreateDBInstanceRequest withMultiAZ(Boolean multiAZ)
Returns a reference to this object so that method calls can be chained together.
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.public Boolean getMultiAZ()
public String getEngineVersion()
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
5.1.73a | 5.1.73b
5.5.40 | 5.5.40a
5.5.40b | 5.5.41 | 5.5.42
5.6.19a |
5.6.19b | 5.6.21 | 5.6.21b | 5.6.22 | 5.6.23
MariaDB
10.0.17
Oracle Database Enterprise Edition (oracle-ee)
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
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
12.1.0.1.v1 | 12.1.0.1.v2 | 12.1.0.2.v1
Oracle Database Standard Edition (oracle-se)
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
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
12.1.0.1.v1 | 12.1.0.1.v2
Oracle Database Standard Edition One (oracle-se1)
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
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
12.1.0.1.v1 | 12.1.0.1.v2
PostgreSQL
9.3.1 |
9.3.2
9.3.3 | 9.3.5 | 9.3.6
9.4.1
Microsoft SQL Server Enterprise Edition (sqlserver-ee)
10.50.2789.0.v1
10.50.6000.34.v1
11.00.2100.60.v1
11.00.5058.0.v1
Microsoft SQL Server Express Edition (sqlserver-ex)
10.50.2789.0.v1
10.50.6000.34.v1
11.00.2100.60.v1
11.00.5058.0.v1
12.00.4422.0.v1
Microsoft SQL Server Standard Edition (sqlserver-se)
10.50.2789.0.v1
10.50.6000.34.v1
11.00.2100.60.v1
11.00.5058.0.v1
12.00.4422.0.v1
Microsoft SQL Server Web Edition (sqlserver-web)
10.50.2789.0.v1
10.50.6000.34.v1
11.00.2100.60.v1
11.00.5058.0.v1
12.00.4422.0.v1
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
5.1.73a | 5.1.73b
5.5.40 | 5.5.40a
5.5.40b | 5.5.41 | 5.5.42
5.6.19a |
5.6.19b | 5.6.21 | 5.6.21b | 5.6.22 | 5.6.23
MariaDB
10.0.17
Oracle Database Enterprise Edition (oracle-ee)
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
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
12.1.0.1.v1 | 12.1.0.1.v2 | 12.1.0.2.v1
Oracle Database Standard Edition (oracle-se)
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
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
12.1.0.1.v1 | 12.1.0.1.v2
Oracle Database Standard Edition One (oracle-se1)
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
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
12.1.0.1.v1 | 12.1.0.1.v2
PostgreSQL
9.3.1 |
9.3.2
9.3.3 | 9.3.5 | 9.3.6
9.4.1
Microsoft SQL Server Enterprise Edition (sqlserver-ee)
10.50.2789.0.v1
10.50.6000.34.v1
11.00.2100.60.v1
11.00.5058.0.v1
Microsoft SQL Server Express Edition (sqlserver-ex)
10.50.2789.0.v1
10.50.6000.34.v1
11.00.2100.60.v1
11.00.5058.0.v1
12.00.4422.0.v1
Microsoft SQL Server Standard Edition (sqlserver-se)
10.50.2789.0.v1
10.50.6000.34.v1
11.00.2100.60.v1
11.00.5058.0.v1
12.00.4422.0.v1
Microsoft SQL Server Web Edition (sqlserver-web)
10.50.2789.0.v1
10.50.6000.34.v1
11.00.2100.60.v1
11.00.5058.0.v1
12.00.4422.0.v1
public void setEngineVersion(String engineVersion)
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
5.1.73a | 5.1.73b
5.5.40 | 5.5.40a
5.5.40b | 5.5.41 | 5.5.42
5.6.19a |
5.6.19b | 5.6.21 | 5.6.21b | 5.6.22 | 5.6.23
MariaDB
10.0.17
Oracle Database Enterprise Edition (oracle-ee)
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
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
12.1.0.1.v1 | 12.1.0.1.v2 | 12.1.0.2.v1
Oracle Database Standard Edition (oracle-se)
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
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
12.1.0.1.v1 | 12.1.0.1.v2
Oracle Database Standard Edition One (oracle-se1)
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
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
12.1.0.1.v1 | 12.1.0.1.v2
PostgreSQL
9.3.1 |
9.3.2
9.3.3 | 9.3.5 | 9.3.6
9.4.1
Microsoft SQL Server Enterprise Edition (sqlserver-ee)
10.50.2789.0.v1
10.50.6000.34.v1
11.00.2100.60.v1
11.00.5058.0.v1
Microsoft SQL Server Express Edition (sqlserver-ex)
10.50.2789.0.v1
10.50.6000.34.v1
11.00.2100.60.v1
11.00.5058.0.v1
12.00.4422.0.v1
Microsoft SQL Server Standard Edition (sqlserver-se)
10.50.2789.0.v1
10.50.6000.34.v1
11.00.2100.60.v1
11.00.5058.0.v1
12.00.4422.0.v1
Microsoft SQL Server Web Edition (sqlserver-web)
10.50.2789.0.v1
10.50.6000.34.v1
11.00.2100.60.v1
11.00.5058.0.v1
12.00.4422.0.v1
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
5.1.73a | 5.1.73b
5.5.40 | 5.5.40a
5.5.40b | 5.5.41 | 5.5.42
5.6.19a |
5.6.19b | 5.6.21 | 5.6.21b | 5.6.22 | 5.6.23
MariaDB
10.0.17
Oracle Database Enterprise Edition (oracle-ee)
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
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
12.1.0.1.v1 | 12.1.0.1.v2 | 12.1.0.2.v1
Oracle Database Standard Edition (oracle-se)
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
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
12.1.0.1.v1 | 12.1.0.1.v2
Oracle Database Standard Edition One (oracle-se1)
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
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
12.1.0.1.v1 | 12.1.0.1.v2
PostgreSQL
9.3.1 |
9.3.2
9.3.3 | 9.3.5 | 9.3.6
9.4.1
Microsoft SQL Server Enterprise Edition (sqlserver-ee)
10.50.2789.0.v1
10.50.6000.34.v1
11.00.2100.60.v1
11.00.5058.0.v1
Microsoft SQL Server Express Edition (sqlserver-ex)
10.50.2789.0.v1
10.50.6000.34.v1
11.00.2100.60.v1
11.00.5058.0.v1
12.00.4422.0.v1
Microsoft SQL Server Standard Edition (sqlserver-se)
10.50.2789.0.v1
10.50.6000.34.v1
11.00.2100.60.v1
11.00.5058.0.v1
12.00.4422.0.v1
Microsoft SQL Server Web Edition (sqlserver-web)
10.50.2789.0.v1
10.50.6000.34.v1
11.00.2100.60.v1
11.00.5058.0.v1
12.00.4422.0.v1
public CreateDBInstanceRequest withEngineVersion(String engineVersion)
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
5.1.73a | 5.1.73b
5.5.40 | 5.5.40a
5.5.40b | 5.5.41 | 5.5.42
5.6.19a |
5.6.19b | 5.6.21 | 5.6.21b | 5.6.22 | 5.6.23
MariaDB
10.0.17
Oracle Database Enterprise Edition (oracle-ee)
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
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
12.1.0.1.v1 | 12.1.0.1.v2 | 12.1.0.2.v1
Oracle Database Standard Edition (oracle-se)
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
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
12.1.0.1.v1 | 12.1.0.1.v2
Oracle Database Standard Edition One (oracle-se1)
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
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
12.1.0.1.v1 | 12.1.0.1.v2
PostgreSQL
9.3.1 |
9.3.2
9.3.3 | 9.3.5 | 9.3.6
9.4.1
Microsoft SQL Server Enterprise Edition (sqlserver-ee)
10.50.2789.0.v1
10.50.6000.34.v1
11.00.2100.60.v1
11.00.5058.0.v1
Microsoft SQL Server Express Edition (sqlserver-ex)
10.50.2789.0.v1
10.50.6000.34.v1
11.00.2100.60.v1
11.00.5058.0.v1
12.00.4422.0.v1
Microsoft SQL Server Standard Edition (sqlserver-se)
10.50.2789.0.v1
10.50.6000.34.v1
11.00.2100.60.v1
11.00.5058.0.v1
12.00.4422.0.v1
Microsoft SQL Server Web Edition (sqlserver-web)
10.50.2789.0.v1
10.50.6000.34.v1
11.00.2100.60.v1
11.00.5058.0.v1
12.00.4422.0.v1
Returns a reference to this object so that method calls can be chained together.
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
5.1.73a | 5.1.73b
5.5.40 | 5.5.40a
5.5.40b | 5.5.41 | 5.5.42
5.6.19a |
5.6.19b | 5.6.21 | 5.6.21b | 5.6.22 | 5.6.23
MariaDB
10.0.17
Oracle Database Enterprise Edition (oracle-ee)
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
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
12.1.0.1.v1 | 12.1.0.1.v2 | 12.1.0.2.v1
Oracle Database Standard Edition (oracle-se)
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
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
12.1.0.1.v1 | 12.1.0.1.v2
Oracle Database Standard Edition One (oracle-se1)
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
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
12.1.0.1.v1 | 12.1.0.1.v2
PostgreSQL
9.3.1 |
9.3.2
9.3.3 | 9.3.5 | 9.3.6
9.4.1
Microsoft SQL Server Enterprise Edition (sqlserver-ee)
10.50.2789.0.v1
10.50.6000.34.v1
11.00.2100.60.v1
11.00.5058.0.v1
Microsoft SQL Server Express Edition (sqlserver-ex)
10.50.2789.0.v1
10.50.6000.34.v1
11.00.2100.60.v1
11.00.5058.0.v1
12.00.4422.0.v1
Microsoft SQL Server Standard Edition (sqlserver-se)
10.50.2789.0.v1
10.50.6000.34.v1
11.00.2100.60.v1
11.00.5058.0.v1
12.00.4422.0.v1
Microsoft SQL Server Web Edition (sqlserver-web)
10.50.2789.0.v1
10.50.6000.34.v1
11.00.2100.60.v1
11.00.5058.0.v1
12.00.4422.0.v1
public Boolean isAutoMinorVersionUpgrade()
Default:
true
Default:
true
public void setAutoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade)
Default:
true
autoMinorVersionUpgrade
- Indicates that minor engine upgrades will be applied automatically to
the DB instance during the maintenance window. Default:
true
public CreateDBInstanceRequest withAutoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade)
Default:
true
Returns a reference to this object so that method calls can be chained together.
autoMinorVersionUpgrade
- Indicates that minor engine upgrades will be applied automatically to
the DB instance during the maintenance window. Default:
true
public Boolean getAutoMinorVersionUpgrade()
Default:
true
Default:
true
public String getLicenseModel()
Valid values:
license-included
| bring-your-own-license
|
general-public-license
Valid values:
license-included
| bring-your-own-license
|
general-public-license
public void setLicenseModel(String licenseModel)
Valid values:
license-included
| bring-your-own-license
|
general-public-license
licenseModel
- License model information for this DB instance. Valid values:
license-included
| bring-your-own-license
|
general-public-license
public CreateDBInstanceRequest withLicenseModel(String licenseModel)
Valid values:
license-included
| bring-your-own-license
|
general-public-license
Returns a reference to this object so that method calls can be chained together.
licenseModel
- License model information for this DB instance. Valid values:
license-included
| bring-your-own-license
|
general-public-license
public Integer getIops()
Constraints: To use PIOPS, this value must be an integer greater than 1000.
Constraints: To use PIOPS, this value must be an integer greater than 1000.
public void setIops(Integer iops)
Constraints: To use PIOPS, this value must be an integer greater than 1000.
iops
- The amount of Provisioned IOPS (input/output operations per second) to
be initially allocated for the DB instance. Constraints: To use PIOPS, this value must be an integer greater than 1000.
public CreateDBInstanceRequest withIops(Integer iops)
Constraints: To use PIOPS, this value must be an integer greater than 1000.
Returns a reference to this object so that method calls can be chained together.
iops
- The amount of Provisioned IOPS (input/output operations per second) to
be initially allocated for the DB instance. Constraints: To use PIOPS, this value must be an integer greater than 1000.
public String getOptionGroupName()
Permanent options, such as the TDE option for Oracle Advanced Security TDE, cannot be removed from an option group, and that option group cannot be removed from a DB instance once it is associated with a DB instance
Permanent options, such as the TDE option for Oracle Advanced Security TDE, cannot be removed from an option group, and that option group cannot be removed from a DB instance once it is associated with a DB instance
public void setOptionGroupName(String optionGroupName)
Permanent options, such as the TDE option for Oracle Advanced Security TDE, cannot be removed from an option group, and that option group cannot be removed from a DB instance once it is associated with a DB instance
optionGroupName
- Indicates that the DB instance should be associated with the specified
option group. Permanent options, such as the TDE option for Oracle Advanced Security TDE, cannot be removed from an option group, and that option group cannot be removed from a DB instance once it is associated with a DB instance
public CreateDBInstanceRequest withOptionGroupName(String optionGroupName)
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 a reference to this object so that method calls can be chained together.
optionGroupName
- Indicates that the DB instance should be associated with the specified
option group. Permanent options, such as the TDE option for Oracle Advanced Security TDE, cannot be removed from an option group, and that option group cannot be removed from a DB instance once it is associated with a DB instance
public String getCharacterSetName()
public void setCharacterSetName(String characterSetName)
characterSetName
- For supported engines, indicates that the DB instance should be
associated with the specified CharacterSet.public CreateDBInstanceRequest withCharacterSetName(String characterSetName)
Returns a reference to this object so that method calls can be chained together.
characterSetName
- For supported engines, indicates that the DB instance should be
associated with the specified CharacterSet.public Boolean isPubliclyAccessible()
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.
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.
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.
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.
public void setPubliclyAccessible(Boolean publiclyAccessible)
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.
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.
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.
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.
public CreateDBInstanceRequest withPubliclyAccessible(Boolean publiclyAccessible)
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.
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 a reference to this object so that method calls can be chained together.
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.
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.
public Boolean getPubliclyAccessible()
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.
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.
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.
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.
public void setTags(Collection<Tag> tags)
tags
- A list of tags.public CreateDBInstanceRequest withTags(Tag... tags)
NOTE: This method appends the values to the existing list (if
any). Use setTags(java.util.Collection)
or withTags(java.util.Collection)
if you want to override the existing
values.
Returns a reference to this object so that method calls can be chained together.
tags
- A list of tags.public CreateDBInstanceRequest withTags(Collection<Tag> tags)
Returns a reference to this object so that method calls can be chained together.
tags
- A list of tags.public String getDBClusterIdentifier()
For information on creating a DB cluster, see CreateDBCluster.
Type: String
For information on creating a DB cluster, see CreateDBCluster.
Type: String
public void setDBClusterIdentifier(String dBClusterIdentifier)
For information on creating a DB cluster, see CreateDBCluster.
Type: String
dBClusterIdentifier
- The identifier of the DB cluster that the instance will belong to.
For information on creating a DB cluster, see CreateDBCluster.
Type: String
public CreateDBInstanceRequest withDBClusterIdentifier(String dBClusterIdentifier)
For information on creating a DB cluster, see CreateDBCluster.
Type: String
Returns a reference to this object so that method calls can be chained together.
dBClusterIdentifier
- The identifier of the DB cluster that the instance will belong to.
For information on creating a DB cluster, see CreateDBCluster.
Type: String
public String getStorageType()
Valid values: standard | gp2 | io1
If you specify
io1
, you must also include a value for the
Iops
parameter.
Default: io1
if the
Iops
parameter is specified; otherwise
standard
Valid values: standard | gp2 | io1
If you specify
io1
, you must also include a value for the
Iops
parameter.
Default: io1
if the
Iops
parameter is specified; otherwise
standard
public void setStorageType(String storageType)
Valid values: standard | gp2 | io1
If you specify
io1
, you must also include a value for the
Iops
parameter.
Default: io1
if the
Iops
parameter is specified; otherwise
standard
storageType
- Specifies the storage type to be associated with the DB instance.
Valid values: standard | gp2 | io1
If you specify
io1
, you must also include a value for the
Iops
parameter.
Default: io1
if the
Iops
parameter is specified; otherwise
standard
public CreateDBInstanceRequest withStorageType(String storageType)
Valid values: standard | gp2 | io1
If you specify
io1
, you must also include a value for the
Iops
parameter.
Default: io1
if the
Iops
parameter is specified; otherwise
standard
Returns a reference to this object so that method calls can be chained together.
storageType
- Specifies the storage type to be associated with the DB instance.
Valid values: standard | gp2 | io1
If you specify
io1
, you must also include a value for the
Iops
parameter.
Default: io1
if the
Iops
parameter is specified; otherwise
standard
public String getTdeCredentialArn()
public void setTdeCredentialArn(String tdeCredentialArn)
tdeCredentialArn
- The ARN from the Key Store with which to associate the instance for
TDE encryption.public CreateDBInstanceRequest withTdeCredentialArn(String tdeCredentialArn)
Returns a reference to this object so that method calls can be chained together.
tdeCredentialArn
- The ARN from the Key Store with which to associate the instance for
TDE encryption.public String getTdeCredentialPassword()
public void setTdeCredentialPassword(String tdeCredentialPassword)
tdeCredentialPassword
- The password for the given ARN from the Key Store in order to access
the device.public CreateDBInstanceRequest withTdeCredentialPassword(String tdeCredentialPassword)
Returns a reference to this object so that method calls can be chained together.
tdeCredentialPassword
- The password for the given ARN from the Key Store in order to access
the device.public Boolean isStorageEncrypted()
Default: false
Default: false
public void setStorageEncrypted(Boolean storageEncrypted)
Default: false
storageEncrypted
- Specifies whether the DB instance is encrypted. Default: false
public CreateDBInstanceRequest withStorageEncrypted(Boolean storageEncrypted)
Default: false
Returns a reference to this object so that method calls can be chained together.
storageEncrypted
- Specifies whether the DB instance is encrypted. Default: false
public Boolean getStorageEncrypted()
Default: false
Default: false
public String getKmsKeyId()
The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are creating a DB instance with the same AWS account that owns the KMS encryption key used to encrypt the new DB instance, then you can use the KMS key alias instead of the ARN for the KM encryption key.
If the StorageEncrypted
parameter is true, and
you do not specify a value for the KmsKeyId
parameter,
then Amazon RDS will use your default encryption key. AWS KMS creates
the default encryption key for your AWS account. Your AWS account has
a different default encryption key for each AWS region.
The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are creating a DB instance with the same AWS account that owns the KMS encryption key used to encrypt the new DB instance, then you can use the KMS key alias instead of the ARN for the KM encryption key.
If the StorageEncrypted
parameter is true, and
you do not specify a value for the KmsKeyId
parameter,
then Amazon RDS will use your default encryption key. AWS KMS creates
the default encryption key for your AWS account. Your AWS account has
a different default encryption key for each AWS region.
public void setKmsKeyId(String kmsKeyId)
The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are creating a DB instance with the same AWS account that owns the KMS encryption key used to encrypt the new DB instance, then you can use the KMS key alias instead of the ARN for the KM encryption key.
If the StorageEncrypted
parameter is true, and
you do not specify a value for the KmsKeyId
parameter,
then Amazon RDS will use your default encryption key. AWS KMS creates
the default encryption key for your AWS account. Your AWS account has
a different default encryption key for each AWS region.
kmsKeyId
- The KMS key identifier for an encrypted DB instance. The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are creating a DB instance with the same AWS account that owns the KMS encryption key used to encrypt the new DB instance, then you can use the KMS key alias instead of the ARN for the KM encryption key.
If the StorageEncrypted
parameter is true, and
you do not specify a value for the KmsKeyId
parameter,
then Amazon RDS will use your default encryption key. AWS KMS creates
the default encryption key for your AWS account. Your AWS account has
a different default encryption key for each AWS region.
public CreateDBInstanceRequest withKmsKeyId(String kmsKeyId)
The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are creating a DB instance with the same AWS account that owns the KMS encryption key used to encrypt the new DB instance, then you can use the KMS key alias instead of the ARN for the KM encryption key.
If the StorageEncrypted
parameter is true, and
you do not specify a value for the KmsKeyId
parameter,
then Amazon RDS will use your default encryption key. AWS KMS creates
the default encryption key for your AWS account. Your AWS account has
a different default encryption key for each AWS region.
Returns a reference to this object so that method calls can be chained together.
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 the KmsKeyId
parameter,
then Amazon RDS will use your default encryption key. AWS KMS creates
the default encryption key for your AWS account. Your AWS account has
a different default encryption key for each AWS region.
public Boolean isCopyTagsToSnapshot()
public void setCopyTagsToSnapshot(Boolean copyTagsToSnapshot)
copyTagsToSnapshot
- True to copy all tags from the DB instance to snapshots of the DB
instance; otherwise false. The default is false.public CreateDBInstanceRequest withCopyTagsToSnapshot(Boolean copyTagsToSnapshot)
Returns a reference to this object so that method calls can be chained together.
copyTagsToSnapshot
- True to copy all tags from the DB instance to snapshots of the DB
instance; otherwise false. The default is false.public Boolean getCopyTagsToSnapshot()
public String toString()
toString
in class Object
Object.toString()
public CreateDBInstanceRequest clone()
AmazonWebServiceRequest
clone
in class AmazonWebServiceRequest
Object.clone()
Copyright © 2015. All rights reserved.