public static interface CreateDbInstanceRequest.Builder extends RdsRequest.Builder, SdkPojo, CopyableBuilder<CreateDbInstanceRequest.Builder,CreateDbInstanceRequest>
| Modifier and Type | Method and Description |
|---|---|
CreateDbInstanceRequest.Builder |
allocatedStorage(Integer allocatedStorage)
The amount of storage (in gibibytes) to allocate for the DB instance.
|
CreateDbInstanceRequest.Builder |
autoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade)
A value that indicates whether minor engine upgrades are applied automatically to the DB instance during the
maintenance window.
|
CreateDbInstanceRequest.Builder |
availabilityZone(String availabilityZone)
The Availability Zone (AZ) where the database will be created.
|
CreateDbInstanceRequest.Builder |
backupRetentionPeriod(Integer backupRetentionPeriod)
The number of days for which automated backups are retained.
|
CreateDbInstanceRequest.Builder |
characterSetName(String characterSetName)
For supported engines, indicates that the DB instance should be associated with the specified CharacterSet.
|
CreateDbInstanceRequest.Builder |
copyTagsToSnapshot(Boolean copyTagsToSnapshot)
A value that indicates whether to copy tags from the DB instance to snapshots of the DB instance.
|
CreateDbInstanceRequest.Builder |
dbClusterIdentifier(String dbClusterIdentifier)
The identifier of the DB cluster that the instance will belong to.
|
CreateDbInstanceRequest.Builder |
dbInstanceClass(String dbInstanceClass)
The compute and memory capacity of the DB instance, for example,
db.m4.large. |
CreateDbInstanceRequest.Builder |
dbInstanceIdentifier(String dbInstanceIdentifier)
The DB instance identifier.
|
CreateDbInstanceRequest.Builder |
dbName(String dbName)
The meaning of this parameter differs according to the database engine you use.
|
CreateDbInstanceRequest.Builder |
dbParameterGroupName(String dbParameterGroupName)
The name of the DB parameter group to associate with this DB instance.
|
CreateDbInstanceRequest.Builder |
dbSecurityGroups(Collection<String> dbSecurityGroups)
A list of DB security groups to associate with this DB instance.
|
CreateDbInstanceRequest.Builder |
dbSecurityGroups(String... dbSecurityGroups)
A list of DB security groups to associate with this DB instance.
|
CreateDbInstanceRequest.Builder |
dbSubnetGroupName(String dbSubnetGroupName)
A DB subnet group to associate with this DB instance.
|
CreateDbInstanceRequest.Builder |
deletionProtection(Boolean deletionProtection)
A value that indicates whether the DB instance has deletion protection enabled.
|
CreateDbInstanceRequest.Builder |
domain(String domain)
The Active Directory directory ID to create the DB instance in.
|
CreateDbInstanceRequest.Builder |
domainIAMRoleName(String domainIAMRoleName)
Specify the name of the IAM role to be used when making API calls to the Directory Service.
|
CreateDbInstanceRequest.Builder |
enableCloudwatchLogsExports(Collection<String> enableCloudwatchLogsExports)
The list of log types that need to be enabled for exporting to CloudWatch Logs.
|
CreateDbInstanceRequest.Builder |
enableCloudwatchLogsExports(String... enableCloudwatchLogsExports)
The list of log types that need to be enabled for exporting to CloudWatch Logs.
|
CreateDbInstanceRequest.Builder |
enableCustomerOwnedIp(Boolean enableCustomerOwnedIp)
A value that indicates whether to enable a customer-owned IP address (CoIP) for an RDS on Outposts DB
instance.
|
CreateDbInstanceRequest.Builder |
enableIAMDatabaseAuthentication(Boolean enableIAMDatabaseAuthentication)
A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to
database accounts.
|
CreateDbInstanceRequest.Builder |
enablePerformanceInsights(Boolean enablePerformanceInsights)
A value that indicates whether to enable Performance Insights for the DB instance.
|
CreateDbInstanceRequest.Builder |
engine(String engine)
The name of the database engine to be used for this instance.
|
CreateDbInstanceRequest.Builder |
engineVersion(String engineVersion)
The version number of the database engine to use.
|
CreateDbInstanceRequest.Builder |
iops(Integer iops)
The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB
instance.
|
CreateDbInstanceRequest.Builder |
kmsKeyId(String kmsKeyId)
The AWS KMS key identifier for an encrypted DB instance.
|
CreateDbInstanceRequest.Builder |
licenseModel(String licenseModel)
License model information for this DB instance.
|
CreateDbInstanceRequest.Builder |
masterUsername(String masterUsername)
The name for the master user.
|
CreateDbInstanceRequest.Builder |
masterUserPassword(String masterUserPassword)
The password for the master user.
|
CreateDbInstanceRequest.Builder |
maxAllocatedStorage(Integer maxAllocatedStorage)
The upper limit to which Amazon RDS can automatically scale the storage of the DB instance.
|
CreateDbInstanceRequest.Builder |
monitoringInterval(Integer monitoringInterval)
The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance.
|
CreateDbInstanceRequest.Builder |
monitoringRoleArn(String monitoringRoleArn)
The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs.
|
CreateDbInstanceRequest.Builder |
multiAZ(Boolean multiAZ)
A value that indicates whether the DB instance is a Multi-AZ deployment.
|
CreateDbInstanceRequest.Builder |
ncharCharacterSetName(String ncharCharacterSetName)
The name of the NCHAR character set for the Oracle DB instance.
|
CreateDbInstanceRequest.Builder |
optionGroupName(String optionGroupName)
A value that indicates that the DB instance should be associated with the specified option group.
|
CreateDbInstanceRequest.Builder |
overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) |
CreateDbInstanceRequest.Builder |
overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) |
CreateDbInstanceRequest.Builder |
performanceInsightsKMSKeyId(String performanceInsightsKMSKeyId)
The AWS KMS key identifier for encryption of Performance Insights data.
|
CreateDbInstanceRequest.Builder |
performanceInsightsRetentionPeriod(Integer performanceInsightsRetentionPeriod)
The amount of time, in days, to retain Performance Insights data.
|
CreateDbInstanceRequest.Builder |
port(Integer port)
The port number on which the database accepts connections.
|
CreateDbInstanceRequest.Builder |
preferredBackupWindow(String preferredBackupWindow)
The daily time range during which automated backups are created if automated backups are enabled, using the
BackupRetentionPeriod parameter. |
CreateDbInstanceRequest.Builder |
preferredMaintenanceWindow(String preferredMaintenanceWindow)
The time range each week during which system maintenance can occur, in Universal Coordinated Time (UTC).
|
CreateDbInstanceRequest.Builder |
processorFeatures(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.Builder |
processorFeatures(Consumer<ProcessorFeature.Builder>... processorFeatures)
The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
|
CreateDbInstanceRequest.Builder |
processorFeatures(ProcessorFeature... processorFeatures)
The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
|
CreateDbInstanceRequest.Builder |
promotionTier(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.Builder |
publiclyAccessible(Boolean publiclyAccessible)
A value that indicates whether the DB instance is publicly accessible.
|
CreateDbInstanceRequest.Builder |
storageEncrypted(Boolean storageEncrypted)
A value that indicates whether the DB instance is encrypted.
|
CreateDbInstanceRequest.Builder |
storageType(String storageType)
Specifies the storage type to be associated with the DB instance.
|
CreateDbInstanceRequest.Builder |
tags(Collection<Tag> tags)
Tags to assign to the DB instance.
|
CreateDbInstanceRequest.Builder |
tags(Consumer<Tag.Builder>... tags)
Tags to assign to the DB instance.
|
CreateDbInstanceRequest.Builder |
tags(Tag... tags)
Tags to assign to the DB instance.
|
CreateDbInstanceRequest.Builder |
tdeCredentialArn(String tdeCredentialArn)
The ARN from the key store with which to associate the instance for TDE encryption.
|
CreateDbInstanceRequest.Builder |
tdeCredentialPassword(String tdeCredentialPassword)
The password for the given ARN from the key store in order to access the device.
|
CreateDbInstanceRequest.Builder |
timezone(String timezone)
The time zone of the DB instance.
|
CreateDbInstanceRequest.Builder |
vpcSecurityGroupIds(Collection<String> vpcSecurityGroupIds)
A list of Amazon EC2 VPC security groups to associate with this DB instance.
|
CreateDbInstanceRequest.Builder |
vpcSecurityGroupIds(String... vpcSecurityGroupIds)
A list of Amazon EC2 VPC security groups to associate with this DB instance.
|
buildoverrideConfigurationequalsBySdkFields, sdkFieldscopyapplyMutation, buildCreateDbInstanceRequest.Builder dbName(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, a
database named postgres 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 MySQL
The name of the database to create when the primary DB instance of the Aurora MySQL DB cluster is created. If this parameter isn't specified for an Aurora MySQL DB cluster, no database is created in the DB cluster.
Constraints:
It must contain 1 to 64 alphanumeric characters.
It can't be a word reserved by the database engine.
Amazon Aurora PostgreSQL
The name of the database to create when the primary DB instance of the Aurora PostgreSQL DB cluster is
created. If this parameter isn't specified for an Aurora PostgreSQL DB cluster, a database named
postgres is created in the DB cluster.
Constraints:
It must contain 1 to 63 alphanumeric characters.
It must begin with a letter or an underscore. Subsequent characters can be letters, underscores, or digits (0 to 9).
It can't be a word reserved by the 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.
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,
a database named postgres 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 MySQL
The name of the database to create when the primary DB instance of the Aurora MySQL DB cluster is created. If this parameter isn't specified for an Aurora MySQL DB cluster, no database is created in the DB cluster.
Constraints:
It must contain 1 to 64 alphanumeric characters.
It can't be a word reserved by the database engine.
Amazon Aurora PostgreSQL
The name of the database to create when the primary DB instance of the Aurora PostgreSQL DB cluster is
created. If this parameter isn't specified for an Aurora PostgreSQL DB cluster, a database named
postgres is created in the DB cluster.
Constraints:
It must contain 1 to 63 alphanumeric characters.
It must begin with a letter or an underscore. Subsequent characters can be letters, underscores, or digits (0 to 9).
It can't be a word reserved by the database engine.
CreateDbInstanceRequest.Builder dbInstanceIdentifier(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
CreateDbInstanceRequest.Builder allocatedStorage(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.
CreateDbInstanceRequest.Builder dbInstanceClass(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.CreateDbInstanceRequest.Builder engine(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
CreateDbInstanceRequest.Builder masterUsername(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.
CreateDbInstanceRequest.Builder masterUserPassword(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.
CreateDbInstanceRequest.Builder dbSecurityGroups(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.
CreateDbInstanceRequest.Builder dbSecurityGroups(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.
CreateDbInstanceRequest.Builder vpcSecurityGroupIds(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.
CreateDbInstanceRequest.Builder vpcSecurityGroupIds(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.
CreateDbInstanceRequest.Builder availabilityZone(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.
CreateDbInstanceRequest.Builder dbSubnetGroupName(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.
CreateDbInstanceRequest.Builder preferredMaintenanceWindow(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.
CreateDbInstanceRequest.Builder dbParameterGroupName(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
CreateDbInstanceRequest.Builder backupRetentionPeriod(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
CreateDbInstanceRequest.Builder preferredBackupWindow(String preferredBackupWindow)
The daily time range during which automated backups are created if automated backups are enabled, using the
BackupRetentionPeriod parameter. The default is a 30-minute window selected at random from an
8-hour block of time for each AWS Region. For more information, see 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.
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. The default is a 30-minute window selected at
random from an 8-hour block of time for each AWS Region. For more information, see 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.
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.
CreateDbInstanceRequest.Builder port(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
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
CreateDbInstanceRequest.Builder multiAZ(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.CreateDbInstanceRequest.Builder engineVersion(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.
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.
CreateDbInstanceRequest.Builder autoMinorVersionUpgrade(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.CreateDbInstanceRequest.Builder licenseModel(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
CreateDbInstanceRequest.Builder iops(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.
CreateDbInstanceRequest.Builder optionGroupName(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
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
CreateDbInstanceRequest.Builder characterSetName(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.
CreateDbInstanceRequest.Builder ncharCharacterSetName(String ncharCharacterSetName)
The name of the NCHAR character set for the Oracle DB instance.
ncharCharacterSetName - The name of the NCHAR character set for the Oracle DB instance.CreateDbInstanceRequest.Builder publiclyAccessible(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.
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.
CreateDbInstanceRequest.Builder tags(Collection<Tag> tags)
Tags to assign to the DB instance.
tags - Tags to assign to the DB instance.CreateDbInstanceRequest.Builder tags(Tag... tags)
Tags to assign to the DB instance.
tags - Tags to assign to the DB instance.CreateDbInstanceRequest.Builder tags(Consumer<Tag.Builder>... tags)
Tags to assign to the DB instance.
This is a convenience that creates an instance of theList.Builder avoiding the need to create
one manually via List#builder() .
When the Consumer completes, List.Builder#build() is called immediately and its result
is passed to #tags(List) .tags - a consumer that will call methods on List.Builder #tags(List) CreateDbInstanceRequest.Builder dbClusterIdentifier(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.CreateDbInstanceRequest.Builder storageType(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
CreateDbInstanceRequest.Builder tdeCredentialArn(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.CreateDbInstanceRequest.Builder tdeCredentialPassword(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.CreateDbInstanceRequest.Builder storageEncrypted(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.
CreateDbInstanceRequest.Builder kmsKeyId(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.
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.
CreateDbInstanceRequest.Builder domain(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.
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.
CreateDbInstanceRequest.Builder copyTagsToSnapshot(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.
CreateDbInstanceRequest.Builder monitoringInterval(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
CreateDbInstanceRequest.Builder monitoringRoleArn(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.
CreateDbInstanceRequest.Builder domainIAMRoleName(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.CreateDbInstanceRequest.Builder promotionTier(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
CreateDbInstanceRequest.Builder timezone(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.CreateDbInstanceRequest.Builder enableIAMDatabaseAuthentication(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.
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.
CreateDbInstanceRequest.Builder enablePerformanceInsights(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.
CreateDbInstanceRequest.Builder performanceInsightsKMSKeyId(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.
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.
CreateDbInstanceRequest.Builder performanceInsightsRetentionPeriod(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).CreateDbInstanceRequest.Builder enableCloudwatchLogsExports(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.
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.
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.
CreateDbInstanceRequest.Builder enableCloudwatchLogsExports(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.
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.
CreateDbInstanceRequest.Builder processorFeatures(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.CreateDbInstanceRequest.Builder processorFeatures(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.CreateDbInstanceRequest.Builder processorFeatures(Consumer<ProcessorFeature.Builder>... processorFeatures)
The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
This is a convenience that creates an instance of theList.Builder avoiding the
need to create one manually via List#builder() .
When the Consumer completes, List.Builder#build() is called immediately and
its result is passed to #processorFeatures(List) .processorFeatures - a consumer that will call methods on List.Builder #processorFeatures(List) CreateDbInstanceRequest.Builder deletionProtection(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.
CreateDbInstanceRequest.Builder maxAllocatedStorage(Integer maxAllocatedStorage)
The upper limit to which Amazon RDS can automatically scale the storage of the DB instance.
For more information about this setting, including limitations that apply to it, see Managing capacity automatically with Amazon RDS storage autoscaling in the Amazon RDS User Guide.
maxAllocatedStorage - The upper limit to which Amazon RDS can automatically scale the storage of the DB instance.
For more information about this setting, including limitations that apply to it, see Managing capacity automatically with Amazon RDS storage autoscaling in the Amazon RDS User Guide.
CreateDbInstanceRequest.Builder enableCustomerOwnedIp(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.
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.
CreateDbInstanceRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
overrideConfiguration in interface AwsRequest.BuilderCreateDbInstanceRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
overrideConfiguration in interface AwsRequest.BuilderCopyright © 2021. All rights reserved.