@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class CreateDBInstanceRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
NOOP
Constructor and Description |
---|
CreateDBInstanceRequest()
Default constructor for CreateDBInstanceRequest object.
|
CreateDBInstanceRequest(String dBInstanceIdentifier,
Integer allocatedStorage,
String dBInstanceClass,
String engine,
String masterUsername,
String masterUserPassword)
Constructs a new CreateDBInstanceRequest object.
|
Modifier and Type | Method and Description |
---|---|
CreateDBInstanceRequest |
clone()
Creates a shallow clone of this object for all fields except the handler context.
|
boolean |
equals(Object obj) |
Integer |
getAllocatedStorage()
The amount of storage (in gibibytes) to allocate for the DB instance.
|
Boolean |
getAutoMinorVersionUpgrade()
A value that indicates whether minor engine upgrades are applied automatically to the DB instance during the
maintenance window.
|
String |
getAvailabilityZone()
The Availability Zone (AZ) where the database will be created.
|
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()
A value that indicates whether to copy tags from the DB instance to snapshots of the DB instance.
|
String |
getDBClusterIdentifier()
The identifier of the DB cluster that the instance will belong to.
|
String |
getDBInstanceClass()
The compute and memory capacity of the DB instance, for example,
db.m4.large . |
String |
getDBInstanceIdentifier()
The DB instance identifier.
|
String |
getDBName()
The meaning of this parameter differs according to the database engine you use.
|
String |
getDBParameterGroupName()
The name of the DB parameter group to associate with this DB instance.
|
List<String> |
getDBSecurityGroups()
A list of DB security groups to associate with this DB instance.
|
String |
getDBSubnetGroupName()
A DB subnet group to associate with this DB instance.
|
Boolean |
getDeletionProtection()
A value that indicates whether the DB instance has deletion protection enabled.
|
String |
getDomain()
The Active Directory directory ID to create the DB instance in.
|
String |
getDomainIAMRoleName()
Specify the name of the IAM role to be used when making API calls to the Directory Service.
|
List<String> |
getEnableCloudwatchLogsExports()
The list of log types that need to be enabled for exporting to CloudWatch Logs.
|
Boolean |
getEnableIAMDatabaseAuthentication()
A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database
accounts.
|
Boolean |
getEnablePerformanceInsights()
A value that indicates whether to enable Performance Insights for the 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 AWS KMS key identifier for an encrypted DB instance.
|
String |
getLicenseModel()
License model information for this DB instance.
|
String |
getMasterUsername()
The name for the master user.
|
String |
getMasterUserPassword()
The password for the master user.
|
Integer |
getMaxAllocatedStorage()
The upper limit to which Amazon RDS can automatically scale the storage of the DB instance.
|
Integer |
getMonitoringInterval()
The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance.
|
String |
getMonitoringRoleArn()
The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs.
|
Boolean |
getMultiAZ()
A value that indicates whether the DB instance is a Multi-AZ deployment.
|
String |
getOptionGroupName()
Indicates that the DB instance should be associated with the specified option group.
|
String |
getPerformanceInsightsKMSKeyId()
The AWS KMS key identifier for encryption of Performance Insights data.
|
Integer |
getPerformanceInsightsRetentionPeriod()
The amount of time, in days, to retain Performance Insights data.
|
Integer |
getPort()
The port number on which the database accepts connections.
|
String |
getPreferredBackupWindow()
The daily time range during which automated backups are created if automated backups are enabled, using the
BackupRetentionPeriod parameter. |
String |
getPreferredMaintenanceWindow()
The time range each week during which system maintenance can occur, in Universal Coordinated Time (UTC).
|
List<ProcessorFeature> |
getProcessorFeatures()
The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
|
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()
A value that indicates whether the DB instance is publicly accessible.
|
Boolean |
getStorageEncrypted()
A value that indicates whether the DB instance is encrypted.
|
String |
getStorageType()
Specifies the storage type to be associated with the DB instance.
|
List<Tag> |
getTags()
Tags to assign to the DB instance.
|
String |
getTdeCredentialArn()
The ARN from the key store with which to associate the instance for TDE encryption.
|
String |
getTdeCredentialPassword()
The password for the given ARN from the key store in order to access the device.
|
String |
getTimezone()
The time zone of the DB instance.
|
List<String> |
getVpcSecurityGroupIds()
A list of Amazon EC2 VPC security groups to associate with this DB instance.
|
int |
hashCode() |
Boolean |
isAutoMinorVersionUpgrade()
A value that indicates whether minor engine upgrades are applied automatically to the DB instance during the
maintenance window.
|
Boolean |
isCopyTagsToSnapshot()
A value that indicates whether to copy tags from the DB instance to snapshots of the DB instance.
|
Boolean |
isDeletionProtection()
A value that indicates whether the DB instance has deletion protection enabled.
|
Boolean |
isEnableIAMDatabaseAuthentication()
A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database
accounts.
|
Boolean |
isEnablePerformanceInsights()
A value that indicates whether to enable Performance Insights for the DB instance.
|
Boolean |
isMultiAZ()
A value that indicates whether the DB instance is a Multi-AZ deployment.
|
Boolean |
isPubliclyAccessible()
A value that indicates whether the DB instance is publicly accessible.
|
Boolean |
isStorageEncrypted()
A value that indicates whether the DB instance is encrypted.
|
void |
setAllocatedStorage(Integer allocatedStorage)
The amount of storage (in gibibytes) to allocate for the DB instance.
|
void |
setAutoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade)
A value that indicates whether minor engine upgrades are applied automatically to the DB instance during the
maintenance window.
|
void |
setAvailabilityZone(String availabilityZone)
The Availability Zone (AZ) where the database will be created.
|
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)
A value that indicates whether to copy tags from the DB instance to snapshots of the DB instance.
|
void |
setDBClusterIdentifier(String dBClusterIdentifier)
The identifier of the DB cluster that the instance will belong to.
|
void |
setDBInstanceClass(String dBInstanceClass)
The compute and memory capacity of the DB instance, for example,
db.m4.large . |
void |
setDBInstanceIdentifier(String dBInstanceIdentifier)
The DB instance identifier.
|
void |
setDBName(String dBName)
The meaning of this parameter differs according to the database engine you use.
|
void |
setDBParameterGroupName(String dBParameterGroupName)
The name of the DB parameter group to associate with this DB instance.
|
void |
setDBSecurityGroups(Collection<String> dBSecurityGroups)
A list of DB security groups to associate with this DB instance.
|
void |
setDBSubnetGroupName(String dBSubnetGroupName)
A DB subnet group to associate with this DB instance.
|
void |
setDeletionProtection(Boolean deletionProtection)
A value that indicates whether the DB instance has deletion protection enabled.
|
void |
setDomain(String domain)
The Active Directory directory ID to create the DB 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 |
setEnableCloudwatchLogsExports(Collection<String> enableCloudwatchLogsExports)
The list of log types that need to be enabled for exporting to CloudWatch Logs.
|
void |
setEnableIAMDatabaseAuthentication(Boolean enableIAMDatabaseAuthentication)
A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database
accounts.
|
void |
setEnablePerformanceInsights(Boolean enablePerformanceInsights)
A value that indicates whether to enable Performance Insights for the DB instance.
|
void |
setEngine(String engine)
The name of the database engine to be used for this instance.
|
void |
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 AWS KMS key identifier for an encrypted DB instance.
|
void |
setLicenseModel(String licenseModel)
License model information for this DB instance.
|
void |
setMasterUsername(String masterUsername)
The name for the master user.
|
void |
setMasterUserPassword(String masterUserPassword)
The password for the master user.
|
void |
setMaxAllocatedStorage(Integer maxAllocatedStorage)
The upper limit to which Amazon RDS can automatically scale the storage of the DB instance.
|
void |
setMonitoringInterval(Integer monitoringInterval)
The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance.
|
void |
setMonitoringRoleArn(String monitoringRoleArn)
The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs.
|
void |
setMultiAZ(Boolean multiAZ)
A value that indicates whether the DB instance is a Multi-AZ deployment.
|
void |
setOptionGroupName(String optionGroupName)
Indicates that the DB instance should be associated with the specified option group.
|
void |
setPerformanceInsightsKMSKeyId(String performanceInsightsKMSKeyId)
The AWS KMS key identifier for encryption of Performance Insights data.
|
void |
setPerformanceInsightsRetentionPeriod(Integer performanceInsightsRetentionPeriod)
The amount of time, in days, to retain Performance Insights data.
|
void |
setPort(Integer port)
The port number on which the database accepts connections.
|
void |
setPreferredBackupWindow(String preferredBackupWindow)
The daily time range during which automated backups are created if automated backups are enabled, using the
BackupRetentionPeriod parameter. |
void |
setPreferredMaintenanceWindow(String preferredMaintenanceWindow)
The time range each week during which system maintenance can occur, in Universal Coordinated Time (UTC).
|
void |
setProcessorFeatures(Collection<ProcessorFeature> processorFeatures)
The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
|
void |
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)
A value that indicates whether the DB instance is publicly accessible.
|
void |
setStorageEncrypted(Boolean storageEncrypted)
A value that indicates 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)
Tags to assign to the DB instance.
|
void |
setTdeCredentialArn(String tdeCredentialArn)
The ARN from the key store with which to associate the instance for TDE encryption.
|
void |
setTdeCredentialPassword(String tdeCredentialPassword)
The password for the given ARN from the key store in order to access the device.
|
void |
setTimezone(String timezone)
The time zone of the DB instance.
|
void |
setVpcSecurityGroupIds(Collection<String> vpcSecurityGroupIds)
A list of Amazon EC2 VPC security groups to associate with this DB instance.
|
String |
toString()
Returns a string representation of this object.
|
CreateDBInstanceRequest |
withAllocatedStorage(Integer allocatedStorage)
The amount of storage (in gibibytes) to allocate for the DB instance.
|
CreateDBInstanceRequest |
withAutoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade)
A value that indicates whether minor engine upgrades are applied automatically to the DB instance during the
maintenance window.
|
CreateDBInstanceRequest |
withAvailabilityZone(String availabilityZone)
The Availability Zone (AZ) where the database will be created.
|
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)
A value that indicates whether to copy tags from the DB instance to snapshots of the DB instance.
|
CreateDBInstanceRequest |
withDBClusterIdentifier(String dBClusterIdentifier)
The identifier of the DB cluster that the instance will belong to.
|
CreateDBInstanceRequest |
withDBInstanceClass(String dBInstanceClass)
The compute and memory capacity of the DB instance, for example,
db.m4.large . |
CreateDBInstanceRequest |
withDBInstanceIdentifier(String dBInstanceIdentifier)
The DB instance identifier.
|
CreateDBInstanceRequest |
withDBName(String dBName)
The meaning of this parameter differs according to the database engine you use.
|
CreateDBInstanceRequest |
withDBParameterGroupName(String dBParameterGroupName)
The name of the DB parameter group to associate with this DB instance.
|
CreateDBInstanceRequest |
withDBSecurityGroups(Collection<String> dBSecurityGroups)
A list of DB security groups to associate with this DB instance.
|
CreateDBInstanceRequest |
withDBSecurityGroups(String... dBSecurityGroups)
A list of DB security groups to associate with this DB instance.
|
CreateDBInstanceRequest |
withDBSubnetGroupName(String dBSubnetGroupName)
A DB subnet group to associate with this DB instance.
|
CreateDBInstanceRequest |
withDeletionProtection(Boolean deletionProtection)
A value that indicates whether the DB instance has deletion protection enabled.
|
CreateDBInstanceRequest |
withDomain(String domain)
The Active Directory directory ID to create the DB 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 |
withEnableCloudwatchLogsExports(Collection<String> enableCloudwatchLogsExports)
The list of log types that need to be enabled for exporting to CloudWatch Logs.
|
CreateDBInstanceRequest |
withEnableCloudwatchLogsExports(String... enableCloudwatchLogsExports)
The list of log types that need to be enabled for exporting to CloudWatch Logs.
|
CreateDBInstanceRequest |
withEnableIAMDatabaseAuthentication(Boolean enableIAMDatabaseAuthentication)
A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database
accounts.
|
CreateDBInstanceRequest |
withEnablePerformanceInsights(Boolean enablePerformanceInsights)
A value that indicates whether to enable Performance Insights for the 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 AWS KMS key identifier for an encrypted DB instance.
|
CreateDBInstanceRequest |
withLicenseModel(String licenseModel)
License model information for this DB instance.
|
CreateDBInstanceRequest |
withMasterUsername(String masterUsername)
The name for the master user.
|
CreateDBInstanceRequest |
withMasterUserPassword(String masterUserPassword)
The password for the master user.
|
CreateDBInstanceRequest |
withMaxAllocatedStorage(Integer maxAllocatedStorage)
The upper limit to which Amazon RDS can automatically scale the storage of the DB instance.
|
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 Amazon CloudWatch Logs.
|
CreateDBInstanceRequest |
withMultiAZ(Boolean multiAZ)
A value that indicates whether the DB instance is a Multi-AZ deployment.
|
CreateDBInstanceRequest |
withOptionGroupName(String optionGroupName)
Indicates that the DB instance should be associated with the specified option group.
|
CreateDBInstanceRequest |
withPerformanceInsightsKMSKeyId(String performanceInsightsKMSKeyId)
The AWS KMS key identifier for encryption of Performance Insights data.
|
CreateDBInstanceRequest |
withPerformanceInsightsRetentionPeriod(Integer performanceInsightsRetentionPeriod)
The amount of time, in days, to retain Performance Insights data.
|
CreateDBInstanceRequest |
withPort(Integer port)
The port number on which the database accepts connections.
|
CreateDBInstanceRequest |
withPreferredBackupWindow(String preferredBackupWindow)
The daily time range during which automated backups are created if automated backups are enabled, using the
BackupRetentionPeriod parameter. |
CreateDBInstanceRequest |
withPreferredMaintenanceWindow(String preferredMaintenanceWindow)
The time range each week during which system maintenance can occur, in Universal Coordinated Time (UTC).
|
CreateDBInstanceRequest |
withProcessorFeatures(Collection<ProcessorFeature> processorFeatures)
The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
|
CreateDBInstanceRequest |
withProcessorFeatures(ProcessorFeature... processorFeatures)
The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
|
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)
A value that indicates whether the DB instance is publicly accessible.
|
CreateDBInstanceRequest |
withStorageEncrypted(Boolean storageEncrypted)
A value that indicates 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)
Tags to assign to the DB instance.
|
CreateDBInstanceRequest |
withTags(Tag... tags)
Tags to assign to the DB instance.
|
CreateDBInstanceRequest |
withTdeCredentialArn(String tdeCredentialArn)
The ARN from the key store with which to associate the instance for TDE encryption.
|
CreateDBInstanceRequest |
withTdeCredentialPassword(String tdeCredentialPassword)
The password for the given ARN from the key store in order to access the device.
|
CreateDBInstanceRequest |
withTimezone(String timezone)
The time zone of the DB instance.
|
CreateDBInstanceRequest |
withVpcSecurityGroupIds(Collection<String> vpcSecurityGroupIds)
A list of Amazon EC2 VPC security groups to associate with this DB instance.
|
CreateDBInstanceRequest |
withVpcSecurityGroupIds(String... vpcSecurityGroupIds)
A list of Amazon EC2 VPC security groups to associate with this DB instance.
|
addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout
public CreateDBInstanceRequest()
public CreateDBInstanceRequest(String dBInstanceIdentifier, Integer allocatedStorage, String dBInstanceClass, String engine, String masterUsername, String masterUserPassword)
dBInstanceIdentifier
- The DB instance identifier. This parameter is stored as a lowercase string.
Constraints:
Must contain from 1 to 63 letters, numbers, or hyphens.
First character must be a letter.
Can't end with a hyphen or contain two consecutive hyphens.
Example: mydbinstance
allocatedStorage
- The amount of storage (in gibibytes) to allocate for the DB instance.
Type: Integer
Amazon Aurora
Not applicable. Aurora cluster volumes automatically grow as the amount of data in your database increases, though you are only charged for the space that you use in an Aurora cluster volume.
MySQL
Constraints to the amount of storage for each storage type are the following:
General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536.
Provisioned IOPS storage (io1): Must be an integer from 100 to 65536.
Magnetic storage (standard): Must be an integer from 5 to 3072.
MariaDB
Constraints to the amount of storage for each storage type are the following:
General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536.
Provisioned IOPS storage (io1): Must be an integer from 100 to 65536.
Magnetic storage (standard): Must be an integer from 5 to 3072.
PostgreSQL
Constraints to the amount of storage for each storage type are the following:
General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536.
Provisioned IOPS storage (io1): Must be an integer from 100 to 65536.
Magnetic storage (standard): Must be an integer from 5 to 3072.
Oracle
Constraints to the amount of storage for each storage type are the following:
General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536.
Provisioned IOPS storage (io1): Must be an integer from 100 to 65536.
Magnetic storage (standard): Must be an integer from 10 to 3072.
SQL Server
Constraints to the amount of storage for each storage type are the following:
General Purpose (SSD) storage (gp2):
Enterprise and Standard editions: Must be an integer from 200 to 16384.
Web and Express editions: Must be an integer from 20 to 16384.
Provisioned IOPS storage (io1):
Enterprise and Standard editions: Must be an integer from 200 to 16384.
Web and Express editions: Must be an integer from 100 to 16384.
Magnetic storage (standard):
Enterprise and Standard editions: Must be an integer from 200 to 1024.
Web and Express editions: Must be an integer from 20 to 1024.
dBInstanceClass
- The compute and memory capacity of the DB instance, for example, db.m4.large
. Not all DB
instance classes are available in all AWS Regions, or for all database engines. For the full list of DB
instance classes, and availability for your engine, see DB Instance
Class in the Amazon RDS User Guide.engine
- The name of the database engine to be used for this instance.
Not every database engine is available for every AWS Region.
Valid Values:
aurora
(for MySQL 5.6-compatible Aurora)
aurora-mysql
(for MySQL 5.7-compatible Aurora)
aurora-postgresql
mariadb
mysql
oracle-ee
oracle-se2
oracle-se1
oracle-se
postgres
sqlserver-ee
sqlserver-se
sqlserver-ex
sqlserver-web
masterUsername
- The name for the master user.
Amazon Aurora
Not applicable. The name for the master user is managed by the DB cluster.
MariaDB
Constraints:
Required for MariaDB.
Must be 1 to 16 letters or numbers.
Can't be a reserved word for the chosen database engine.
Microsoft SQL Server
Constraints:
Required for SQL Server.
Must be 1 to 128 letters or numbers.
The first character must be a letter.
Can't be a reserved word for the chosen database engine.
MySQL
Constraints:
Required for MySQL.
Must be 1 to 16 letters or numbers.
First character must be a letter.
Can't be a reserved word for the chosen database engine.
Oracle
Constraints:
Required for Oracle.
Must be 1 to 30 letters or numbers.
First character must be a letter.
Can't be a reserved word for the chosen database engine.
PostgreSQL
Constraints:
Required for PostgreSQL.
Must be 1 to 63 letters or numbers.
First character must be a letter.
Can't be a reserved word for the chosen database engine.
masterUserPassword
- The password for the master user. The password can include any printable ASCII character except "/",
""", or "@".
Amazon Aurora
Not applicable. The password for the master user is managed by the DB cluster.
MariaDB
Constraints: Must contain from 8 to 41 characters.
Microsoft SQL Server
Constraints: Must contain from 8 to 128 characters.
MySQL
Constraints: Must contain from 8 to 41 characters.
Oracle
Constraints: Must contain from 8 to 30 characters.
PostgreSQL
Constraints: Must contain from 8 to 128 characters.
public void setDBName(String dBName)
The meaning of this parameter differs according to the database engine you use.
MySQL
The name of the database to create when the DB instance is created. If this parameter isn't specified, no database is created in the DB instance.
Constraints:
Must contain 1 to 64 letters or numbers.
Can't 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 isn't specified, no database is created in the DB instance.
Constraints:
Must contain 1 to 64 letters or numbers.
Can't 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 isn't specified, the default "postgres" database is created in the DB instance.
Constraints:
Must contain 1 to 63 letters, numbers, or underscores.
Must begin with a letter or an underscore. Subsequent characters can be letters, underscores, or digits (0-9).
Can't be a word reserved by the specified database engine
Oracle
The Oracle System ID (SID) of the created DB instance. If you specify null
, the default value
ORCL
is used. You can't specify the string NULL, or any other reserved word, for DBName
.
Default: ORCL
Constraints:
Can't 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 isn't specified, no database is created in the DB instance.
Constraints:
Must contain 1 to 64 letters or numbers.
Can't be a word reserved by the specified database engine
dBName
- The meaning of this parameter differs according to the database engine you use.
MySQL
The name of the database to create when the DB instance is created. If this parameter isn't specified, no database is created in the DB instance.
Constraints:
Must contain 1 to 64 letters or numbers.
Can't 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 isn't specified, no database is created in the DB instance.
Constraints:
Must contain 1 to 64 letters or numbers.
Can't 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 isn't specified, the default "postgres" database is created in the DB instance.
Constraints:
Must contain 1 to 63 letters, numbers, or underscores.
Must begin with a letter or an underscore. Subsequent characters can be letters, underscores, or digits (0-9).
Can't be a word reserved by the specified database engine
Oracle
The Oracle System ID (SID) of the created DB instance. If you specify null
, the default value
ORCL
is used. You can't specify the string NULL, or any other reserved word, for
DBName
.
Default: ORCL
Constraints:
Can't 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 isn't specified, no database is created in the DB instance.
Constraints:
Must contain 1 to 64 letters or numbers.
Can't be a word reserved by the specified database engine
public String getDBName()
The meaning of this parameter differs according to the database engine you use.
MySQL
The name of the database to create when the DB instance is created. If this parameter isn't specified, no database is created in the DB instance.
Constraints:
Must contain 1 to 64 letters or numbers.
Can't 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 isn't specified, no database is created in the DB instance.
Constraints:
Must contain 1 to 64 letters or numbers.
Can't 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 isn't specified, the default "postgres" database is created in the DB instance.
Constraints:
Must contain 1 to 63 letters, numbers, or underscores.
Must begin with a letter or an underscore. Subsequent characters can be letters, underscores, or digits (0-9).
Can't be a word reserved by the specified database engine
Oracle
The Oracle System ID (SID) of the created DB instance. If you specify null
, the default value
ORCL
is used. You can't specify the string NULL, or any other reserved word, for DBName
.
Default: ORCL
Constraints:
Can't 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 isn't specified, no database is created in the DB instance.
Constraints:
Must contain 1 to 64 letters or numbers.
Can't be a word reserved by the specified database engine
MySQL
The name of the database to create when the DB instance is created. If this parameter isn't specified, no database is created in the DB instance.
Constraints:
Must contain 1 to 64 letters or numbers.
Can't 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 isn't specified, no database is created in the DB instance.
Constraints:
Must contain 1 to 64 letters or numbers.
Can't 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 isn't specified, the default "postgres" database is created in the DB instance.
Constraints:
Must contain 1 to 63 letters, numbers, or underscores.
Must begin with a letter or an underscore. Subsequent characters can be letters, underscores, or digits (0-9).
Can't be a word reserved by the specified database engine
Oracle
The Oracle System ID (SID) of the created DB instance. If you specify null
, the default
value ORCL
is used. You can't specify the string NULL, or any other reserved word, for
DBName
.
Default: ORCL
Constraints:
Can't 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 isn't specified, no database is created in the DB instance.
Constraints:
Must contain 1 to 64 letters or numbers.
Can't be a word reserved by the specified database engine
public CreateDBInstanceRequest withDBName(String dBName)
The meaning of this parameter differs according to the database engine you use.
MySQL
The name of the database to create when the DB instance is created. If this parameter isn't specified, no database is created in the DB instance.
Constraints:
Must contain 1 to 64 letters or numbers.
Can't 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 isn't specified, no database is created in the DB instance.
Constraints:
Must contain 1 to 64 letters or numbers.
Can't 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 isn't specified, the default "postgres" database is created in the DB instance.
Constraints:
Must contain 1 to 63 letters, numbers, or underscores.
Must begin with a letter or an underscore. Subsequent characters can be letters, underscores, or digits (0-9).
Can't be a word reserved by the specified database engine
Oracle
The Oracle System ID (SID) of the created DB instance. If you specify null
, the default value
ORCL
is used. You can't specify the string NULL, or any other reserved word, for DBName
.
Default: ORCL
Constraints:
Can't 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 isn't specified, no database is created in the DB instance.
Constraints:
Must contain 1 to 64 letters or numbers.
Can't be a word reserved by the specified database engine
dBName
- The meaning of this parameter differs according to the database engine you use.
MySQL
The name of the database to create when the DB instance is created. If this parameter isn't specified, no database is created in the DB instance.
Constraints:
Must contain 1 to 64 letters or numbers.
Can't 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 isn't specified, no database is created in the DB instance.
Constraints:
Must contain 1 to 64 letters or numbers.
Can't 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 isn't specified, the default "postgres" database is created in the DB instance.
Constraints:
Must contain 1 to 63 letters, numbers, or underscores.
Must begin with a letter or an underscore. Subsequent characters can be letters, underscores, or digits (0-9).
Can't be a word reserved by the specified database engine
Oracle
The Oracle System ID (SID) of the created DB instance. If you specify null
, the default value
ORCL
is used. You can't specify the string NULL, or any other reserved word, for
DBName
.
Default: ORCL
Constraints:
Can't 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 isn't specified, no database is created in the DB instance.
Constraints:
Must contain 1 to 64 letters or numbers.
Can't be a word reserved by the specified database engine
public void setDBInstanceIdentifier(String dBInstanceIdentifier)
The DB instance identifier. This parameter is stored as a lowercase string.
Constraints:
Must contain from 1 to 63 letters, numbers, or hyphens.
First character must be a letter.
Can't end with a hyphen or contain two consecutive hyphens.
Example: mydbinstance
dBInstanceIdentifier
- The DB instance identifier. This parameter is stored as a lowercase string.
Constraints:
Must contain from 1 to 63 letters, numbers, or hyphens.
First character must be a letter.
Can't end with a hyphen or contain two consecutive hyphens.
Example: mydbinstance
public String getDBInstanceIdentifier()
The DB instance identifier. This parameter is stored as a lowercase string.
Constraints:
Must contain from 1 to 63 letters, numbers, or hyphens.
First character must be a letter.
Can't end with a hyphen or contain two consecutive hyphens.
Example: mydbinstance
Constraints:
Must contain from 1 to 63 letters, numbers, or hyphens.
First character must be a letter.
Can't end with a hyphen or contain two consecutive hyphens.
Example: mydbinstance
public CreateDBInstanceRequest withDBInstanceIdentifier(String dBInstanceIdentifier)
The DB instance identifier. This parameter is stored as a lowercase string.
Constraints:
Must contain from 1 to 63 letters, numbers, or hyphens.
First character must be a letter.
Can't end with a hyphen or contain two consecutive hyphens.
Example: mydbinstance
dBInstanceIdentifier
- The DB instance identifier. This parameter is stored as a lowercase string.
Constraints:
Must contain from 1 to 63 letters, numbers, or hyphens.
First character must be a letter.
Can't end with a hyphen or contain two consecutive hyphens.
Example: mydbinstance
public void setAllocatedStorage(Integer allocatedStorage)
The amount of storage (in gibibytes) to allocate for the DB instance.
Type: Integer
Amazon Aurora
Not applicable. Aurora cluster volumes automatically grow as the amount of data in your database increases, though you are only charged for the space that you use in an Aurora cluster volume.
MySQL
Constraints to the amount of storage for each storage type are the following:
General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536.
Provisioned IOPS storage (io1): Must be an integer from 100 to 65536.
Magnetic storage (standard): Must be an integer from 5 to 3072.
MariaDB
Constraints to the amount of storage for each storage type are the following:
General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536.
Provisioned IOPS storage (io1): Must be an integer from 100 to 65536.
Magnetic storage (standard): Must be an integer from 5 to 3072.
PostgreSQL
Constraints to the amount of storage for each storage type are the following:
General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536.
Provisioned IOPS storage (io1): Must be an integer from 100 to 65536.
Magnetic storage (standard): Must be an integer from 5 to 3072.
Oracle
Constraints to the amount of storage for each storage type are the following:
General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536.
Provisioned IOPS storage (io1): Must be an integer from 100 to 65536.
Magnetic storage (standard): Must be an integer from 10 to 3072.
SQL Server
Constraints to the amount of storage for each storage type are the following:
General Purpose (SSD) storage (gp2):
Enterprise and Standard editions: Must be an integer from 200 to 16384.
Web and Express editions: Must be an integer from 20 to 16384.
Provisioned IOPS storage (io1):
Enterprise and Standard editions: Must be an integer from 200 to 16384.
Web and Express editions: Must be an integer from 100 to 16384.
Magnetic storage (standard):
Enterprise and Standard editions: Must be an integer from 200 to 1024.
Web and Express editions: Must be an integer from 20 to 1024.
allocatedStorage
- The amount of storage (in gibibytes) to allocate for the DB instance.
Type: Integer
Amazon Aurora
Not applicable. Aurora cluster volumes automatically grow as the amount of data in your database increases, though you are only charged for the space that you use in an Aurora cluster volume.
MySQL
Constraints to the amount of storage for each storage type are the following:
General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536.
Provisioned IOPS storage (io1): Must be an integer from 100 to 65536.
Magnetic storage (standard): Must be an integer from 5 to 3072.
MariaDB
Constraints to the amount of storage for each storage type are the following:
General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536.
Provisioned IOPS storage (io1): Must be an integer from 100 to 65536.
Magnetic storage (standard): Must be an integer from 5 to 3072.
PostgreSQL
Constraints to the amount of storage for each storage type are the following:
General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536.
Provisioned IOPS storage (io1): Must be an integer from 100 to 65536.
Magnetic storage (standard): Must be an integer from 5 to 3072.
Oracle
Constraints to the amount of storage for each storage type are the following:
General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536.
Provisioned IOPS storage (io1): Must be an integer from 100 to 65536.
Magnetic storage (standard): Must be an integer from 10 to 3072.
SQL Server
Constraints to the amount of storage for each storage type are the following:
General Purpose (SSD) storage (gp2):
Enterprise and Standard editions: Must be an integer from 200 to 16384.
Web and Express editions: Must be an integer from 20 to 16384.
Provisioned IOPS storage (io1):
Enterprise and Standard editions: Must be an integer from 200 to 16384.
Web and Express editions: Must be an integer from 100 to 16384.
Magnetic storage (standard):
Enterprise and Standard editions: Must be an integer from 200 to 1024.
Web and Express editions: Must be an integer from 20 to 1024.
public Integer getAllocatedStorage()
The amount of storage (in gibibytes) to allocate for the DB instance.
Type: Integer
Amazon Aurora
Not applicable. Aurora cluster volumes automatically grow as the amount of data in your database increases, though you are only charged for the space that you use in an Aurora cluster volume.
MySQL
Constraints to the amount of storage for each storage type are the following:
General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536.
Provisioned IOPS storage (io1): Must be an integer from 100 to 65536.
Magnetic storage (standard): Must be an integer from 5 to 3072.
MariaDB
Constraints to the amount of storage for each storage type are the following:
General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536.
Provisioned IOPS storage (io1): Must be an integer from 100 to 65536.
Magnetic storage (standard): Must be an integer from 5 to 3072.
PostgreSQL
Constraints to the amount of storage for each storage type are the following:
General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536.
Provisioned IOPS storage (io1): Must be an integer from 100 to 65536.
Magnetic storage (standard): Must be an integer from 5 to 3072.
Oracle
Constraints to the amount of storage for each storage type are the following:
General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536.
Provisioned IOPS storage (io1): Must be an integer from 100 to 65536.
Magnetic storage (standard): Must be an integer from 10 to 3072.
SQL Server
Constraints to the amount of storage for each storage type are the following:
General Purpose (SSD) storage (gp2):
Enterprise and Standard editions: Must be an integer from 200 to 16384.
Web and Express editions: Must be an integer from 20 to 16384.
Provisioned IOPS storage (io1):
Enterprise and Standard editions: Must be an integer from 200 to 16384.
Web and Express editions: Must be an integer from 100 to 16384.
Magnetic storage (standard):
Enterprise and Standard editions: Must be an integer from 200 to 1024.
Web and Express editions: Must be an integer from 20 to 1024.
Type: Integer
Amazon Aurora
Not applicable. Aurora cluster volumes automatically grow as the amount of data in your database increases, though you are only charged for the space that you use in an Aurora cluster volume.
MySQL
Constraints to the amount of storage for each storage type are the following:
General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536.
Provisioned IOPS storage (io1): Must be an integer from 100 to 65536.
Magnetic storage (standard): Must be an integer from 5 to 3072.
MariaDB
Constraints to the amount of storage for each storage type are the following:
General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536.
Provisioned IOPS storage (io1): Must be an integer from 100 to 65536.
Magnetic storage (standard): Must be an integer from 5 to 3072.
PostgreSQL
Constraints to the amount of storage for each storage type are the following:
General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536.
Provisioned IOPS storage (io1): Must be an integer from 100 to 65536.
Magnetic storage (standard): Must be an integer from 5 to 3072.
Oracle
Constraints to the amount of storage for each storage type are the following:
General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536.
Provisioned IOPS storage (io1): Must be an integer from 100 to 65536.
Magnetic storage (standard): Must be an integer from 10 to 3072.
SQL Server
Constraints to the amount of storage for each storage type are the following:
General Purpose (SSD) storage (gp2):
Enterprise and Standard editions: Must be an integer from 200 to 16384.
Web and Express editions: Must be an integer from 20 to 16384.
Provisioned IOPS storage (io1):
Enterprise and Standard editions: Must be an integer from 200 to 16384.
Web and Express editions: Must be an integer from 100 to 16384.
Magnetic storage (standard):
Enterprise and Standard editions: Must be an integer from 200 to 1024.
Web and Express editions: Must be an integer from 20 to 1024.
public CreateDBInstanceRequest withAllocatedStorage(Integer allocatedStorage)
The amount of storage (in gibibytes) to allocate for the DB instance.
Type: Integer
Amazon Aurora
Not applicable. Aurora cluster volumes automatically grow as the amount of data in your database increases, though you are only charged for the space that you use in an Aurora cluster volume.
MySQL
Constraints to the amount of storage for each storage type are the following:
General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536.
Provisioned IOPS storage (io1): Must be an integer from 100 to 65536.
Magnetic storage (standard): Must be an integer from 5 to 3072.
MariaDB
Constraints to the amount of storage for each storage type are the following:
General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536.
Provisioned IOPS storage (io1): Must be an integer from 100 to 65536.
Magnetic storage (standard): Must be an integer from 5 to 3072.
PostgreSQL
Constraints to the amount of storage for each storage type are the following:
General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536.
Provisioned IOPS storage (io1): Must be an integer from 100 to 65536.
Magnetic storage (standard): Must be an integer from 5 to 3072.
Oracle
Constraints to the amount of storage for each storage type are the following:
General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536.
Provisioned IOPS storage (io1): Must be an integer from 100 to 65536.
Magnetic storage (standard): Must be an integer from 10 to 3072.
SQL Server
Constraints to the amount of storage for each storage type are the following:
General Purpose (SSD) storage (gp2):
Enterprise and Standard editions: Must be an integer from 200 to 16384.
Web and Express editions: Must be an integer from 20 to 16384.
Provisioned IOPS storage (io1):
Enterprise and Standard editions: Must be an integer from 200 to 16384.
Web and Express editions: Must be an integer from 100 to 16384.
Magnetic storage (standard):
Enterprise and Standard editions: Must be an integer from 200 to 1024.
Web and Express editions: Must be an integer from 20 to 1024.
allocatedStorage
- The amount of storage (in gibibytes) to allocate for the DB instance.
Type: Integer
Amazon Aurora
Not applicable. Aurora cluster volumes automatically grow as the amount of data in your database increases, though you are only charged for the space that you use in an Aurora cluster volume.
MySQL
Constraints to the amount of storage for each storage type are the following:
General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536.
Provisioned IOPS storage (io1): Must be an integer from 100 to 65536.
Magnetic storage (standard): Must be an integer from 5 to 3072.
MariaDB
Constraints to the amount of storage for each storage type are the following:
General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536.
Provisioned IOPS storage (io1): Must be an integer from 100 to 65536.
Magnetic storage (standard): Must be an integer from 5 to 3072.
PostgreSQL
Constraints to the amount of storage for each storage type are the following:
General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536.
Provisioned IOPS storage (io1): Must be an integer from 100 to 65536.
Magnetic storage (standard): Must be an integer from 5 to 3072.
Oracle
Constraints to the amount of storage for each storage type are the following:
General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536.
Provisioned IOPS storage (io1): Must be an integer from 100 to 65536.
Magnetic storage (standard): Must be an integer from 10 to 3072.
SQL Server
Constraints to the amount of storage for each storage type are the following:
General Purpose (SSD) storage (gp2):
Enterprise and Standard editions: Must be an integer from 200 to 16384.
Web and Express editions: Must be an integer from 20 to 16384.
Provisioned IOPS storage (io1):
Enterprise and Standard editions: Must be an integer from 200 to 16384.
Web and Express editions: Must be an integer from 100 to 16384.
Magnetic storage (standard):
Enterprise and Standard editions: Must be an integer from 200 to 1024.
Web and Express editions: Must be an integer from 20 to 1024.
public void setDBInstanceClass(String dBInstanceClass)
The compute and memory capacity of the DB instance, for example, db.m4.large
. Not all DB instance
classes are available in all AWS Regions, or for all database engines. For the full list of DB instance classes,
and availability for your engine, see DB Instance Class
in the Amazon RDS User Guide.
dBInstanceClass
- The compute and memory capacity of the DB instance, for example, db.m4.large
. Not all DB
instance classes are available in all AWS Regions, or for all database engines. For the full list of DB
instance classes, and availability for your engine, see DB Instance
Class in the Amazon RDS User Guide.public String getDBInstanceClass()
The compute and memory capacity of the DB instance, for example, db.m4.large
. Not all DB instance
classes are available in all AWS Regions, or for all database engines. For the full list of DB instance classes,
and availability for your engine, see DB Instance Class
in the Amazon RDS User Guide.
db.m4.large
. Not all DB
instance classes are available in all AWS Regions, or for all database engines. For the full list of DB
instance classes, and availability for your engine, see DB Instance
Class in the Amazon RDS User Guide.public CreateDBInstanceRequest withDBInstanceClass(String dBInstanceClass)
The compute and memory capacity of the DB instance, for example, db.m4.large
. Not all DB instance
classes are available in all AWS Regions, or for all database engines. For the full list of DB instance classes,
and availability for your engine, see DB Instance Class
in the Amazon RDS User Guide.
dBInstanceClass
- The compute and memory capacity of the DB instance, for example, db.m4.large
. Not all DB
instance classes are available in all AWS Regions, or for all database engines. For the full list of DB
instance classes, and availability for your engine, see DB Instance
Class in the Amazon RDS User Guide.public void setEngine(String engine)
The name of the database engine to be used for this instance.
Not every database engine is available for every AWS Region.
Valid Values:
aurora
(for MySQL 5.6-compatible Aurora)
aurora-mysql
(for MySQL 5.7-compatible Aurora)
aurora-postgresql
mariadb
mysql
oracle-ee
oracle-se2
oracle-se1
oracle-se
postgres
sqlserver-ee
sqlserver-se
sqlserver-ex
sqlserver-web
engine
- The name of the database engine to be used for this instance.
Not every database engine is available for every AWS Region.
Valid Values:
aurora
(for MySQL 5.6-compatible Aurora)
aurora-mysql
(for MySQL 5.7-compatible Aurora)
aurora-postgresql
mariadb
mysql
oracle-ee
oracle-se2
oracle-se1
oracle-se
postgres
sqlserver-ee
sqlserver-se
sqlserver-ex
sqlserver-web
public String getEngine()
The name of the database engine to be used for this instance.
Not every database engine is available for every AWS Region.
Valid Values:
aurora
(for MySQL 5.6-compatible Aurora)
aurora-mysql
(for MySQL 5.7-compatible Aurora)
aurora-postgresql
mariadb
mysql
oracle-ee
oracle-se2
oracle-se1
oracle-se
postgres
sqlserver-ee
sqlserver-se
sqlserver-ex
sqlserver-web
Not every database engine is available for every AWS Region.
Valid Values:
aurora
(for MySQL 5.6-compatible Aurora)
aurora-mysql
(for MySQL 5.7-compatible Aurora)
aurora-postgresql
mariadb
mysql
oracle-ee
oracle-se2
oracle-se1
oracle-se
postgres
sqlserver-ee
sqlserver-se
sqlserver-ex
sqlserver-web
public CreateDBInstanceRequest withEngine(String engine)
The name of the database engine to be used for this instance.
Not every database engine is available for every AWS Region.
Valid Values:
aurora
(for MySQL 5.6-compatible Aurora)
aurora-mysql
(for MySQL 5.7-compatible Aurora)
aurora-postgresql
mariadb
mysql
oracle-ee
oracle-se2
oracle-se1
oracle-se
postgres
sqlserver-ee
sqlserver-se
sqlserver-ex
sqlserver-web
engine
- The name of the database engine to be used for this instance.
Not every database engine is available for every AWS Region.
Valid Values:
aurora
(for MySQL 5.6-compatible Aurora)
aurora-mysql
(for MySQL 5.7-compatible Aurora)
aurora-postgresql
mariadb
mysql
oracle-ee
oracle-se2
oracle-se1
oracle-se
postgres
sqlserver-ee
sqlserver-se
sqlserver-ex
sqlserver-web
public void setMasterUsername(String masterUsername)
The name for the master user.
Amazon Aurora
Not applicable. The name for the master user is managed by the DB cluster.
MariaDB
Constraints:
Required for MariaDB.
Must be 1 to 16 letters or numbers.
Can't be a reserved word for the chosen database engine.
Microsoft SQL Server
Constraints:
Required for SQL Server.
Must be 1 to 128 letters or numbers.
The first character must be a letter.
Can't be a reserved word for the chosen database engine.
MySQL
Constraints:
Required for MySQL.
Must be 1 to 16 letters or numbers.
First character must be a letter.
Can't be a reserved word for the chosen database engine.
Oracle
Constraints:
Required for Oracle.
Must be 1 to 30 letters or numbers.
First character must be a letter.
Can't be a reserved word for the chosen database engine.
PostgreSQL
Constraints:
Required for PostgreSQL.
Must be 1 to 63 letters or numbers.
First character must be a letter.
Can't be a reserved word for the chosen database engine.
masterUsername
- The name for the master user.
Amazon Aurora
Not applicable. The name for the master user is managed by the DB cluster.
MariaDB
Constraints:
Required for MariaDB.
Must be 1 to 16 letters or numbers.
Can't be a reserved word for the chosen database engine.
Microsoft SQL Server
Constraints:
Required for SQL Server.
Must be 1 to 128 letters or numbers.
The first character must be a letter.
Can't be a reserved word for the chosen database engine.
MySQL
Constraints:
Required for MySQL.
Must be 1 to 16 letters or numbers.
First character must be a letter.
Can't be a reserved word for the chosen database engine.
Oracle
Constraints:
Required for Oracle.
Must be 1 to 30 letters or numbers.
First character must be a letter.
Can't be a reserved word for the chosen database engine.
PostgreSQL
Constraints:
Required for PostgreSQL.
Must be 1 to 63 letters or numbers.
First character must be a letter.
Can't be a reserved word for the chosen database engine.
public String getMasterUsername()
The name for the master user.
Amazon Aurora
Not applicable. The name for the master user is managed by the DB cluster.
MariaDB
Constraints:
Required for MariaDB.
Must be 1 to 16 letters or numbers.
Can't be a reserved word for the chosen database engine.
Microsoft SQL Server
Constraints:
Required for SQL Server.
Must be 1 to 128 letters or numbers.
The first character must be a letter.
Can't be a reserved word for the chosen database engine.
MySQL
Constraints:
Required for MySQL.
Must be 1 to 16 letters or numbers.
First character must be a letter.
Can't be a reserved word for the chosen database engine.
Oracle
Constraints:
Required for Oracle.
Must be 1 to 30 letters or numbers.
First character must be a letter.
Can't be a reserved word for the chosen database engine.
PostgreSQL
Constraints:
Required for PostgreSQL.
Must be 1 to 63 letters or numbers.
First character must be a letter.
Can't be a reserved word for the chosen database engine.
Amazon Aurora
Not applicable. The name for the master user is managed by the DB cluster.
MariaDB
Constraints:
Required for MariaDB.
Must be 1 to 16 letters or numbers.
Can't be a reserved word for the chosen database engine.
Microsoft SQL Server
Constraints:
Required for SQL Server.
Must be 1 to 128 letters or numbers.
The first character must be a letter.
Can't be a reserved word for the chosen database engine.
MySQL
Constraints:
Required for MySQL.
Must be 1 to 16 letters or numbers.
First character must be a letter.
Can't be a reserved word for the chosen database engine.
Oracle
Constraints:
Required for Oracle.
Must be 1 to 30 letters or numbers.
First character must be a letter.
Can't be a reserved word for the chosen database engine.
PostgreSQL
Constraints:
Required for PostgreSQL.
Must be 1 to 63 letters or numbers.
First character must be a letter.
Can't be a reserved word for the chosen database engine.
public CreateDBInstanceRequest withMasterUsername(String masterUsername)
The name for the master user.
Amazon Aurora
Not applicable. The name for the master user is managed by the DB cluster.
MariaDB
Constraints:
Required for MariaDB.
Must be 1 to 16 letters or numbers.
Can't be a reserved word for the chosen database engine.
Microsoft SQL Server
Constraints:
Required for SQL Server.
Must be 1 to 128 letters or numbers.
The first character must be a letter.
Can't be a reserved word for the chosen database engine.
MySQL
Constraints:
Required for MySQL.
Must be 1 to 16 letters or numbers.
First character must be a letter.
Can't be a reserved word for the chosen database engine.
Oracle
Constraints:
Required for Oracle.
Must be 1 to 30 letters or numbers.
First character must be a letter.
Can't be a reserved word for the chosen database engine.
PostgreSQL
Constraints:
Required for PostgreSQL.
Must be 1 to 63 letters or numbers.
First character must be a letter.
Can't be a reserved word for the chosen database engine.
masterUsername
- The name for the master user.
Amazon Aurora
Not applicable. The name for the master user is managed by the DB cluster.
MariaDB
Constraints:
Required for MariaDB.
Must be 1 to 16 letters or numbers.
Can't be a reserved word for the chosen database engine.
Microsoft SQL Server
Constraints:
Required for SQL Server.
Must be 1 to 128 letters or numbers.
The first character must be a letter.
Can't be a reserved word for the chosen database engine.
MySQL
Constraints:
Required for MySQL.
Must be 1 to 16 letters or numbers.
First character must be a letter.
Can't be a reserved word for the chosen database engine.
Oracle
Constraints:
Required for Oracle.
Must be 1 to 30 letters or numbers.
First character must be a letter.
Can't be a reserved word for the chosen database engine.
PostgreSQL
Constraints:
Required for PostgreSQL.
Must be 1 to 63 letters or numbers.
First character must be a letter.
Can't be a reserved word for the chosen database engine.
public void setMasterUserPassword(String masterUserPassword)
The password for the master user. The password can include any printable ASCII character except "/", """, or "@".
Amazon Aurora
Not applicable. The password for the master user is managed by the DB cluster.
MariaDB
Constraints: Must contain from 8 to 41 characters.
Microsoft SQL Server
Constraints: Must contain from 8 to 128 characters.
MySQL
Constraints: Must contain from 8 to 41 characters.
Oracle
Constraints: Must contain from 8 to 30 characters.
PostgreSQL
Constraints: Must contain from 8 to 128 characters.
masterUserPassword
- The password for the master user. The password can include any printable ASCII character except "/",
""", or "@".
Amazon Aurora
Not applicable. The password for the master user is managed by the DB cluster.
MariaDB
Constraints: Must contain from 8 to 41 characters.
Microsoft SQL Server
Constraints: Must contain from 8 to 128 characters.
MySQL
Constraints: Must contain from 8 to 41 characters.
Oracle
Constraints: Must contain from 8 to 30 characters.
PostgreSQL
Constraints: Must contain from 8 to 128 characters.
public String getMasterUserPassword()
The password for the master user. The password can include any printable ASCII character except "/", """, or "@".
Amazon Aurora
Not applicable. The password for the master user is managed by the DB cluster.
MariaDB
Constraints: Must contain from 8 to 41 characters.
Microsoft SQL Server
Constraints: Must contain from 8 to 128 characters.
MySQL
Constraints: Must contain from 8 to 41 characters.
Oracle
Constraints: Must contain from 8 to 30 characters.
PostgreSQL
Constraints: Must contain from 8 to 128 characters.
Amazon Aurora
Not applicable. The password for the master user is managed by the DB cluster.
MariaDB
Constraints: Must contain from 8 to 41 characters.
Microsoft SQL Server
Constraints: Must contain from 8 to 128 characters.
MySQL
Constraints: Must contain from 8 to 41 characters.
Oracle
Constraints: Must contain from 8 to 30 characters.
PostgreSQL
Constraints: Must contain from 8 to 128 characters.
public CreateDBInstanceRequest withMasterUserPassword(String masterUserPassword)
The password for the master user. The password can include any printable ASCII character except "/", """, or "@".
Amazon Aurora
Not applicable. The password for the master user is managed by the DB cluster.
MariaDB
Constraints: Must contain from 8 to 41 characters.
Microsoft SQL Server
Constraints: Must contain from 8 to 128 characters.
MySQL
Constraints: Must contain from 8 to 41 characters.
Oracle
Constraints: Must contain from 8 to 30 characters.
PostgreSQL
Constraints: Must contain from 8 to 128 characters.
masterUserPassword
- The password for the master user. The password can include any printable ASCII character except "/",
""", or "@".
Amazon Aurora
Not applicable. The password for the master user is managed by the DB cluster.
MariaDB
Constraints: Must contain from 8 to 41 characters.
Microsoft SQL Server
Constraints: Must contain from 8 to 128 characters.
MySQL
Constraints: Must contain from 8 to 41 characters.
Oracle
Constraints: Must contain from 8 to 30 characters.
PostgreSQL
Constraints: Must contain from 8 to 128 characters.
public List<String> getDBSecurityGroups()
A list of DB security groups to associate with this DB instance.
Default: The default DB security group for the database engine.
Default: The default DB security group for the database engine.
public void setDBSecurityGroups(Collection<String> dBSecurityGroups)
A list of DB security groups to associate with this DB instance.
Default: The default DB security group for the database engine.
dBSecurityGroups
- A list of DB security groups to associate with this DB instance.
Default: The default DB security group for the database engine.
public CreateDBInstanceRequest withDBSecurityGroups(String... dBSecurityGroups)
A list of DB security groups to associate with this DB instance.
Default: The default DB security group for the database engine.
NOTE: This method appends the values to the existing list (if any). Use
setDBSecurityGroups(java.util.Collection)
or withDBSecurityGroups(java.util.Collection)
if you
want to override the existing values.
dBSecurityGroups
- A list of DB security groups to associate with this DB instance.
Default: The default DB security group for the database engine.
public CreateDBInstanceRequest withDBSecurityGroups(Collection<String> dBSecurityGroups)
A list of DB security groups to associate with this DB instance.
Default: The default DB security group for the database engine.
dBSecurityGroups
- A list of DB security groups to associate with this DB instance.
Default: The default DB security group for the database engine.
public List<String> getVpcSecurityGroupIds()
A list of Amazon EC2 VPC security groups to associate with this DB instance.
Amazon Aurora
Not applicable. The associated list of EC2 VPC security groups is managed by the DB cluster.
Default: The default EC2 VPC security group for the DB subnet group's VPC.
Amazon Aurora
Not applicable. The associated list of EC2 VPC security groups is managed by the DB cluster.
Default: The default EC2 VPC security group for the DB subnet group's VPC.
public void setVpcSecurityGroupIds(Collection<String> vpcSecurityGroupIds)
A list of Amazon EC2 VPC security groups to associate with this DB instance.
Amazon Aurora
Not applicable. The associated list of EC2 VPC security groups is managed by the DB cluster.
Default: The default EC2 VPC security group for the DB subnet group's VPC.
vpcSecurityGroupIds
- A list of Amazon EC2 VPC security groups to associate with this DB instance.
Amazon Aurora
Not applicable. The associated list of EC2 VPC security groups is managed by the DB cluster.
Default: The default EC2 VPC security group for the DB subnet group's VPC.
public CreateDBInstanceRequest withVpcSecurityGroupIds(String... vpcSecurityGroupIds)
A list of Amazon EC2 VPC security groups to associate with this DB instance.
Amazon Aurora
Not applicable. The associated list of EC2 VPC security groups is managed by the DB cluster.
Default: The default EC2 VPC security group for the DB subnet group's VPC.
NOTE: This method appends the values to the existing list (if any). Use
setVpcSecurityGroupIds(java.util.Collection)
or withVpcSecurityGroupIds(java.util.Collection)
if you want to override the existing values.
vpcSecurityGroupIds
- A list of Amazon EC2 VPC security groups to associate with this DB instance.
Amazon Aurora
Not applicable. The associated list of EC2 VPC security groups is managed by the DB cluster.
Default: The default EC2 VPC security group for the DB subnet group's VPC.
public CreateDBInstanceRequest withVpcSecurityGroupIds(Collection<String> vpcSecurityGroupIds)
A list of Amazon EC2 VPC security groups to associate with this DB instance.
Amazon Aurora
Not applicable. The associated list of EC2 VPC security groups is managed by the DB cluster.
Default: The default EC2 VPC security group for the DB subnet group's VPC.
vpcSecurityGroupIds
- A list of Amazon EC2 VPC security groups to associate with this DB instance.
Amazon Aurora
Not applicable. The associated list of EC2 VPC security groups is managed by the DB cluster.
Default: The default EC2 VPC security group for the DB subnet group's VPC.
public void setAvailabilityZone(String availabilityZone)
The Availability Zone (AZ) where the database will be created. For information on AWS Regions and Availability Zones, see Regions and Availability Zones.
Default: A random, system-chosen Availability Zone in the endpoint's AWS Region.
Example: us-east-1d
Constraint: The AvailabilityZone
parameter can't be specified if the DB instance is a Multi-AZ
deployment. The specified Availability Zone must be in the same AWS Region as the current endpoint.
If you're creating a DB instance in an RDS on VMware environment, specify the identifier of the custom Availability Zone to create the DB instance in.
For more information about RDS on VMware, see the RDS on VMware User Guide.
availabilityZone
- The Availability Zone (AZ) where the database will be created. For information on AWS Regions and
Availability Zones, see Regions and Availability Zones.
Default: A random, system-chosen Availability Zone in the endpoint's AWS Region.
Example: us-east-1d
Constraint: The AvailabilityZone
parameter can't be specified if the DB instance is a
Multi-AZ deployment. The specified Availability Zone must be in the same AWS Region as the current
endpoint.
If you're creating a DB instance in an RDS on VMware environment, specify the identifier of the custom Availability Zone to create the DB instance in.
For more information about RDS on VMware, see the RDS on VMware User Guide.
public String getAvailabilityZone()
The Availability Zone (AZ) where the database will be created. For information on AWS Regions and Availability Zones, see Regions and Availability Zones.
Default: A random, system-chosen Availability Zone in the endpoint's AWS Region.
Example: us-east-1d
Constraint: The AvailabilityZone
parameter can't be specified if the DB instance is a Multi-AZ
deployment. The specified Availability Zone must be in the same AWS Region as the current endpoint.
If you're creating a DB instance in an RDS on VMware environment, specify the identifier of the custom Availability Zone to create the DB instance in.
For more information about RDS on VMware, see the RDS on VMware User Guide.
Default: A random, system-chosen Availability Zone in the endpoint's AWS Region.
Example: us-east-1d
Constraint: The AvailabilityZone
parameter can't be specified if the DB instance is a
Multi-AZ deployment. The specified Availability Zone must be in the same AWS Region as the current
endpoint.
If you're creating a DB instance in an RDS on VMware environment, specify the identifier of the custom Availability Zone to create the DB instance in.
For more information about RDS on VMware, see the RDS on VMware User Guide.
public CreateDBInstanceRequest withAvailabilityZone(String availabilityZone)
The Availability Zone (AZ) where the database will be created. For information on AWS Regions and Availability Zones, see Regions and Availability Zones.
Default: A random, system-chosen Availability Zone in the endpoint's AWS Region.
Example: us-east-1d
Constraint: The AvailabilityZone
parameter can't be specified if the DB instance is a Multi-AZ
deployment. The specified Availability Zone must be in the same AWS Region as the current endpoint.
If you're creating a DB instance in an RDS on VMware environment, specify the identifier of the custom Availability Zone to create the DB instance in.
For more information about RDS on VMware, see the RDS on VMware User Guide.
availabilityZone
- The Availability Zone (AZ) where the database will be created. For information on AWS Regions and
Availability Zones, see Regions and Availability Zones.
Default: A random, system-chosen Availability Zone in the endpoint's AWS Region.
Example: us-east-1d
Constraint: The AvailabilityZone
parameter can't be specified if the DB instance is a
Multi-AZ deployment. The specified Availability Zone must be in the same AWS Region as the current
endpoint.
If you're creating a DB instance in an RDS on VMware environment, specify the identifier of the custom Availability Zone to create the DB instance in.
For more information about RDS on VMware, see the RDS on VMware User Guide.
public void setDBSubnetGroupName(String dBSubnetGroupName)
A DB subnet group to associate with this DB instance.
If there is no DB subnet group, then it is a non-VPC DB instance.
dBSubnetGroupName
- A DB subnet group to associate with this DB instance.
If there is no DB subnet group, then it is a non-VPC DB instance.
public String getDBSubnetGroupName()
A DB subnet group to associate with this DB instance.
If there is no DB subnet group, then it is a non-VPC DB instance.
If there is no DB subnet group, then it is a non-VPC DB instance.
public CreateDBInstanceRequest withDBSubnetGroupName(String dBSubnetGroupName)
A DB subnet group to associate with this DB instance.
If there is no DB subnet group, then it is a non-VPC DB instance.
dBSubnetGroupName
- A DB subnet group to associate with this DB instance.
If there is no DB subnet group, then it is a non-VPC DB instance.
public void setPreferredMaintenanceWindow(String preferredMaintenanceWindow)
The time range each week during which system maintenance can occur, in Universal Coordinated Time (UTC). For more information, see Amazon RDS Maintenance Window.
Format: ddd:hh24:mi-ddd:hh24:mi
The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region, occurring on a random day of the week.
Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.
Constraints: Minimum 30-minute window.
preferredMaintenanceWindow
- The time range each week during which system maintenance can occur, in Universal Coordinated Time (UTC).
For more information, see Amazon RDS Maintenance Window.
Format: ddd:hh24:mi-ddd:hh24:mi
The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region, occurring on a random day of the week.
Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.
Constraints: Minimum 30-minute window.
public String getPreferredMaintenanceWindow()
The time range each week during which system maintenance can occur, in Universal Coordinated Time (UTC). For more information, see Amazon RDS Maintenance Window.
Format: ddd:hh24:mi-ddd:hh24:mi
The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region, occurring on a random day of the week.
Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.
Constraints: Minimum 30-minute window.
Format: ddd:hh24:mi-ddd:hh24:mi
The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region, occurring on a random day of the week.
Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.
Constraints: Minimum 30-minute window.
public CreateDBInstanceRequest withPreferredMaintenanceWindow(String preferredMaintenanceWindow)
The time range each week during which system maintenance can occur, in Universal Coordinated Time (UTC). For more information, see Amazon RDS Maintenance Window.
Format: ddd:hh24:mi-ddd:hh24:mi
The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region, occurring on a random day of the week.
Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.
Constraints: Minimum 30-minute window.
preferredMaintenanceWindow
- The time range each week during which system maintenance can occur, in Universal Coordinated Time (UTC).
For more information, see Amazon RDS Maintenance Window.
Format: ddd:hh24:mi-ddd:hh24:mi
The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region, occurring on a random day of the week.
Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.
Constraints: Minimum 30-minute window.
public void setDBParameterGroupName(String dBParameterGroupName)
The name of the DB parameter group to associate with this DB instance. If you do not specify a value, then the default DB parameter group for the specified DB engine and version is used.
Constraints:
Must be 1 to 255 letters, numbers, or hyphens.
First character must be a letter
Can't end with a hyphen or contain two consecutive hyphens
dBParameterGroupName
- The name of the DB parameter group to associate with this DB instance. If you do not specify a value, then
the default DB parameter group for the specified DB engine and version is used.
Constraints:
Must be 1 to 255 letters, numbers, or hyphens.
First character must be a letter
Can't end with a hyphen or contain two consecutive hyphens
public String getDBParameterGroupName()
The name of the DB parameter group to associate with this DB instance. If you do not specify a value, then the default DB parameter group for the specified DB engine and version is used.
Constraints:
Must be 1 to 255 letters, numbers, or hyphens.
First character must be a letter
Can't end with a hyphen or contain two consecutive hyphens
Constraints:
Must be 1 to 255 letters, numbers, or hyphens.
First character must be a letter
Can't end with a hyphen or contain two consecutive hyphens
public CreateDBInstanceRequest withDBParameterGroupName(String dBParameterGroupName)
The name of the DB parameter group to associate with this DB instance. If you do not specify a value, then the default DB parameter group for the specified DB engine and version is used.
Constraints:
Must be 1 to 255 letters, numbers, or hyphens.
First character must be a letter
Can't end with a hyphen or contain two consecutive hyphens
dBParameterGroupName
- The name of the DB parameter group to associate with this DB instance. If you do not specify a value, then
the default DB parameter group for the specified DB engine and version is used.
Constraints:
Must be 1 to 255 letters, numbers, or hyphens.
First character must be a letter
Can't end with a hyphen or contain two consecutive hyphens
public void setBackupRetentionPeriod(Integer backupRetentionPeriod)
The number of days for which automated backups are retained. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups.
Amazon Aurora
Not applicable. The retention period for automated backups is managed by the DB cluster.
Default: 1
Constraints:
Must be a value from 0 to 35
Can't be set to 0 if the DB instance is a source to Read Replicas
backupRetentionPeriod
- The number of days for which automated backups are retained. Setting this parameter to a positive number
enables backups. Setting this parameter to 0 disables automated backups.
Amazon Aurora
Not applicable. The retention period for automated backups is managed by the DB cluster.
Default: 1
Constraints:
Must be a value from 0 to 35
Can't be set to 0 if the DB instance is a source to Read Replicas
public Integer getBackupRetentionPeriod()
The number of days for which automated backups are retained. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups.
Amazon Aurora
Not applicable. The retention period for automated backups is managed by the DB cluster.
Default: 1
Constraints:
Must be a value from 0 to 35
Can't be set to 0 if the DB instance is a source to Read Replicas
Amazon Aurora
Not applicable. The retention period for automated backups is managed by the DB cluster.
Default: 1
Constraints:
Must be a value from 0 to 35
Can't be set to 0 if the DB instance is a source to Read Replicas
public CreateDBInstanceRequest withBackupRetentionPeriod(Integer backupRetentionPeriod)
The number of days for which automated backups are retained. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups.
Amazon Aurora
Not applicable. The retention period for automated backups is managed by the DB cluster.
Default: 1
Constraints:
Must be a value from 0 to 35
Can't be set to 0 if the DB instance is a source to Read Replicas
backupRetentionPeriod
- The number of days for which automated backups are retained. Setting this parameter to a positive number
enables backups. Setting this parameter to 0 disables automated backups.
Amazon Aurora
Not applicable. The retention period for automated backups is managed by the DB cluster.
Default: 1
Constraints:
Must be a value from 0 to 35
Can't be set to 0 if the DB instance is a source to Read Replicas
public void setPreferredBackupWindow(String preferredBackupWindow)
The daily time range during which automated backups are created if automated backups are enabled, using the
BackupRetentionPeriod
parameter. For more information, see The Backup Window in the Amazon RDS User Guide.
Amazon Aurora
Not applicable. The daily time range for creating automated backups is managed by the DB cluster.
The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region. To see the time blocks available, see Adjusting the Preferred DB Instance Maintenance Window in the Amazon RDS User Guide.
Constraints:
Must be in the format hh24:mi-hh24:mi
.
Must be in Universal Coordinated Time (UTC).
Must not conflict with the preferred maintenance window.
Must be at least 30 minutes.
preferredBackupWindow
- The daily time range during which automated backups are created if automated backups are enabled, using
the BackupRetentionPeriod
parameter. For more information, see The Backup Window in the Amazon RDS User Guide.
Amazon Aurora
Not applicable. The daily time range for creating automated backups is managed by the DB cluster.
The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region. To see the time blocks available, see Adjusting the Preferred DB Instance Maintenance Window in the Amazon RDS User Guide.
Constraints:
Must be in the format hh24:mi-hh24:mi
.
Must be in Universal Coordinated Time (UTC).
Must not conflict with the preferred maintenance window.
Must be at least 30 minutes.
public String getPreferredBackupWindow()
The daily time range during which automated backups are created if automated backups are enabled, using the
BackupRetentionPeriod
parameter. For more information, see The Backup Window in the Amazon RDS User Guide.
Amazon Aurora
Not applicable. The daily time range for creating automated backups is managed by the DB cluster.
The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region. To see the time blocks available, see Adjusting the Preferred DB Instance Maintenance Window in the Amazon RDS User Guide.
Constraints:
Must be in the format hh24:mi-hh24:mi
.
Must be in Universal Coordinated Time (UTC).
Must not conflict with the preferred maintenance window.
Must be at least 30 minutes.
BackupRetentionPeriod
parameter. For more information, see The Backup Window in the Amazon RDS User Guide.
Amazon Aurora
Not applicable. The daily time range for creating automated backups is managed by the DB cluster.
The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region. To see the time blocks available, see Adjusting the Preferred DB Instance Maintenance Window in the Amazon RDS User Guide.
Constraints:
Must be in the format hh24:mi-hh24:mi
.
Must be in Universal Coordinated Time (UTC).
Must not conflict with the preferred maintenance window.
Must be at least 30 minutes.
public 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 The Backup Window in the Amazon RDS User Guide.
Amazon Aurora
Not applicable. The daily time range for creating automated backups is managed by the DB cluster.
The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region. To see the time blocks available, see Adjusting the Preferred DB Instance Maintenance Window in the Amazon RDS User Guide.
Constraints:
Must be in the format hh24:mi-hh24:mi
.
Must be in Universal Coordinated Time (UTC).
Must not conflict with the preferred maintenance window.
Must be at least 30 minutes.
preferredBackupWindow
- The daily time range during which automated backups are created if automated backups are enabled, using
the BackupRetentionPeriod
parameter. For more information, see The Backup Window in the Amazon RDS User Guide.
Amazon Aurora
Not applicable. The daily time range for creating automated backups is managed by the DB cluster.
The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region. To see the time blocks available, see Adjusting the Preferred DB Instance Maintenance Window in the Amazon RDS User Guide.
Constraints:
Must be in the format hh24:mi-hh24:mi
.
Must be in Universal Coordinated Time (UTC).
Must not conflict with the preferred maintenance window.
Must be at least 30 minutes.
public void setPort(Integer port)
The port number on which the database accepts connections.
MySQL
Default: 3306
Valid Values: 1150-65535
Type: Integer
MariaDB
Default: 3306
Valid Values: 1150-65535
Type: Integer
PostgreSQL
Default: 5432
Valid Values: 1150-65535
Type: Integer
Oracle
Default: 1521
Valid Values: 1150-65535
SQL Server
Default: 1433
Valid Values: 1150-65535
except for 1434
, 3389
, 47001
,
49152
, and 49152
through 49156
.
Amazon Aurora
Default: 3306
Valid Values: 1150-65535
Type: Integer
port
- The port number on which the database accepts connections.
MySQL
Default: 3306
Valid Values: 1150-65535
Type: Integer
MariaDB
Default: 3306
Valid Values: 1150-65535
Type: Integer
PostgreSQL
Default: 5432
Valid Values: 1150-65535
Type: Integer
Oracle
Default: 1521
Valid Values: 1150-65535
SQL Server
Default: 1433
Valid Values: 1150-65535
except for 1434
, 3389
, 47001
,
49152
, and 49152
through 49156
.
Amazon Aurora
Default: 3306
Valid Values: 1150-65535
Type: Integer
public Integer getPort()
The port number on which the database accepts connections.
MySQL
Default: 3306
Valid Values: 1150-65535
Type: Integer
MariaDB
Default: 3306
Valid Values: 1150-65535
Type: Integer
PostgreSQL
Default: 5432
Valid Values: 1150-65535
Type: Integer
Oracle
Default: 1521
Valid Values: 1150-65535
SQL Server
Default: 1433
Valid Values: 1150-65535
except for 1434
, 3389
, 47001
,
49152
, and 49152
through 49156
.
Amazon Aurora
Default: 3306
Valid Values: 1150-65535
Type: Integer
MySQL
Default: 3306
Valid Values: 1150-65535
Type: Integer
MariaDB
Default: 3306
Valid Values: 1150-65535
Type: Integer
PostgreSQL
Default: 5432
Valid Values: 1150-65535
Type: Integer
Oracle
Default: 1521
Valid Values: 1150-65535
SQL Server
Default: 1433
Valid Values: 1150-65535
except for 1434
, 3389
, 47001
, 49152
, and 49152
through 49156
.
Amazon Aurora
Default: 3306
Valid Values: 1150-65535
Type: Integer
public CreateDBInstanceRequest withPort(Integer port)
The port number on which the database accepts connections.
MySQL
Default: 3306
Valid Values: 1150-65535
Type: Integer
MariaDB
Default: 3306
Valid Values: 1150-65535
Type: Integer
PostgreSQL
Default: 5432
Valid Values: 1150-65535
Type: Integer
Oracle
Default: 1521
Valid Values: 1150-65535
SQL Server
Default: 1433
Valid Values: 1150-65535
except for 1434
, 3389
, 47001
,
49152
, and 49152
through 49156
.
Amazon Aurora
Default: 3306
Valid Values: 1150-65535
Type: Integer
port
- The port number on which the database accepts connections.
MySQL
Default: 3306
Valid Values: 1150-65535
Type: Integer
MariaDB
Default: 3306
Valid Values: 1150-65535
Type: Integer
PostgreSQL
Default: 5432
Valid Values: 1150-65535
Type: Integer
Oracle
Default: 1521
Valid Values: 1150-65535
SQL Server
Default: 1433
Valid Values: 1150-65535
except for 1434
, 3389
, 47001
,
49152
, and 49152
through 49156
.
Amazon Aurora
Default: 3306
Valid Values: 1150-65535
Type: Integer
public void setMultiAZ(Boolean multiAZ)
A value that indicates whether the DB instance is a Multi-AZ deployment. You can't set the
AvailabilityZone
parameter if the DB instance is a Multi-AZ deployment.
multiAZ
- A value that indicates whether the DB instance is a Multi-AZ deployment. You can't set the
AvailabilityZone
parameter if the DB instance is a Multi-AZ deployment.public Boolean getMultiAZ()
A value that indicates whether the DB instance is a Multi-AZ deployment. You can't set the
AvailabilityZone
parameter if the DB instance is a Multi-AZ deployment.
AvailabilityZone
parameter if the DB instance is a Multi-AZ deployment.public CreateDBInstanceRequest withMultiAZ(Boolean multiAZ)
A value that indicates whether the DB instance is a Multi-AZ deployment. You can't set the
AvailabilityZone
parameter if the DB instance is a Multi-AZ deployment.
multiAZ
- A value that indicates whether the DB instance is a Multi-AZ deployment. You can't set the
AvailabilityZone
parameter if the DB instance is a Multi-AZ deployment.public Boolean isMultiAZ()
A value that indicates whether the DB instance is a Multi-AZ deployment. You can't set the
AvailabilityZone
parameter if the DB instance is a Multi-AZ deployment.
AvailabilityZone
parameter if the DB instance is a Multi-AZ deployment.public void setEngineVersion(String engineVersion)
The version number of the database engine to use.
For a list of valid engine versions, use the DescribeDBEngineVersions
action.
The following are the database engines and links to information about the major and minor versions that are available with Amazon RDS. Not every database engine is available for every AWS Region.
Amazon Aurora
Not applicable. The version number of the database engine to be used by the DB instance is managed by the DB cluster.
MariaDB
See MariaDB on Amazon RDS Versions in the Amazon RDS User Guide.
Microsoft SQL Server
See Version and Feature Support on Amazon RDS in the Amazon RDS User Guide.
MySQL
See MySQL on Amazon RDS Versions in the Amazon RDS User Guide.
Oracle
See Oracle Database Engine Release Notes in the Amazon RDS User Guide.
PostgreSQL
See Supported PostgreSQL Database Versions in the Amazon RDS User Guide.
engineVersion
- The version number of the database engine to use.
For a list of valid engine versions, use the DescribeDBEngineVersions
action.
The following are the database engines and links to information about the major and minor versions that are available with Amazon RDS. Not every database engine is available for every AWS Region.
Amazon Aurora
Not applicable. The version number of the database engine to be used by the DB instance is managed by the DB cluster.
MariaDB
See MariaDB on Amazon RDS Versions in the Amazon RDS User Guide.
Microsoft SQL Server
See Version and Feature Support on Amazon RDS in the Amazon RDS User Guide.
MySQL
See MySQL on Amazon RDS Versions in the Amazon RDS User Guide.
Oracle
See Oracle Database Engine Release Notes in the Amazon RDS User Guide.
PostgreSQL
See Supported PostgreSQL Database Versions in the Amazon RDS User Guide.
public String getEngineVersion()
The version number of the database engine to use.
For a list of valid engine versions, use the DescribeDBEngineVersions
action.
The following are the database engines and links to information about the major and minor versions that are available with Amazon RDS. Not every database engine is available for every AWS Region.
Amazon Aurora
Not applicable. The version number of the database engine to be used by the DB instance is managed by the DB cluster.
MariaDB
See MariaDB on Amazon RDS Versions in the Amazon RDS User Guide.
Microsoft SQL Server
See Version and Feature Support on Amazon RDS in the Amazon RDS User Guide.
MySQL
See MySQL on Amazon RDS Versions in the Amazon RDS User Guide.
Oracle
See Oracle Database Engine Release Notes in the Amazon RDS User Guide.
PostgreSQL
See Supported PostgreSQL Database Versions in the Amazon RDS User Guide.
For a list of valid engine versions, use the DescribeDBEngineVersions
action.
The following are the database engines and links to information about the major and minor versions that are available with Amazon RDS. Not every database engine is available for every AWS Region.
Amazon Aurora
Not applicable. The version number of the database engine to be used by the DB instance is managed by the DB cluster.
MariaDB
See MariaDB on Amazon RDS Versions in the Amazon RDS User Guide.
Microsoft SQL Server
See Version and Feature Support on Amazon RDS in the Amazon RDS User Guide.
MySQL
See MySQL on Amazon RDS Versions in the Amazon RDS User Guide.
Oracle
See Oracle Database Engine Release Notes in the Amazon RDS User Guide.
PostgreSQL
See Supported PostgreSQL Database Versions in the Amazon RDS User Guide.
public CreateDBInstanceRequest withEngineVersion(String engineVersion)
The version number of the database engine to use.
For a list of valid engine versions, use the DescribeDBEngineVersions
action.
The following are the database engines and links to information about the major and minor versions that are available with Amazon RDS. Not every database engine is available for every AWS Region.
Amazon Aurora
Not applicable. The version number of the database engine to be used by the DB instance is managed by the DB cluster.
MariaDB
See MariaDB on Amazon RDS Versions in the Amazon RDS User Guide.
Microsoft SQL Server
See Version and Feature Support on Amazon RDS in the Amazon RDS User Guide.
MySQL
See MySQL on Amazon RDS Versions in the Amazon RDS User Guide.
Oracle
See Oracle Database Engine Release Notes in the Amazon RDS User Guide.
PostgreSQL
See Supported PostgreSQL Database Versions in the Amazon RDS User Guide.
engineVersion
- The version number of the database engine to use.
For a list of valid engine versions, use the DescribeDBEngineVersions
action.
The following are the database engines and links to information about the major and minor versions that are available with Amazon RDS. Not every database engine is available for every AWS Region.
Amazon Aurora
Not applicable. The version number of the database engine to be used by the DB instance is managed by the DB cluster.
MariaDB
See MariaDB on Amazon RDS Versions in the Amazon RDS User Guide.
Microsoft SQL Server
See Version and Feature Support on Amazon RDS in the Amazon RDS User Guide.
MySQL
See MySQL on Amazon RDS Versions in the Amazon RDS User Guide.
Oracle
See Oracle Database Engine Release Notes in the Amazon RDS User Guide.
PostgreSQL
See Supported PostgreSQL Database Versions in the Amazon RDS User Guide.
public void setAutoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade)
A value that indicates whether minor engine upgrades are applied automatically to the DB instance during the maintenance window. By default, minor engine upgrades are applied automatically.
autoMinorVersionUpgrade
- A value that indicates whether minor engine upgrades are applied automatically to the DB instance during
the maintenance window. By default, minor engine upgrades are applied automatically.public Boolean getAutoMinorVersionUpgrade()
A value that indicates whether minor engine upgrades are applied automatically to the DB instance during the maintenance window. By default, minor engine upgrades are applied automatically.
public CreateDBInstanceRequest withAutoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade)
A value that indicates whether minor engine upgrades are applied automatically to the DB instance during the maintenance window. By default, minor engine upgrades are applied automatically.
autoMinorVersionUpgrade
- A value that indicates whether minor engine upgrades are applied automatically to the DB instance during
the maintenance window. By default, minor engine upgrades are applied automatically.public Boolean isAutoMinorVersionUpgrade()
A value that indicates whether minor engine upgrades are applied automatically to the DB instance during the maintenance window. By default, minor engine upgrades are applied automatically.
public void setLicenseModel(String licenseModel)
License model information for this DB instance.
Valid values: license-included
| bring-your-own-license
|
general-public-license
licenseModel
- License model information for this DB instance.
Valid values: license-included
| bring-your-own-license
|
general-public-license
public String getLicenseModel()
License model information for this DB instance.
Valid values: license-included
| bring-your-own-license
|
general-public-license
Valid values: license-included
| bring-your-own-license
|
general-public-license
public CreateDBInstanceRequest withLicenseModel(String licenseModel)
License model information for this DB instance.
Valid values: license-included
| bring-your-own-license
|
general-public-license
licenseModel
- License model information for this DB instance.
Valid values: license-included
| bring-your-own-license
|
general-public-license
public void setIops(Integer iops)
The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB instance. For information about valid Iops values, see Amazon RDS Provisioned IOPS Storage to Improve Performance in the Amazon RDS User Guide.
Constraints: For MariaDB, MySQL, Oracle, and PostgreSQL DB instances, must be a multiple between .5 and 50 of the storage amount for the DB instance. For SQL Server DB instances, must be a multiple between 1 and 50 of the storage amount for the DB instance.
iops
- The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB
instance. For information about valid Iops values, see Amazon RDS
Provisioned IOPS Storage to Improve Performance in the Amazon RDS User Guide.
Constraints: For MariaDB, MySQL, Oracle, and PostgreSQL DB instances, must be a multiple between .5 and 50 of the storage amount for the DB instance. For SQL Server DB instances, must be a multiple between 1 and 50 of the storage amount for the DB instance.
public Integer getIops()
The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB instance. For information about valid Iops values, see Amazon RDS Provisioned IOPS Storage to Improve Performance in the Amazon RDS User Guide.
Constraints: For MariaDB, MySQL, Oracle, and PostgreSQL DB instances, must be a multiple between .5 and 50 of the storage amount for the DB instance. For SQL Server DB instances, must be a multiple between 1 and 50 of the storage amount for the DB instance.
Constraints: For MariaDB, MySQL, Oracle, and PostgreSQL DB instances, must be a multiple between .5 and 50 of the storage amount for the DB instance. For SQL Server DB instances, must be a multiple between 1 and 50 of the storage amount for the DB instance.
public CreateDBInstanceRequest withIops(Integer iops)
The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB instance. For information about valid Iops values, see Amazon RDS Provisioned IOPS Storage to Improve Performance in the Amazon RDS User Guide.
Constraints: For MariaDB, MySQL, Oracle, and PostgreSQL DB instances, must be a multiple between .5 and 50 of the storage amount for the DB instance. For SQL Server DB instances, must be a multiple between 1 and 50 of the storage amount for the DB instance.
iops
- The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB
instance. For information about valid Iops values, see Amazon RDS
Provisioned IOPS Storage to Improve Performance in the Amazon RDS User Guide.
Constraints: For MariaDB, MySQL, Oracle, and PostgreSQL DB instances, must be a multiple between .5 and 50 of the storage amount for the DB instance. For SQL Server DB instances, must be a multiple between 1 and 50 of the storage amount for the DB instance.
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, can't be removed from an option group, and that option group can't 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, can't be removed from an option group, and that option group can't be removed from a DB instance once it is associated with a DB instance
public String getOptionGroupName()
Indicates that the DB instance should be associated with the specified option group.
Permanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed from an option group, and that option group can't 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, can't be removed from an option group, and that option group can't be removed from a DB instance once it is associated with a DB instance
public CreateDBInstanceRequest withOptionGroupName(String optionGroupName)
Indicates that the DB instance should be associated with the specified option group.
Permanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed from an option group, and that option group can't 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, can't be removed from an option group, and that option group can't be removed from a DB instance once it is associated with a DB instance
public void setCharacterSetName(String characterSetName)
For supported engines, indicates that the DB instance should be associated with the specified CharacterSet.
Amazon Aurora
Not applicable. The character set is managed by the DB cluster. For more information, see
CreateDBCluster
.
characterSetName
- For supported engines, indicates that the DB instance should be associated with the specified
CharacterSet.
Amazon Aurora
Not applicable. The character set is managed by the DB cluster. For more information, see
CreateDBCluster
.
public String getCharacterSetName()
For supported engines, indicates that the DB instance should be associated with the specified CharacterSet.
Amazon Aurora
Not applicable. The character set is managed by the DB cluster. For more information, see
CreateDBCluster
.
Amazon Aurora
Not applicable. The character set is managed by the DB cluster. For more information, see
CreateDBCluster
.
public CreateDBInstanceRequest withCharacterSetName(String characterSetName)
For supported engines, indicates that the DB instance should be associated with the specified CharacterSet.
Amazon Aurora
Not applicable. The character set is managed by the DB cluster. For more information, see
CreateDBCluster
.
characterSetName
- For supported engines, indicates that the DB instance should be associated with the specified
CharacterSet.
Amazon Aurora
Not applicable. The character set is managed by the DB cluster. For more information, see
CreateDBCluster
.
public void setPubliclyAccessible(Boolean publiclyAccessible)
A value that indicates whether the DB instance is publicly accessible. When the DB instance is publicly accessible, it is an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address. When the DB instance isn't publicly accessible, it is an internal instance with a DNS name that resolves to a private IP address.
Default: The default behavior varies depending on whether DBSubnetGroupName
is specified.
If DBSubnetGroupName
isn't specified, and PubliclyAccessible
isn't specified, the
following applies:
If the default VPC in the target region doesn’t have an Internet gateway attached to it, the DB instance is private.
If the default VPC in the target region has an Internet gateway attached to it, the DB instance is public.
If DBSubnetGroupName
is specified, and PubliclyAccessible
isn't specified, the
following applies:
If the subnets are part of a VPC that doesn’t have an Internet gateway attached to it, the DB instance is private.
If the subnets are part of a VPC that has an Internet gateway attached to it, the DB instance is public.
publiclyAccessible
- A value that indicates whether the DB instance is publicly accessible. When the DB instance is publicly
accessible, it is an Internet-facing instance with a publicly resolvable DNS name, which resolves to a
public IP address. When the DB instance isn't publicly accessible, it is an internal instance with a DNS
name that resolves to a private IP address.
Default: The default behavior varies depending on whether DBSubnetGroupName
is specified.
If DBSubnetGroupName
isn't specified, and PubliclyAccessible
isn't specified,
the following applies:
If the default VPC in the target region doesn’t have an Internet gateway attached to it, the DB instance is private.
If the default VPC in the target region has an Internet gateway attached to it, the DB instance is public.
If DBSubnetGroupName
is specified, and PubliclyAccessible
isn't specified, the
following applies:
If the subnets are part of a VPC that doesn’t have an Internet gateway attached to it, the DB instance is private.
If the subnets are part of a VPC that has an Internet gateway attached to it, the DB instance is public.
public Boolean getPubliclyAccessible()
A value that indicates whether the DB instance is publicly accessible. When the DB instance is publicly accessible, it is an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address. When the DB instance isn't publicly accessible, it is an internal instance with a DNS name that resolves to a private IP address.
Default: The default behavior varies depending on whether DBSubnetGroupName
is specified.
If DBSubnetGroupName
isn't specified, and PubliclyAccessible
isn't specified, the
following applies:
If the default VPC in the target region doesn’t have an Internet gateway attached to it, the DB instance is private.
If the default VPC in the target region has an Internet gateway attached to it, the DB instance is public.
If DBSubnetGroupName
is specified, and PubliclyAccessible
isn't specified, the
following applies:
If the subnets are part of a VPC that doesn’t have an Internet gateway attached to it, the DB instance is private.
If the subnets are part of a VPC that has an Internet gateway attached to it, the DB instance is public.
Default: The default behavior varies depending on whether DBSubnetGroupName
is specified.
If DBSubnetGroupName
isn't specified, and PubliclyAccessible
isn't specified,
the following applies:
If the default VPC in the target region doesn’t have an Internet gateway attached to it, the DB instance is private.
If the default VPC in the target region has an Internet gateway attached to it, the DB instance is public.
If DBSubnetGroupName
is specified, and PubliclyAccessible
isn't specified, the
following applies:
If the subnets are part of a VPC that doesn’t have an Internet gateway attached to it, the DB instance is private.
If the subnets are part of a VPC that has an Internet gateway attached to it, the DB instance is public.
public CreateDBInstanceRequest withPubliclyAccessible(Boolean publiclyAccessible)
A value that indicates whether the DB instance is publicly accessible. When the DB instance is publicly accessible, it is an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address. When the DB instance isn't publicly accessible, it is an internal instance with a DNS name that resolves to a private IP address.
Default: The default behavior varies depending on whether DBSubnetGroupName
is specified.
If DBSubnetGroupName
isn't specified, and PubliclyAccessible
isn't specified, the
following applies:
If the default VPC in the target region doesn’t have an Internet gateway attached to it, the DB instance is private.
If the default VPC in the target region has an Internet gateway attached to it, the DB instance is public.
If DBSubnetGroupName
is specified, and PubliclyAccessible
isn't specified, the
following applies:
If the subnets are part of a VPC that doesn’t have an Internet gateway attached to it, the DB instance is private.
If the subnets are part of a VPC that has an Internet gateway attached to it, the DB instance is public.
publiclyAccessible
- A value that indicates whether the DB instance is publicly accessible. When the DB instance is publicly
accessible, it is an Internet-facing instance with a publicly resolvable DNS name, which resolves to a
public IP address. When the DB instance isn't publicly accessible, it is an internal instance with a DNS
name that resolves to a private IP address.
Default: The default behavior varies depending on whether DBSubnetGroupName
is specified.
If DBSubnetGroupName
isn't specified, and PubliclyAccessible
isn't specified,
the following applies:
If the default VPC in the target region doesn’t have an Internet gateway attached to it, the DB instance is private.
If the default VPC in the target region has an Internet gateway attached to it, the DB instance is public.
If DBSubnetGroupName
is specified, and PubliclyAccessible
isn't specified, the
following applies:
If the subnets are part of a VPC that doesn’t have an Internet gateway attached to it, the DB instance is private.
If the subnets are part of a VPC that has an Internet gateway attached to it, the DB instance is public.
public Boolean isPubliclyAccessible()
A value that indicates whether the DB instance is publicly accessible. When the DB instance is publicly accessible, it is an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address. When the DB instance isn't publicly accessible, it is an internal instance with a DNS name that resolves to a private IP address.
Default: The default behavior varies depending on whether DBSubnetGroupName
is specified.
If DBSubnetGroupName
isn't specified, and PubliclyAccessible
isn't specified, the
following applies:
If the default VPC in the target region doesn’t have an Internet gateway attached to it, the DB instance is private.
If the default VPC in the target region has an Internet gateway attached to it, the DB instance is public.
If DBSubnetGroupName
is specified, and PubliclyAccessible
isn't specified, the
following applies:
If the subnets are part of a VPC that doesn’t have an Internet gateway attached to it, the DB instance is private.
If the subnets are part of a VPC that has an Internet gateway attached to it, the DB instance is public.
Default: The default behavior varies depending on whether DBSubnetGroupName
is specified.
If DBSubnetGroupName
isn't specified, and PubliclyAccessible
isn't specified,
the following applies:
If the default VPC in the target region doesn’t have an Internet gateway attached to it, the DB instance is private.
If the default VPC in the target region has an Internet gateway attached to it, the DB instance is public.
If DBSubnetGroupName
is specified, and PubliclyAccessible
isn't specified, the
following applies:
If the subnets are part of a VPC that doesn’t have an Internet gateway attached to it, the DB instance is private.
If the subnets are part of a VPC that has an Internet gateway attached to it, the DB instance is public.
public List<Tag> getTags()
Tags to assign to the DB instance.
public void setTags(Collection<Tag> tags)
Tags to assign to the DB instance.
tags
- Tags to assign to the DB instance.public CreateDBInstanceRequest withTags(Tag... tags)
Tags to assign to the DB instance.
NOTE: This method appends the values to the existing list (if any). Use
setTags(java.util.Collection)
or withTags(java.util.Collection)
if you want to override the
existing values.
tags
- Tags to assign to the DB instance.public CreateDBInstanceRequest withTags(Collection<Tag> tags)
Tags to assign to the DB instance.
tags
- Tags to assign to the DB instance.public void setDBClusterIdentifier(String dBClusterIdentifier)
The identifier of the DB cluster that the instance will belong to.
dBClusterIdentifier
- The identifier of the DB cluster that the instance will belong to.public String getDBClusterIdentifier()
The identifier of the DB cluster that the instance will belong to.
public CreateDBInstanceRequest withDBClusterIdentifier(String dBClusterIdentifier)
The identifier of the DB cluster that the instance will belong to.
dBClusterIdentifier
- The identifier of the DB cluster that the instance will belong to.public void setStorageType(String storageType)
Specifies the storage type to be associated with the DB instance.
Valid values: standard | gp2 | io1
If you specify io1
, you must also include a value for the Iops
parameter.
Default: io1
if the Iops
parameter is specified, otherwise gp2
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 gp2
public String getStorageType()
Specifies the storage type to be associated with the DB instance.
Valid values: standard | gp2 | io1
If you specify io1
, you must also include a value for the Iops
parameter.
Default: io1
if the Iops
parameter is specified, otherwise gp2
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 gp2
public CreateDBInstanceRequest withStorageType(String storageType)
Specifies the storage type to be associated with the DB instance.
Valid values: standard | gp2 | io1
If you specify io1
, you must also include a value for the Iops
parameter.
Default: io1
if the Iops
parameter is specified, otherwise gp2
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 gp2
public void setTdeCredentialArn(String tdeCredentialArn)
The ARN from the key store with which to associate the instance for TDE encryption.
tdeCredentialArn
- The ARN from the key store with which to associate the instance for TDE encryption.public String getTdeCredentialArn()
The ARN from the key store with which to associate the instance for TDE encryption.
public CreateDBInstanceRequest withTdeCredentialArn(String tdeCredentialArn)
The ARN from the key store with which to associate the instance for TDE encryption.
tdeCredentialArn
- The ARN from the key store with which to associate the instance for TDE encryption.public void setTdeCredentialPassword(String tdeCredentialPassword)
The password for the given ARN from the key store in order to access the device.
tdeCredentialPassword
- The password for the given ARN from the key store in order to access the device.public String getTdeCredentialPassword()
The password for the given ARN from the key store in order to access the device.
public CreateDBInstanceRequest withTdeCredentialPassword(String tdeCredentialPassword)
The password for the given ARN from the key store in order to access the device.
tdeCredentialPassword
- The password for the given ARN from the key store in order to access the device.public void setStorageEncrypted(Boolean storageEncrypted)
A value that indicates whether the DB instance is encrypted. By default, it isn't encrypted.
Amazon Aurora
Not applicable. The encryption for DB instances is managed by the DB cluster.
storageEncrypted
- A value that indicates whether the DB instance is encrypted. By default, it isn't encrypted.
Amazon Aurora
Not applicable. The encryption for DB instances is managed by the DB cluster.
public Boolean getStorageEncrypted()
A value that indicates whether the DB instance is encrypted. By default, it isn't encrypted.
Amazon Aurora
Not applicable. The encryption for DB instances is managed by the DB cluster.
Amazon Aurora
Not applicable. The encryption for DB instances is managed by the DB cluster.
public CreateDBInstanceRequest withStorageEncrypted(Boolean storageEncrypted)
A value that indicates whether the DB instance is encrypted. By default, it isn't encrypted.
Amazon Aurora
Not applicable. The encryption for DB instances is managed by the DB cluster.
storageEncrypted
- A value that indicates whether the DB instance is encrypted. By default, it isn't encrypted.
Amazon Aurora
Not applicable. The encryption for DB instances is managed by the DB cluster.
public Boolean isStorageEncrypted()
A value that indicates whether the DB instance is encrypted. By default, it isn't encrypted.
Amazon Aurora
Not applicable. The encryption for DB instances is managed by the DB cluster.
Amazon Aurora
Not applicable. The encryption for DB instances is managed by the DB cluster.
public void setKmsKeyId(String kmsKeyId)
The AWS KMS key identifier for an encrypted DB instance.
The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are creating a DB instance with the same AWS account that owns the KMS encryption key used to encrypt the new DB instance, then you can use the KMS key alias instead of the ARN for the KM encryption key.
Amazon Aurora
Not applicable. The KMS key identifier is managed by the DB cluster. For more information, see
CreateDBCluster
.
If StorageEncrypted
is enabled, and you do not specify a value for the KmsKeyId
parameter, then Amazon RDS will use your default encryption key. AWS KMS creates the default encryption key for
your AWS account. Your AWS account has a different default encryption key for each AWS Region.
kmsKeyId
- The AWS KMS key identifier for an encrypted DB instance.
The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are creating a DB instance with the same AWS account that owns the KMS encryption key used to encrypt the new DB instance, then you can use the KMS key alias instead of the ARN for the KM encryption key.
Amazon Aurora
Not applicable. The KMS key identifier is managed by the DB cluster. For more information, see
CreateDBCluster
.
If StorageEncrypted
is enabled, and you do not specify a value for the KmsKeyId
parameter, then Amazon RDS will use your default encryption key. AWS KMS creates the default encryption
key for your AWS account. Your AWS account has a different default encryption key for each AWS Region.
public String getKmsKeyId()
The AWS KMS key identifier for an encrypted DB instance.
The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are creating a DB instance with the same AWS account that owns the KMS encryption key used to encrypt the new DB instance, then you can use the KMS key alias instead of the ARN for the KM encryption key.
Amazon Aurora
Not applicable. The KMS key identifier is managed by the DB cluster. For more information, see
CreateDBCluster
.
If StorageEncrypted
is enabled, and you do not specify a value for the KmsKeyId
parameter, then Amazon RDS will use your default encryption key. AWS KMS creates the default encryption key for
your AWS account. Your AWS account has a different default encryption key for each AWS Region.
The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are creating a DB instance with the same AWS account that owns the KMS encryption key used to encrypt the new DB instance, then you can use the KMS key alias instead of the ARN for the KM encryption key.
Amazon Aurora
Not applicable. The KMS key identifier is managed by the DB cluster. For more information, see
CreateDBCluster
.
If StorageEncrypted
is enabled, 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 AWS KMS key identifier for an encrypted DB instance.
The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are creating a DB instance with the same AWS account that owns the KMS encryption key used to encrypt the new DB instance, then you can use the KMS key alias instead of the ARN for the KM encryption key.
Amazon Aurora
Not applicable. The KMS key identifier is managed by the DB cluster. For more information, see
CreateDBCluster
.
If StorageEncrypted
is enabled, and you do not specify a value for the KmsKeyId
parameter, then Amazon RDS will use your default encryption key. AWS KMS creates the default encryption key for
your AWS account. Your AWS account has a different default encryption key for each AWS Region.
kmsKeyId
- The AWS KMS key identifier for an encrypted DB instance.
The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are creating a DB instance with the same AWS account that owns the KMS encryption key used to encrypt the new DB instance, then you can use the KMS key alias instead of the ARN for the KM encryption key.
Amazon Aurora
Not applicable. The KMS key identifier is managed by the DB cluster. For more information, see
CreateDBCluster
.
If StorageEncrypted
is enabled, and you do not specify a value for the KmsKeyId
parameter, then Amazon RDS will use your default encryption key. AWS KMS creates the default encryption
key for your AWS account. Your AWS account has a different default encryption key for each AWS Region.
public void setDomain(String domain)
The Active Directory directory ID to create the DB instance in. Currently, only Microsoft SQL Server and Oracle DB instances can be created in an Active Directory Domain.
For Microsoft SQL Server DB instances, Amazon RDS can use Windows Authentication to authenticate users that connect to the DB instance. For more information, see Using Windows Authentication with an Amazon RDS DB Instance Running Microsoft SQL Server in the Amazon RDS User Guide.
For Oracle DB instance, Amazon RDS can use Kerberos Authentication to authenticate users that connect to the DB instance. For more information, see Using Kerberos Authentication with Amazon RDS for Oracle in the Amazon RDS User Guide.
domain
- The Active Directory directory ID to create the DB instance in. Currently, only Microsoft SQL Server and
Oracle DB instances can be created in an Active Directory Domain.
For Microsoft SQL Server DB instances, Amazon RDS can use Windows Authentication to authenticate users that connect to the DB instance. For more information, see Using Windows Authentication with an Amazon RDS DB Instance Running Microsoft SQL Server in the Amazon RDS User Guide.
For Oracle DB instance, Amazon RDS can use Kerberos Authentication to authenticate users that connect to the DB instance. For more information, see Using Kerberos Authentication with Amazon RDS for Oracle in the Amazon RDS User Guide.
public String getDomain()
The Active Directory directory ID to create the DB instance in. Currently, only Microsoft SQL Server and Oracle DB instances can be created in an Active Directory Domain.
For Microsoft SQL Server DB instances, Amazon RDS can use Windows Authentication to authenticate users that connect to the DB instance. For more information, see Using Windows Authentication with an Amazon RDS DB Instance Running Microsoft SQL Server in the Amazon RDS User Guide.
For Oracle DB instance, Amazon RDS can use Kerberos Authentication to authenticate users that connect to the DB instance. For more information, see Using Kerberos Authentication with Amazon RDS for Oracle in the Amazon RDS User Guide.
For Microsoft SQL Server DB instances, Amazon RDS can use Windows Authentication to authenticate users that connect to the DB instance. For more information, see Using Windows Authentication with an Amazon RDS DB Instance Running Microsoft SQL Server in the Amazon RDS User Guide.
For Oracle DB instance, Amazon RDS can use Kerberos Authentication to authenticate users that connect to the DB instance. For more information, see Using Kerberos Authentication with Amazon RDS for Oracle in the Amazon RDS User Guide.
public CreateDBInstanceRequest withDomain(String domain)
The Active Directory directory ID to create the DB instance in. Currently, only Microsoft SQL Server and Oracle DB instances can be created in an Active Directory Domain.
For Microsoft SQL Server DB instances, Amazon RDS can use Windows Authentication to authenticate users that connect to the DB instance. For more information, see Using Windows Authentication with an Amazon RDS DB Instance Running Microsoft SQL Server in the Amazon RDS User Guide.
For Oracle DB instance, Amazon RDS can use Kerberos Authentication to authenticate users that connect to the DB instance. For more information, see Using Kerberos Authentication with Amazon RDS for Oracle in the Amazon RDS User Guide.
domain
- The Active Directory directory ID to create the DB instance in. Currently, only Microsoft SQL Server and
Oracle DB instances can be created in an Active Directory Domain.
For Microsoft SQL Server DB instances, Amazon RDS can use Windows Authentication to authenticate users that connect to the DB instance. For more information, see Using Windows Authentication with an Amazon RDS DB Instance Running Microsoft SQL Server in the Amazon RDS User Guide.
For Oracle DB instance, Amazon RDS can use Kerberos Authentication to authenticate users that connect to the DB instance. For more information, see Using Kerberos Authentication with Amazon RDS for Oracle in the Amazon RDS User Guide.
public void setCopyTagsToSnapshot(Boolean copyTagsToSnapshot)
A value that indicates whether to copy tags from the DB instance to snapshots of the DB instance. By default, tags are not copied.
Amazon Aurora
Not applicable. Copying tags to snapshots is managed by the DB cluster. Setting this value for an Aurora DB instance has no effect on the DB cluster setting.
copyTagsToSnapshot
- A value that indicates whether to copy tags from the DB instance to snapshots of the DB instance. By
default, tags are not copied.
Amazon Aurora
Not applicable. Copying tags to snapshots is managed by the DB cluster. Setting this value for an Aurora DB instance has no effect on the DB cluster setting.
public Boolean getCopyTagsToSnapshot()
A value that indicates whether to copy tags from the DB instance to snapshots of the DB instance. By default, tags are not copied.
Amazon Aurora
Not applicable. Copying tags to snapshots is managed by the DB cluster. Setting this value for an Aurora DB instance has no effect on the DB cluster setting.
Amazon Aurora
Not applicable. Copying tags to snapshots is managed by the DB cluster. Setting this value for an Aurora DB instance has no effect on the DB cluster setting.
public CreateDBInstanceRequest withCopyTagsToSnapshot(Boolean copyTagsToSnapshot)
A value that indicates whether to copy tags from the DB instance to snapshots of the DB instance. By default, tags are not copied.
Amazon Aurora
Not applicable. Copying tags to snapshots is managed by the DB cluster. Setting this value for an Aurora DB instance has no effect on the DB cluster setting.
copyTagsToSnapshot
- A value that indicates whether to copy tags from the DB instance to snapshots of the DB instance. By
default, tags are not copied.
Amazon Aurora
Not applicable. Copying tags to snapshots is managed by the DB cluster. Setting this value for an Aurora DB instance has no effect on the DB cluster setting.
public Boolean isCopyTagsToSnapshot()
A value that indicates whether to copy tags from the DB instance to snapshots of the DB instance. By default, tags are not copied.
Amazon Aurora
Not applicable. Copying tags to snapshots is managed by the DB cluster. Setting this value for an Aurora DB instance has no effect on the DB cluster setting.
Amazon Aurora
Not applicable. Copying tags to snapshots is managed by the DB cluster. Setting this value for an Aurora DB instance has no effect on the DB cluster setting.
public void setMonitoringInterval(Integer monitoringInterval)
The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collecting Enhanced Monitoring metrics, specify 0. The default is 0.
If MonitoringRoleArn
is specified, then you must also set MonitoringInterval
to a value
other than 0.
Valid Values: 0, 1, 5, 10, 15, 30, 60
monitoringInterval
- The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB
instance. To disable collecting Enhanced Monitoring metrics, specify 0. The default is 0.
If MonitoringRoleArn
is specified, then you must also set MonitoringInterval
to
a value other than 0.
Valid Values: 0, 1, 5, 10, 15, 30, 60
public Integer getMonitoringInterval()
The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collecting Enhanced Monitoring metrics, specify 0. The default is 0.
If MonitoringRoleArn
is specified, then you must also set MonitoringInterval
to a value
other than 0.
Valid Values: 0, 1, 5, 10, 15, 30, 60
If MonitoringRoleArn
is specified, then you must also set MonitoringInterval
to
a value other than 0.
Valid Values: 0, 1, 5, 10, 15, 30, 60
public CreateDBInstanceRequest withMonitoringInterval(Integer monitoringInterval)
The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collecting Enhanced Monitoring metrics, specify 0. The default is 0.
If MonitoringRoleArn
is specified, then you must also set MonitoringInterval
to a value
other than 0.
Valid Values: 0, 1, 5, 10, 15, 30, 60
monitoringInterval
- The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB
instance. To disable collecting Enhanced Monitoring metrics, specify 0. The default is 0.
If MonitoringRoleArn
is specified, then you must also set MonitoringInterval
to
a value other than 0.
Valid Values: 0, 1, 5, 10, 15, 30, 60
public void setMonitoringRoleArn(String monitoringRoleArn)
The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs. For
example, arn:aws:iam:123456789012:role/emaccess
. For information on creating a monitoring role, go
to Setting Up and Enabling Enhanced Monitoring in the Amazon RDS User Guide.
If MonitoringInterval
is set to a value other than 0, then you must supply a
MonitoringRoleArn
value.
monitoringRoleArn
- The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs.
For example, arn:aws:iam:123456789012:role/emaccess
. For information on creating a monitoring
role, go to Setting Up and Enabling Enhanced Monitoring in the Amazon RDS User Guide.
If MonitoringInterval
is set to a value other than 0, then you must supply a
MonitoringRoleArn
value.
public String getMonitoringRoleArn()
The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs. For
example, arn:aws:iam:123456789012:role/emaccess
. For information on creating a monitoring role, go
to Setting Up and Enabling Enhanced Monitoring in the Amazon RDS User Guide.
If MonitoringInterval
is set to a value other than 0, then you must supply a
MonitoringRoleArn
value.
arn:aws:iam:123456789012:role/emaccess
. For information on creating a
monitoring role, go to Setting Up and Enabling Enhanced Monitoring in the Amazon RDS User Guide.
If MonitoringInterval
is set to a value other than 0, then you must supply a
MonitoringRoleArn
value.
public CreateDBInstanceRequest withMonitoringRoleArn(String monitoringRoleArn)
The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs. For
example, arn:aws:iam:123456789012:role/emaccess
. For information on creating a monitoring role, go
to Setting Up and Enabling Enhanced Monitoring in the Amazon RDS User Guide.
If MonitoringInterval
is set to a value other than 0, then you must supply a
MonitoringRoleArn
value.
monitoringRoleArn
- The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs.
For example, arn:aws:iam:123456789012:role/emaccess
. For information on creating a monitoring
role, go to Setting Up and Enabling Enhanced Monitoring in the Amazon RDS User Guide.
If MonitoringInterval
is set to a value other than 0, then you must supply a
MonitoringRoleArn
value.
public void setDomainIAMRoleName(String domainIAMRoleName)
Specify the name of the IAM role to be used when making API calls to the Directory Service.
domainIAMRoleName
- Specify the name of the IAM role to be used when making API calls to the Directory Service.public String getDomainIAMRoleName()
Specify the name of the IAM role to be used when making API calls to the Directory Service.
public CreateDBInstanceRequest withDomainIAMRoleName(String domainIAMRoleName)
Specify the name of the IAM role to be used when making API calls to the Directory Service.
domainIAMRoleName
- Specify the name of the IAM role to be used when making API calls to the Directory Service.public void setPromotionTier(Integer promotionTier)
A value that specifies the order in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance. For more information, see Fault Tolerance for an Aurora DB Cluster in the Amazon Aurora User Guide.
Default: 1
Valid Values: 0 - 15
promotionTier
- A value that specifies the order in which an Aurora Replica is promoted to the primary instance after a
failure of the existing primary instance. For more information, see Fault Tolerance for an Aurora DB Cluster in the Amazon Aurora User Guide.
Default: 1
Valid Values: 0 - 15
public Integer getPromotionTier()
A value that specifies the order in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance. For more information, see Fault Tolerance for an Aurora DB Cluster in the Amazon Aurora User Guide.
Default: 1
Valid Values: 0 - 15
Default: 1
Valid Values: 0 - 15
public CreateDBInstanceRequest withPromotionTier(Integer promotionTier)
A value that specifies the order in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance. For more information, see Fault Tolerance for an Aurora DB Cluster in the Amazon Aurora User Guide.
Default: 1
Valid Values: 0 - 15
promotionTier
- A value that specifies the order in which an Aurora Replica is promoted to the primary instance after a
failure of the existing primary instance. For more information, see Fault Tolerance for an Aurora DB Cluster in the Amazon Aurora User Guide.
Default: 1
Valid Values: 0 - 15
public void setTimezone(String timezone)
The time zone of the DB instance. The time zone parameter is currently supported only by Microsoft SQL Server.
timezone
- The time zone of the DB instance. The time zone parameter is currently supported only by Microsoft SQL Server.public String getTimezone()
The time zone of the DB instance. The time zone parameter is currently supported only by Microsoft SQL Server.
public CreateDBInstanceRequest withTimezone(String timezone)
The time zone of the DB instance. The time zone parameter is currently supported only by Microsoft SQL Server.
timezone
- The time zone of the DB instance. The time zone parameter is currently supported only by Microsoft SQL Server.public void setEnableIAMDatabaseAuthentication(Boolean enableIAMDatabaseAuthentication)
A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled.
You can enable IAM database authentication for the following database engines:
Amazon Aurora
Not applicable. Mapping AWS IAM accounts to database accounts is managed by the DB cluster.
MySQL
For MySQL 5.6, minor version 5.6.34 or higher
For MySQL 5.7, minor version 5.7.16 or higher
For MySQL 8.0, minor version 8.0.16 or higher
PostgreSQL
For PostgreSQL 9.5, minor version 9.5.15 or higher
For PostgreSQL 9.6, minor version 9.6.11 or higher
PostgreSQL 10.6, 10.7, and 10.9
For more information, see IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.
enableIAMDatabaseAuthentication
- A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to
database accounts. By default, mapping is disabled.
You can enable IAM database authentication for the following database engines:
Amazon Aurora
Not applicable. Mapping AWS IAM accounts to database accounts is managed by the DB cluster.
MySQL
For MySQL 5.6, minor version 5.6.34 or higher
For MySQL 5.7, minor version 5.7.16 or higher
For MySQL 8.0, minor version 8.0.16 or higher
PostgreSQL
For PostgreSQL 9.5, minor version 9.5.15 or higher
For PostgreSQL 9.6, minor version 9.6.11 or higher
PostgreSQL 10.6, 10.7, and 10.9
For more information, see IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.
public Boolean getEnableIAMDatabaseAuthentication()
A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled.
You can enable IAM database authentication for the following database engines:
Amazon Aurora
Not applicable. Mapping AWS IAM accounts to database accounts is managed by the DB cluster.
MySQL
For MySQL 5.6, minor version 5.6.34 or higher
For MySQL 5.7, minor version 5.7.16 or higher
For MySQL 8.0, minor version 8.0.16 or higher
PostgreSQL
For PostgreSQL 9.5, minor version 9.5.15 or higher
For PostgreSQL 9.6, minor version 9.6.11 or higher
PostgreSQL 10.6, 10.7, and 10.9
For more information, see IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.
You can enable IAM database authentication for the following database engines:
Amazon Aurora
Not applicable. Mapping AWS IAM accounts to database accounts is managed by the DB cluster.
MySQL
For MySQL 5.6, minor version 5.6.34 or higher
For MySQL 5.7, minor version 5.7.16 or higher
For MySQL 8.0, minor version 8.0.16 or higher
PostgreSQL
For PostgreSQL 9.5, minor version 9.5.15 or higher
For PostgreSQL 9.6, minor version 9.6.11 or higher
PostgreSQL 10.6, 10.7, and 10.9
For more information, see IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.
public CreateDBInstanceRequest withEnableIAMDatabaseAuthentication(Boolean enableIAMDatabaseAuthentication)
A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled.
You can enable IAM database authentication for the following database engines:
Amazon Aurora
Not applicable. Mapping AWS IAM accounts to database accounts is managed by the DB cluster.
MySQL
For MySQL 5.6, minor version 5.6.34 or higher
For MySQL 5.7, minor version 5.7.16 or higher
For MySQL 8.0, minor version 8.0.16 or higher
PostgreSQL
For PostgreSQL 9.5, minor version 9.5.15 or higher
For PostgreSQL 9.6, minor version 9.6.11 or higher
PostgreSQL 10.6, 10.7, and 10.9
For more information, see IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.
enableIAMDatabaseAuthentication
- A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to
database accounts. By default, mapping is disabled.
You can enable IAM database authentication for the following database engines:
Amazon Aurora
Not applicable. Mapping AWS IAM accounts to database accounts is managed by the DB cluster.
MySQL
For MySQL 5.6, minor version 5.6.34 or higher
For MySQL 5.7, minor version 5.7.16 or higher
For MySQL 8.0, minor version 8.0.16 or higher
PostgreSQL
For PostgreSQL 9.5, minor version 9.5.15 or higher
For PostgreSQL 9.6, minor version 9.6.11 or higher
PostgreSQL 10.6, 10.7, and 10.9
For more information, see IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.
public Boolean isEnableIAMDatabaseAuthentication()
A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled.
You can enable IAM database authentication for the following database engines:
Amazon Aurora
Not applicable. Mapping AWS IAM accounts to database accounts is managed by the DB cluster.
MySQL
For MySQL 5.6, minor version 5.6.34 or higher
For MySQL 5.7, minor version 5.7.16 or higher
For MySQL 8.0, minor version 8.0.16 or higher
PostgreSQL
For PostgreSQL 9.5, minor version 9.5.15 or higher
For PostgreSQL 9.6, minor version 9.6.11 or higher
PostgreSQL 10.6, 10.7, and 10.9
For more information, see IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.
You can enable IAM database authentication for the following database engines:
Amazon Aurora
Not applicable. Mapping AWS IAM accounts to database accounts is managed by the DB cluster.
MySQL
For MySQL 5.6, minor version 5.6.34 or higher
For MySQL 5.7, minor version 5.7.16 or higher
For MySQL 8.0, minor version 8.0.16 or higher
PostgreSQL
For PostgreSQL 9.5, minor version 9.5.15 or higher
For PostgreSQL 9.6, minor version 9.6.11 or higher
PostgreSQL 10.6, 10.7, and 10.9
For more information, see IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.
public void setEnablePerformanceInsights(Boolean enablePerformanceInsights)
A value that indicates whether to enable Performance Insights for the DB instance.
For more information, see Using Amazon Performance Insights in the Amazon Relational Database Service User Guide.
enablePerformanceInsights
- A value that indicates whether to enable Performance Insights for the DB instance.
For more information, see Using Amazon Performance Insights in the Amazon Relational Database Service User Guide.
public Boolean getEnablePerformanceInsights()
A value that indicates whether to enable Performance Insights for the DB instance.
For more information, see Using Amazon Performance Insights in the Amazon Relational Database Service User Guide.
For more information, see Using Amazon Performance Insights in the Amazon Relational Database Service User Guide.
public CreateDBInstanceRequest withEnablePerformanceInsights(Boolean enablePerformanceInsights)
A value that indicates whether to enable Performance Insights for the DB instance.
For more information, see Using Amazon Performance Insights in the Amazon Relational Database Service User Guide.
enablePerformanceInsights
- A value that indicates whether to enable Performance Insights for the DB instance.
For more information, see Using Amazon Performance Insights in the Amazon Relational Database Service User Guide.
public Boolean isEnablePerformanceInsights()
A value that indicates whether to enable Performance Insights for the DB instance.
For more information, see Using Amazon Performance Insights in the Amazon Relational Database Service User Guide.
For more information, see Using Amazon Performance Insights in the Amazon Relational Database Service User Guide.
public void setPerformanceInsightsKMSKeyId(String performanceInsightsKMSKeyId)
The AWS KMS key identifier for encryption of Performance Insights data. The KMS key ID is the Amazon Resource Name (ARN), KMS key identifier, or the KMS key alias for the KMS encryption key.
If you do not specify a value for PerformanceInsightsKMSKeyId
, then Amazon RDS uses 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.
performanceInsightsKMSKeyId
- The AWS KMS key identifier for encryption of Performance Insights data. The KMS key ID is the Amazon
Resource Name (ARN), KMS key identifier, or the KMS key alias for the KMS encryption key.
If you do not specify a value for PerformanceInsightsKMSKeyId
, then Amazon RDS uses your
default encryption key. AWS KMS creates the default encryption key for your AWS account. Your AWS account
has a different default encryption key for each AWS Region.
public String getPerformanceInsightsKMSKeyId()
The AWS KMS key identifier for encryption of Performance Insights data. The KMS key ID is the Amazon Resource Name (ARN), KMS key identifier, or the KMS key alias for the KMS encryption key.
If you do not specify a value for PerformanceInsightsKMSKeyId
, then Amazon RDS uses 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.
If you do not specify a value for PerformanceInsightsKMSKeyId
, then Amazon RDS uses 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 withPerformanceInsightsKMSKeyId(String performanceInsightsKMSKeyId)
The AWS KMS key identifier for encryption of Performance Insights data. The KMS key ID is the Amazon Resource Name (ARN), KMS key identifier, or the KMS key alias for the KMS encryption key.
If you do not specify a value for PerformanceInsightsKMSKeyId
, then Amazon RDS uses 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.
performanceInsightsKMSKeyId
- The AWS KMS key identifier for encryption of Performance Insights data. The KMS key ID is the Amazon
Resource Name (ARN), KMS key identifier, or the KMS key alias for the KMS encryption key.
If you do not specify a value for PerformanceInsightsKMSKeyId
, then Amazon RDS uses 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 setPerformanceInsightsRetentionPeriod(Integer performanceInsightsRetentionPeriod)
The amount of time, in days, to retain Performance Insights data. Valid values are 7 or 731 (2 years).
performanceInsightsRetentionPeriod
- The amount of time, in days, to retain Performance Insights data. Valid values are 7 or 731 (2 years).public Integer getPerformanceInsightsRetentionPeriod()
The amount of time, in days, to retain Performance Insights data. Valid values are 7 or 731 (2 years).
public CreateDBInstanceRequest withPerformanceInsightsRetentionPeriod(Integer performanceInsightsRetentionPeriod)
The amount of time, in days, to retain Performance Insights data. Valid values are 7 or 731 (2 years).
performanceInsightsRetentionPeriod
- The amount of time, in days, to retain Performance Insights data. Valid values are 7 or 731 (2 years).public List<String> getEnableCloudwatchLogsExports()
The list of log types that need to be enabled for exporting to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Relational Database Service User Guide.
public void setEnableCloudwatchLogsExports(Collection<String> enableCloudwatchLogsExports)
The list of log types that need to be enabled for exporting to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Relational Database Service User Guide.
enableCloudwatchLogsExports
- The list of log types that need to be enabled for exporting to CloudWatch Logs. The values in the list
depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Relational Database Service User
Guide.public CreateDBInstanceRequest withEnableCloudwatchLogsExports(String... enableCloudwatchLogsExports)
The list of log types that need to be enabled for exporting to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Relational Database Service User Guide.
NOTE: This method appends the values to the existing list (if any). Use
setEnableCloudwatchLogsExports(java.util.Collection)
or
withEnableCloudwatchLogsExports(java.util.Collection)
if you want to override the existing values.
enableCloudwatchLogsExports
- The list of log types that need to be enabled for exporting to CloudWatch Logs. The values in the list
depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Relational Database Service User
Guide.public CreateDBInstanceRequest withEnableCloudwatchLogsExports(Collection<String> enableCloudwatchLogsExports)
The list of log types that need to be enabled for exporting to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Relational Database Service User Guide.
enableCloudwatchLogsExports
- The list of log types that need to be enabled for exporting to CloudWatch Logs. The values in the list
depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Relational Database Service User
Guide.public List<ProcessorFeature> getProcessorFeatures()
The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
public void setProcessorFeatures(Collection<ProcessorFeature> processorFeatures)
The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
processorFeatures
- The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.public CreateDBInstanceRequest withProcessorFeatures(ProcessorFeature... processorFeatures)
The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
NOTE: This method appends the values to the existing list (if any). Use
setProcessorFeatures(java.util.Collection)
or withProcessorFeatures(java.util.Collection)
if
you want to override the existing values.
processorFeatures
- The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.public CreateDBInstanceRequest withProcessorFeatures(Collection<ProcessorFeature> processorFeatures)
The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
processorFeatures
- The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.public void setDeletionProtection(Boolean deletionProtection)
A value that indicates whether the DB instance has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled. For more information, see Deleting a DB Instance.
Amazon Aurora
Not applicable. You can enable or disable deletion protection for the DB cluster. For more information, see
CreateDBCluster
. DB instances in a DB cluster can be deleted even when deletion protection is
enabled for the DB cluster.
deletionProtection
- A value that indicates whether the DB instance has deletion protection enabled. The database can't be
deleted when deletion protection is enabled. By default, deletion protection is disabled. For more
information, see Deleting a DB
Instance.
Amazon Aurora
Not applicable. You can enable or disable deletion protection for the DB cluster. For more information,
see CreateDBCluster
. DB instances in a DB cluster can be deleted even when deletion
protection is enabled for the DB cluster.
public Boolean getDeletionProtection()
A value that indicates whether the DB instance has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled. For more information, see Deleting a DB Instance.
Amazon Aurora
Not applicable. You can enable or disable deletion protection for the DB cluster. For more information, see
CreateDBCluster
. DB instances in a DB cluster can be deleted even when deletion protection is
enabled for the DB cluster.
Amazon Aurora
Not applicable. You can enable or disable deletion protection for the DB cluster. For more information,
see CreateDBCluster
. DB instances in a DB cluster can be deleted even when deletion
protection is enabled for the DB cluster.
public CreateDBInstanceRequest withDeletionProtection(Boolean deletionProtection)
A value that indicates whether the DB instance has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled. For more information, see Deleting a DB Instance.
Amazon Aurora
Not applicable. You can enable or disable deletion protection for the DB cluster. For more information, see
CreateDBCluster
. DB instances in a DB cluster can be deleted even when deletion protection is
enabled for the DB cluster.
deletionProtection
- A value that indicates whether the DB instance has deletion protection enabled. The database can't be
deleted when deletion protection is enabled. By default, deletion protection is disabled. For more
information, see Deleting a DB
Instance.
Amazon Aurora
Not applicable. You can enable or disable deletion protection for the DB cluster. For more information,
see CreateDBCluster
. DB instances in a DB cluster can be deleted even when deletion
protection is enabled for the DB cluster.
public Boolean isDeletionProtection()
A value that indicates whether the DB instance has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled. For more information, see Deleting a DB Instance.
Amazon Aurora
Not applicable. You can enable or disable deletion protection for the DB cluster. For more information, see
CreateDBCluster
. DB instances in a DB cluster can be deleted even when deletion protection is
enabled for the DB cluster.
Amazon Aurora
Not applicable. You can enable or disable deletion protection for the DB cluster. For more information,
see CreateDBCluster
. DB instances in a DB cluster can be deleted even when deletion
protection is enabled for the DB cluster.
public void setMaxAllocatedStorage(Integer maxAllocatedStorage)
The upper limit to which Amazon RDS can automatically scale the storage of the DB instance.
maxAllocatedStorage
- The upper limit to which Amazon RDS can automatically scale the storage of the DB instance.public Integer getMaxAllocatedStorage()
The upper limit to which Amazon RDS can automatically scale the storage of the DB instance.
public CreateDBInstanceRequest withMaxAllocatedStorage(Integer maxAllocatedStorage)
The upper limit to which Amazon RDS can automatically scale the storage of the DB instance.
maxAllocatedStorage
- The upper limit to which Amazon RDS can automatically scale the storage of the DB instance.public String toString()
toString
in class Object
Object.toString()
public CreateDBInstanceRequest clone()
AmazonWebServiceRequest
clone
in class AmazonWebServiceRequest
Object.clone()
Copyright © 2013 Amazon Web Services, Inc. All Rights Reserved.