@Generated(value="software.amazon.awssdk:codegen") public final class CreateDbInstanceRequest extends RdsRequest implements ToCopyableBuilder<CreateDbInstanceRequest.Builder,CreateDbInstanceRequest>
Modifier and Type | Class and Description |
---|---|
static interface |
CreateDbInstanceRequest.Builder |
Modifier and Type | Method and Description |
---|---|
Integer |
allocatedStorage()
The amount of storage (in gibibytes) to allocate for the DB instance.
|
Boolean |
autoMinorVersionUpgrade()
A value that indicates whether minor engine upgrades are applied automatically to the DB instance during the
maintenance window.
|
String |
availabilityZone()
The Availability Zone (AZ) where the database will be created.
|
Integer |
backupRetentionPeriod()
The number of days for which automated backups are retained.
|
static CreateDbInstanceRequest.Builder |
builder() |
String |
characterSetName()
For supported engines, indicates that the DB instance should be associated with the specified CharacterSet.
|
Boolean |
copyTagsToSnapshot()
A value that indicates whether to copy tags from the DB instance to snapshots of the DB instance.
|
String |
dbClusterIdentifier()
The identifier of the DB cluster that the instance will belong to.
|
String |
dbInstanceClass()
The compute and memory capacity of the DB instance, for example,
db.m4.large . |
String |
dbInstanceIdentifier()
The DB instance identifier.
|
String |
dbName()
The meaning of this parameter differs according to the database engine you use.
|
String |
dbParameterGroupName()
The name of the DB parameter group to associate with this DB instance.
|
List<String> |
dbSecurityGroups()
A list of DB security groups to associate with this DB instance.
|
String |
dbSubnetGroupName()
A DB subnet group to associate with this DB instance.
|
Boolean |
deletionProtection()
A value that indicates whether the DB instance has deletion protection enabled.
|
String |
domain()
The Active Directory directory ID to create the DB instance in.
|
String |
domainIAMRoleName()
Specify the name of the IAM role to be used when making API calls to the Directory Service.
|
List<String> |
enableCloudwatchLogsExports()
The list of log types that need to be enabled for exporting to CloudWatch Logs.
|
Boolean |
enableCustomerOwnedIp()
A value that indicates whether to enable a customer-owned IP address (CoIP) for an RDS on Outposts DB instance.
|
Boolean |
enableIAMDatabaseAuthentication()
A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database
accounts.
|
Boolean |
enablePerformanceInsights()
A value that indicates whether to enable Performance Insights for the DB instance.
|
String |
engine()
The name of the database engine to be used for this instance.
|
String |
engineVersion()
The version number of the database engine to use.
|
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj)
Indicates whether some other object is "equal to" this one by SDK fields.
|
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz)
Used to retrieve the value of a field from any class that extends
SdkRequest . |
boolean |
hasDbSecurityGroups()
Returns true if the DBSecurityGroups property was specified by the sender (it may be empty), or false if the
sender did not specify the value (it will be empty).
|
boolean |
hasEnableCloudwatchLogsExports()
Returns true if the EnableCloudwatchLogsExports property was specified by the sender (it may be empty), or false
if the sender did not specify the value (it will be empty).
|
int |
hashCode() |
boolean |
hasProcessorFeatures()
Returns true if the ProcessorFeatures property was specified by the sender (it may be empty), or false if the
sender did not specify the value (it will be empty).
|
boolean |
hasTags()
Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not
specify the value (it will be empty).
|
boolean |
hasVpcSecurityGroupIds()
Returns true if the VpcSecurityGroupIds property was specified by the sender (it may be empty), or false if the
sender did not specify the value (it will be empty).
|
Integer |
iops()
The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB
instance.
|
String |
kmsKeyId()
The AWS KMS key identifier for an encrypted DB instance.
|
String |
licenseModel()
License model information for this DB instance.
|
String |
masterUsername()
The name for the master user.
|
String |
masterUserPassword()
The password for the master user.
|
Integer |
maxAllocatedStorage()
The upper limit to which Amazon RDS can automatically scale the storage of the DB instance.
|
Integer |
monitoringInterval()
The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance.
|
String |
monitoringRoleArn()
The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs.
|
Boolean |
multiAZ()
A value that indicates whether the DB instance is a Multi-AZ deployment.
|
String |
ncharCharacterSetName()
The name of the NCHAR character set for the Oracle DB instance.
|
String |
optionGroupName()
A value that indicates that the DB instance should be associated with the specified option group.
|
String |
performanceInsightsKMSKeyId()
The AWS KMS key identifier for encryption of Performance Insights data.
|
Integer |
performanceInsightsRetentionPeriod()
The amount of time, in days, to retain Performance Insights data.
|
Integer |
port()
The port number on which the database accepts connections.
|
String |
preferredBackupWindow()
The daily time range during which automated backups are created if automated backups are enabled, using the
BackupRetentionPeriod parameter. |
String |
preferredMaintenanceWindow()
The time range each week during which system maintenance can occur, in Universal Coordinated Time (UTC).
|
List<ProcessorFeature> |
processorFeatures()
The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
|
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.
|
Boolean |
publiclyAccessible()
A value that indicates whether the DB instance is publicly accessible.
|
List<SdkField<?>> |
sdkFields() |
static Class<? extends CreateDbInstanceRequest.Builder> |
serializableBuilderClass() |
Boolean |
storageEncrypted()
A value that indicates whether the DB instance is encrypted.
|
String |
storageType()
Specifies the storage type to be associated with the DB instance.
|
List<Tag> |
tags()
Tags to assign to the DB instance.
|
String |
tdeCredentialArn()
The ARN from the key store with which to associate the instance for TDE encryption.
|
String |
tdeCredentialPassword()
The password for the given ARN from the key store in order to access the device.
|
String |
timezone()
The time zone of the DB instance.
|
CreateDbInstanceRequest.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString()
Returns a string representation of this object.
|
List<String> |
vpcSecurityGroupIds()
A list of Amazon EC2 VPC security groups to associate with this DB instance.
|
overrideConfiguration
copy
public final 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.
Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9).
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.
Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9).
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, no database is created in the DB instance.
Constraints:
Must contain 1 to 63 letters, numbers, or underscores.
Must begin with a letter. 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.
Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9).
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.
Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9).
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, no database is created in the DB instance.
Constraints:
Must contain 1 to 63 letters, numbers, or underscores.
Must begin with a letter. 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 final 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
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 final 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.
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 final 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.
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 final 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
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 final 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.
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 final 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.
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 final boolean hasDbSecurityGroups()
public final List<String> dbSecurityGroups()
A list of DB security groups to associate with this DB instance.
Default: The default DB security group for the database engine.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
You can use hasDbSecurityGroups()
to see if a value was sent in this field.
Default: The default DB security group for the database engine.
public final boolean hasVpcSecurityGroupIds()
public final List<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.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
You can use hasVpcSecurityGroupIds()
to see if a value was sent in this field.
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 final 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.
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 final 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.
If there is no DB subnet group, then it is a non-VPC DB instance.
public final 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.
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 final 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
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 final 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
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 final 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.
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 final 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 1234
, 1434
, 3260
,
3343
, 3389
, 47001
, and 49152-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 1234
, 1434
, 3260
,
3343
, 3389
, 47001
, and 49152-49156
.
Amazon Aurora
Default: 3306
Valid values: 1150-65535
Type: Integer
public final 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.
AvailabilityZone
parameter if the DB instance is a Multi-AZ deployment.public final 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 Microsoft SQL Server Versions 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 Amazon RDS for PostgreSQL versions and extensions 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 Microsoft SQL Server Versions 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 Amazon RDS for PostgreSQL versions and extensions in the Amazon RDS User Guide.
public final 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.
public final String licenseModel()
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 final 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.
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 final String optionGroupName()
A value that 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. Also, 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. Also, that option group can't be removed from a DB instance once it is associated with a DB instance
public final 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
.
Amazon Aurora
Not applicable. The character set is managed by the DB cluster. For more information, see
CreateDBCluster
.
public final String ncharCharacterSetName()
The name of the NCHAR character set for the Oracle DB instance.
public final Boolean publiclyAccessible()
A value that indicates whether the DB instance is publicly accessible.
When the DB instance is publicly accessible, its DNS endpoint resolves to the private IP address from within the DB instance's VPC, and to the public IP address from outside of the DB instance's VPC. Access to the DB instance is ultimately controlled by the security group it uses, and that public access is not permitted if the security group assigned to the DB instance doesn't permit it.
When the DB instance isn't publicly accessible, it is an internal DB 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.
When the DB instance is publicly accessible, its DNS endpoint resolves to the private IP address from within the DB instance's VPC, and to the public IP address from outside of the DB instance's VPC. Access to the DB instance is ultimately controlled by the security group it uses, and that public access is not permitted if the security group assigned to the DB instance doesn't permit it.
When the DB instance isn't publicly accessible, it is an internal DB 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 final boolean hasTags()
public final List<Tag> tags()
Tags to assign to the DB instance.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
You can use hasTags()
to see if a value was sent in this field.
public final String dbClusterIdentifier()
The identifier of the DB cluster that the instance will belong to.
public final 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
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 final String tdeCredentialArn()
The ARN from the key store with which to associate the instance for TDE encryption.
public final String tdeCredentialPassword()
The password for the given ARN from the key store in order to access the device.
public final 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.
Amazon Aurora
Not applicable. The encryption for DB instances is managed by the DB cluster.
public final String kmsKeyId()
The AWS KMS key identifier for an encrypted DB instance.
The AWS KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the AWS KMS customer master key (CMK). To use a CMK in a different AWS account, specify the key ARN or alias ARN.
Amazon Aurora
Not applicable. The AWS 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 uses your default CMK. There is a default CMK for your AWS account. Your AWS account
has a different default CMK for each AWS Region.
The AWS KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the AWS KMS customer master key (CMK). To use a CMK in a different AWS account, specify the key ARN or alias ARN.
Amazon Aurora
Not applicable. The AWS 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 uses your default CMK. There is a default CMK for your AWS account. Your AWS
account has a different default CMK for each AWS Region.
public final String domain()
The Active Directory directory ID to create the DB instance in. Currently, only MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB instances can be created in an Active Directory Domain.
For more information, see Kerberos Authentication in the Amazon RDS User Guide.
For more information, see Kerberos Authentication in the Amazon RDS User Guide.
public final 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.
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 final 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
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 final 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.
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 final String domainIAMRoleName()
Specify the name of the IAM role to be used when making API calls to the Directory Service.
public final 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
Default: 1
Valid Values: 0 - 15
public final String timezone()
The time zone of the DB instance. The time zone parameter is currently supported only by Microsoft SQL Server.
public final 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.
This setting doesn't apply to Amazon Aurora. Mapping AWS IAM accounts to database accounts is managed by the DB cluster.
For more information, see IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.
This setting doesn't apply to Amazon Aurora. Mapping AWS IAM accounts to database accounts is managed by the DB cluster.
For more information, see IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.
public final 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.
For more information, see Using Amazon Performance Insights in the Amazon Relational Database Service User Guide.
public final String performanceInsightsKMSKeyId()
The AWS KMS key identifier for encryption of Performance Insights data.
The AWS KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the AWS KMS customer master key (CMK).
If you do not specify a value for PerformanceInsightsKMSKeyId
, then Amazon RDS uses your default
CMK. There is a default CMK for your AWS account. Your AWS account has a different default CMK for each AWS
Region.
The AWS KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the AWS KMS customer master key (CMK).
If you do not specify a value for PerformanceInsightsKMSKeyId
, then Amazon RDS uses your
default CMK. There is a default CMK for your AWS account. Your AWS account has a different default CMK
for each AWS Region.
public final Integer performanceInsightsRetentionPeriod()
The amount of time, in days, to retain Performance Insights data. Valid values are 7 or 731 (2 years).
public final boolean hasEnableCloudwatchLogsExports()
public final List<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.
Amazon Aurora
Not applicable. CloudWatch Logs exports are managed by the DB cluster.
MariaDB
Possible values are audit
, error
, general
, and slowquery
.
Microsoft SQL Server
Possible values are agent
and error
.
MySQL
Possible values are audit
, error
, general
, and slowquery
.
Oracle
Possible values are alert
, audit
, listener
, trace
, and
oemagent
.
PostgreSQL
Possible values are postgresql
and upgrade
.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
You can use hasEnableCloudwatchLogsExports()
to see if a value was sent in this field.
Amazon Aurora
Not applicable. CloudWatch Logs exports are managed by the DB cluster.
MariaDB
Possible values are audit
, error
, general
, and
slowquery
.
Microsoft SQL Server
Possible values are agent
and error
.
MySQL
Possible values are audit
, error
, general
, and
slowquery
.
Oracle
Possible values are alert
, audit
, listener
, trace
,
and oemagent
.
PostgreSQL
Possible values are postgresql
and upgrade
.
public final boolean hasProcessorFeatures()
public final List<ProcessorFeature> processorFeatures()
The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
You can use hasProcessorFeatures()
to see if a value was sent in this field.
public final 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.
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 final Integer maxAllocatedStorage()
The upper limit to which Amazon RDS can automatically scale the storage of the DB instance.
public final Boolean enableCustomerOwnedIp()
A value that indicates whether to enable a customer-owned IP address (CoIP) for an RDS on Outposts DB instance.
A CoIP provides local or external connectivity to resources in your Outpost subnets through your on-premises network. For some use cases, a CoIP can provide lower latency for connections to the DB instance from outside of its virtual private cloud (VPC) on your local network.
For more information about RDS on Outposts, see Working with Amazon RDS on AWS Outposts in the Amazon RDS User Guide.
For more information about CoIPs, see Customer-owned IP addresses in the AWS Outposts User Guide.
A CoIP provides local or external connectivity to resources in your Outpost subnets through your on-premises network. For some use cases, a CoIP can provide lower latency for connections to the DB instance from outside of its virtual private cloud (VPC) on your local network.
For more information about RDS on Outposts, see Working with Amazon RDS on AWS Outposts in the Amazon RDS User Guide.
For more information about CoIPs, see Customer-owned IP addresses in the AWS Outposts User Guide.
public CreateDbInstanceRequest.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<CreateDbInstanceRequest.Builder,CreateDbInstanceRequest>
toBuilder
in class RdsRequest
public static CreateDbInstanceRequest.Builder builder()
public static Class<? extends CreateDbInstanceRequest.Builder> serializableBuilderClass()
public final int hashCode()
hashCode
in class AwsRequest
public final boolean equals(Object obj)
equals
in class AwsRequest
public final boolean equalsBySdkFields(Object obj)
SdkPojo
SdkPojo
class,
and is generated based on a service model.
If an SdkPojo
class does not have any inherited fields, equalsBySdkFields
and equals
are essentially the same.
equalsBySdkFields
in interface SdkPojo
obj
- the object to be compared withpublic final String toString()
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
SdkRequest
SdkRequest
. The field name
specified should match the member name from the corresponding service-2.json model specified in the
codegen-resources folder for a given service. The class specifies what class to cast the returned value to.
If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class)
method will
again be available.getValueForField
in class SdkRequest
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.Copyright © 2021 Amazon Web Services, Inc. All Rights Reserved.