Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.RDS.CreateDBInstance

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates a new DB instance.

The new DB instance can be an RDS DB instance, or it can be a DB instance in an Aurora DB cluster. For an Aurora DB cluster, you can call this operation multiple times to add more than one DB instance to the cluster.

For more information about creating an RDS DB instance, see Creating an Amazon RDS DB instance in the Amazon RDS User Guide.

For more information about creating a DB instance in an Aurora DB cluster, see Creating an Amazon Aurora DB cluster in the Amazon Aurora User Guide.

Synopsis

data CreateDBInstance = CreateDBInstance' {
- allocatedStorage :: Maybe Int
- autoMinorVersionUpgrade :: Maybe Bool
- availabilityZone :: Maybe Text
- backupRetentionPeriod :: Maybe Int
- backupTarget :: Maybe Text
- cACertificateIdentifier :: Maybe Text
- characterSetName :: Maybe Text
- copyTagsToSnapshot :: Maybe Bool
- customIamInstanceProfile :: Maybe Text
- dbClusterIdentifier :: Maybe Text
- dbName :: Maybe Text
- dbParameterGroupName :: Maybe Text
- dbSecurityGroups :: Maybe [Text]
- dbSubnetGroupName :: Maybe Text
- deletionProtection :: Maybe Bool
- domain :: Maybe Text
- domainIAMRoleName :: Maybe Text
- enableCloudwatchLogsExports :: Maybe [Text]
- enableCustomerOwnedIp :: Maybe Bool
- enableIAMDatabaseAuthentication :: Maybe Bool
- enablePerformanceInsights :: Maybe Bool
- engineVersion :: Maybe Text
- iops :: Maybe Int
- kmsKeyId :: Maybe Text
- licenseModel :: Maybe Text
- manageMasterUserPassword :: Maybe Bool
- masterUserPassword :: Maybe Text
- masterUserSecretKmsKeyId :: Maybe Text
- masterUsername :: Maybe Text
- maxAllocatedStorage :: Maybe Int
- monitoringInterval :: Maybe Int
- monitoringRoleArn :: Maybe Text
- multiAZ :: Maybe Bool
- ncharCharacterSetName :: Maybe Text
- networkType :: Maybe Text
- optionGroupName :: Maybe Text
- performanceInsightsKMSKeyId :: Maybe Text
- performanceInsightsRetentionPeriod :: Maybe Int
- port :: Maybe Int
- preferredBackupWindow :: Maybe Text
- preferredMaintenanceWindow :: Maybe Text
- processorFeatures :: Maybe [ProcessorFeature]
- promotionTier :: Maybe Int
- publiclyAccessible :: Maybe Bool
- storageEncrypted :: Maybe Bool
- storageThroughput :: Maybe Int
- storageType :: Maybe Text
- tags :: Maybe [Tag]
- tdeCredentialArn :: Maybe Text
- tdeCredentialPassword :: Maybe Text
- timezone :: Maybe Text
- vpcSecurityGroupIds :: Maybe [Text]
- dbInstanceIdentifier :: Text
- dbInstanceClass :: Text
- engine :: Text
}
newCreateDBInstance :: Text -> Text -> Text -> CreateDBInstance
createDBInstance_allocatedStorage :: Lens' CreateDBInstance (Maybe Int)
createDBInstance_autoMinorVersionUpgrade :: Lens' CreateDBInstance (Maybe Bool)
createDBInstance_availabilityZone :: Lens' CreateDBInstance (Maybe Text)
createDBInstance_backupRetentionPeriod :: Lens' CreateDBInstance (Maybe Int)
createDBInstance_backupTarget :: Lens' CreateDBInstance (Maybe Text)
createDBInstance_cACertificateIdentifier :: Lens' CreateDBInstance (Maybe Text)
createDBInstance_characterSetName :: Lens' CreateDBInstance (Maybe Text)
createDBInstance_copyTagsToSnapshot :: Lens' CreateDBInstance (Maybe Bool)
createDBInstance_customIamInstanceProfile :: Lens' CreateDBInstance (Maybe Text)
createDBInstance_dbClusterIdentifier :: Lens' CreateDBInstance (Maybe Text)
createDBInstance_dbName :: Lens' CreateDBInstance (Maybe Text)
createDBInstance_dbParameterGroupName :: Lens' CreateDBInstance (Maybe Text)
createDBInstance_dbSecurityGroups :: Lens' CreateDBInstance (Maybe [Text])
createDBInstance_dbSubnetGroupName :: Lens' CreateDBInstance (Maybe Text)
createDBInstance_deletionProtection :: Lens' CreateDBInstance (Maybe Bool)
createDBInstance_domain :: Lens' CreateDBInstance (Maybe Text)
createDBInstance_domainIAMRoleName :: Lens' CreateDBInstance (Maybe Text)
createDBInstance_enableCloudwatchLogsExports :: Lens' CreateDBInstance (Maybe [Text])
createDBInstance_enableCustomerOwnedIp :: Lens' CreateDBInstance (Maybe Bool)
createDBInstance_enableIAMDatabaseAuthentication :: Lens' CreateDBInstance (Maybe Bool)
createDBInstance_enablePerformanceInsights :: Lens' CreateDBInstance (Maybe Bool)
createDBInstance_engineVersion :: Lens' CreateDBInstance (Maybe Text)
createDBInstance_iops :: Lens' CreateDBInstance (Maybe Int)
createDBInstance_kmsKeyId :: Lens' CreateDBInstance (Maybe Text)
createDBInstance_licenseModel :: Lens' CreateDBInstance (Maybe Text)
createDBInstance_manageMasterUserPassword :: Lens' CreateDBInstance (Maybe Bool)
createDBInstance_masterUserPassword :: Lens' CreateDBInstance (Maybe Text)
createDBInstance_masterUserSecretKmsKeyId :: Lens' CreateDBInstance (Maybe Text)
createDBInstance_masterUsername :: Lens' CreateDBInstance (Maybe Text)
createDBInstance_maxAllocatedStorage :: Lens' CreateDBInstance (Maybe Int)
createDBInstance_monitoringInterval :: Lens' CreateDBInstance (Maybe Int)
createDBInstance_monitoringRoleArn :: Lens' CreateDBInstance (Maybe Text)
createDBInstance_multiAZ :: Lens' CreateDBInstance (Maybe Bool)
createDBInstance_ncharCharacterSetName :: Lens' CreateDBInstance (Maybe Text)
createDBInstance_networkType :: Lens' CreateDBInstance (Maybe Text)
createDBInstance_optionGroupName :: Lens' CreateDBInstance (Maybe Text)
createDBInstance_performanceInsightsKMSKeyId :: Lens' CreateDBInstance (Maybe Text)
createDBInstance_performanceInsightsRetentionPeriod :: Lens' CreateDBInstance (Maybe Int)
createDBInstance_port :: Lens' CreateDBInstance (Maybe Int)
createDBInstance_preferredBackupWindow :: Lens' CreateDBInstance (Maybe Text)
createDBInstance_preferredMaintenanceWindow :: Lens' CreateDBInstance (Maybe Text)
createDBInstance_processorFeatures :: Lens' CreateDBInstance (Maybe [ProcessorFeature])
createDBInstance_promotionTier :: Lens' CreateDBInstance (Maybe Int)
createDBInstance_publiclyAccessible :: Lens' CreateDBInstance (Maybe Bool)
createDBInstance_storageEncrypted :: Lens' CreateDBInstance (Maybe Bool)
createDBInstance_storageThroughput :: Lens' CreateDBInstance (Maybe Int)
createDBInstance_storageType :: Lens' CreateDBInstance (Maybe Text)
createDBInstance_tags :: Lens' CreateDBInstance (Maybe [Tag])
createDBInstance_tdeCredentialArn :: Lens' CreateDBInstance (Maybe Text)
createDBInstance_tdeCredentialPassword :: Lens' CreateDBInstance (Maybe Text)
createDBInstance_timezone :: Lens' CreateDBInstance (Maybe Text)
createDBInstance_vpcSecurityGroupIds :: Lens' CreateDBInstance (Maybe [Text])
createDBInstance_dbInstanceIdentifier :: Lens' CreateDBInstance Text
createDBInstance_dbInstanceClass :: Lens' CreateDBInstance Text
createDBInstance_engine :: Lens' CreateDBInstance Text
data CreateDBInstanceResponse = CreateDBInstanceResponse' {
- dbInstance :: Maybe DBInstance
- httpStatus :: Int
}
newCreateDBInstanceResponse :: Int -> CreateDBInstanceResponse
createDBInstanceResponse_dbInstance :: Lens' CreateDBInstanceResponse (Maybe DBInstance)
createDBInstanceResponse_httpStatus :: Lens' CreateDBInstanceResponse Int

Creating a Request

data CreateDBInstance Source #

See: newCreateDBInstance smart constructor.

Constructors

CreateDBInstance'

Fields

allocatedStorage :: Maybe Int
The amount of storage in gibibytes (GiB) 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.
Amazon RDS Custom
Constraints to the amount of storage for each storage type are the following:
- General Purpose (SSD) storage (gp2, gp3): Must be an integer from 40 to 65536 for RDS Custom for Oracle, 16384 for RDS Custom for SQL Server.
- Provisioned IOPS storage (io1): Must be an integer from 40 to 65536 for RDS Custom for Oracle, 16384 for RDS Custom for SQL Server.
MySQL
Constraints to the amount of storage for each storage type are the following:
- General Purpose (SSD) storage (gp2, gp3): 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, gp3): 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, gp3): 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, gp3): 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, gp3):
  - Enterprise and Standard editions: Must be an integer from 20 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 100 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 20 to 1024.
  - Web and Express editions: Must be an integer from 20 to 1024.
autoMinorVersionUpgrade :: Maybe Bool
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.
If you create an RDS Custom DB instance, you must set AutoMinorVersionUpgrade to false.
availabilityZone :: Maybe Text
The Availability Zone (AZ) where the database will be created. For information on Amazon Web Services Regions and Availability Zones, see Regions and Availability Zones.
Amazon Aurora
Each Aurora DB cluster hosts copies of its storage in three separate Availability Zones. Specify one of these Availability Zones. Aurora automatically chooses an appropriate Availability Zone if you don't specify one.
Default: A random, system-chosen Availability Zone in the endpoint's Amazon Web Services 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 Amazon Web Services Region as the current endpoint.
backupRetentionPeriod :: Maybe Int
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
- Can't be set to 0 for an RDS Custom for Oracle DB instance
backupTarget :: Maybe Text
Specifies where automated backups and manual snapshots are stored.
Possible values are outposts (Amazon Web Services Outposts) and region (Amazon Web Services Region). The default is region.
For more information, see Working with Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.
cACertificateIdentifier :: Maybe Text
Specifies the CA certificate identifier to use for the DB instance’s server certificate.
This setting doesn't apply to RDS Custom.
For more information, see Using SSL/TLS to encrypt a connection to a DB instance in the Amazon RDS User Guide and Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora User Guide.
characterSetName :: Maybe Text
For supported engines, this value indicates that the DB instance should be associated with the specified CharacterSet.
This setting doesn't apply to RDS Custom. However, if you need to change the character set, you can change it on the database itself.
Amazon Aurora
Not applicable. The character set is managed by the DB cluster. For more information, see CreateDBCluster.
copyTagsToSnapshot :: Maybe Bool
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.
customIamInstanceProfile :: Maybe Text
The instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance. The instance profile must meet the following requirements:
- The profile must exist in your account.
- The profile must have an IAM role that Amazon EC2 has permissions to assume.
- The instance profile name and the associated IAM role name must start with the prefix AWSRDSCustom.
For the list of permissions required for the IAM role, see Configure IAM and your VPC in the Amazon RDS User Guide.
This setting is required for RDS Custom.
dbClusterIdentifier :: Maybe Text
The identifier of the DB cluster that the instance will belong to.
This setting doesn't apply to RDS Custom.
dbName :: Maybe Text
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
Amazon RDS Custom for Oracle
The Oracle System ID (SID) of the created RDS Custom DB instance. If you don't specify a value, the default value is ORCL.
Default: ORCL
Constraints:
- It must contain 1 to 8 alphanumeric characters.
- It must contain a letter.
- It can't be a word reserved by the database engine.
Amazon RDS Custom for SQL Server
Not applicable. Must be null.
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. Subsequent characters can be letters, underscores, or digits (0 to 9).
- It can't be a word reserved by the database engine.
dbParameterGroupName :: Maybe Text
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.
This setting doesn't apply to RDS Custom.
Constraints:
- It must be 1 to 255 letters, numbers, or hyphens.
- The first character must be a letter.
- It can't end with a hyphen or contain two consecutive hyphens.
dbSecurityGroups :: Maybe [Text]
A list of DB security groups to associate with this DB instance.
This setting applies to the legacy EC2-Classic platform, which is no longer used to create new DB instances. Use the VpcSecurityGroupIds setting instead.
dbSubnetGroupName :: Maybe Text
A DB subnet group to associate with this DB instance.
Constraints: Must match the name of an existing DBSubnetGroup. Must not be default.
Example: mydbsubnetgroup
deletionProtection :: Maybe Bool
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 isn't enabled. 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.
domain :: Maybe Text
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.
This setting doesn't apply to RDS Custom.
Amazon Aurora
Not applicable. The domain is managed by the DB cluster.
domainIAMRoleName :: Maybe Text
Specify the name of the IAM role to be used when making API calls to the Directory Service.
This setting doesn't apply to RDS Custom.
Amazon Aurora
Not applicable. The domain is managed by the DB cluster.
enableCloudwatchLogsExports :: Maybe [Text]
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. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.
Amazon Aurora
Not applicable. CloudWatch Logs exports are managed by the DB cluster.
RDS Custom
Not applicable.
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.
enableCustomerOwnedIp :: Maybe Bool
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 Amazon Web Services Outposts in the Amazon RDS User Guide.
For more information about CoIPs, see Customer-owned IP addresses in the Amazon Web Services Outposts User Guide.
enableIAMDatabaseAuthentication :: Maybe Bool
A value that indicates whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts. By default, mapping isn't enabled.
For more information, see IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.
This setting doesn't apply to RDS Custom.
Amazon Aurora
Not applicable. Mapping Amazon Web Services IAM accounts to database accounts is managed by the DB cluster.
enablePerformanceInsights :: Maybe Bool
A value that indicates whether to enable Performance Insights for the DB instance. For more information, see Using Amazon Performance Insights in the Amazon RDS User Guide.
This setting doesn't apply to RDS Custom.
engineVersion :: Maybe Text
The version number of the database engine to use.
For a list of valid engine versions, use the DescribeDBEngineVersions operation.
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 Amazon Web Services 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.
Amazon RDS Custom for Oracle
A custom engine version (CEV) that you have previously created. This setting is required for RDS Custom for Oracle. The CEV name has the following format: 19.customized_string. A valid CEV name is 19.my_cev1. For more information, see Creating an RDS Custom for Oracle DB instance in the Amazon RDS User Guide.
Amazon RDS Custom for SQL Server
See RDS Custom for SQL Server general requirements in the Amazon RDS User Guide.
MariaDB
For information, see MariaDB on Amazon RDS Versions in the Amazon RDS User Guide.
Microsoft SQL Server
For information, see Microsoft SQL Server Versions on Amazon RDS in the Amazon RDS User Guide.
MySQL
For information, see MySQL on Amazon RDS Versions in the Amazon RDS User Guide.
Oracle
For information, see Oracle Database Engine Release Notes in the Amazon RDS User Guide.
PostgreSQL
For information, see Amazon RDS for PostgreSQL versions and extensions in the Amazon RDS User Guide.
iops :: Maybe Int
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 DB instance storage 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.
Amazon Aurora
Not applicable. Storage is managed by the DB cluster.
kmsKeyId :: Maybe Text
The Amazon Web Services KMS key identifier for an encrypted DB instance.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.
Amazon Aurora
Not applicable. The Amazon Web Services 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 KMS key. There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.
Amazon RDS Custom
A KMS key is required for RDS Custom instances. For most RDS engines, if you leave this parameter empty while enabling StorageEncrypted, the engine uses the default KMS key. However, RDS Custom doesn't use the default key when this parameter is empty. You must explicitly specify a key.
licenseModel :: Maybe Text
License model information for this DB instance.
Valid values: license-included | bring-your-own-license | general-public-license
This setting doesn't apply to RDS Custom.
Amazon Aurora
Not applicable.
manageMasterUserPassword :: Maybe Bool
A value that indicates whether to manage the master user password with Amazon Web Services Secrets Manager.
For more information, see Password management with Amazon Web Services Secrets Manager in the Amazon RDS User Guide.
Constraints:
- Can't manage the master user password with Amazon Web Services Secrets Manager if MasterUserPassword is specified.
masterUserPassword :: Maybe Text
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.
Constraints: Can't be specified if ManageMasterUserPassword is turned on.
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.
masterUserSecretKmsKeyId :: Maybe Text
The Amazon Web Services KMS key identifier to encrypt a secret that is automatically generated and managed in Amazon Web Services Secrets Manager.
This setting is valid only if the master user password is managed by RDS in Amazon Web Services Secrets Manager for the DB instance.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.
If you don't specify MasterUserSecretKmsKeyId, then the aws/secretsmanager KMS key is used to encrypt the secret. If the secret is in a different Amazon Web Services account, then you can't use the aws/secretsmanager KMS key to encrypt the secret, and you must use a customer managed KMS key.
There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.
masterUsername :: Maybe Text
The name for the master user.
Amazon Aurora
Not applicable. The name for the master user is managed by the DB cluster.
Amazon RDS
Constraints:
- Required.
- Must be 1 to 16 letters, numbers, or underscores.
- First character must be a letter.
- Can't be a reserved word for the chosen database engine.
maxAllocatedStorage :: Maybe Int
The upper limit in gibibytes (GiB) 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.
This setting doesn't apply to RDS Custom.
Amazon Aurora
Not applicable. Storage is managed by the DB cluster.
monitoringInterval :: Maybe Int
The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collection of Enhanced Monitoring metrics, specify 0. The default is 0.
If MonitoringRoleArn is specified, then you must set MonitoringInterval to a value other than 0.
This setting doesn't apply to RDS Custom.
Valid Values: 0, 1, 5, 10, 15, 30, 60
monitoringRoleArn :: Maybe Text
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, see 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.
This setting doesn't apply to RDS Custom.
multiAZ :: Maybe Bool
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.
This setting doesn't apply to RDS Custom.
Amazon Aurora
Not applicable. DB instance Availability Zones (AZs) are managed by the DB cluster.
ncharCharacterSetName :: Maybe Text
The name of the NCHAR character set for the Oracle DB instance.
This parameter doesn't apply to RDS Custom.
networkType :: Maybe Text
The network type of the DB instance.
Valid values:
- ```
IPV4
```
- ```
DUAL
```
The network type is determined by the DBSubnetGroup specified for the DB instance. A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (DUAL).
For more information, see Working with a DB instance in a VPC in the Amazon RDS User Guide.
optionGroupName :: Maybe Text
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 after it is associated with a DB instance.
This setting doesn't apply to RDS Custom.
Amazon Aurora
Not applicable.
performanceInsightsKMSKeyId :: Maybe Text
The Amazon Web Services KMS key identifier for encryption of Performance Insights data.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
If you do not specify a value for PerformanceInsightsKMSKeyId, then Amazon RDS uses your default KMS key. There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.
This setting doesn't apply to RDS Custom.
performanceInsightsRetentionPeriod :: Maybe Int
The number of days to retain Performance Insights data. The default is 7 days. The following values are valid:
- 7
- month * 31, where month is a number of months from 1-23
- 731
For example, the following values are valid:
- 93 (3 months * 31)
- 341 (11 months * 31)
- 589 (19 months * 31)
- 731
If you specify a retention period such as 94, which isn't a valid value, RDS issues an error.
This setting doesn't apply to RDS Custom.
port :: Maybe Int
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
preferredBackupWindow :: Maybe Text
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 Amazon Web Services 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.
preferredMaintenanceWindow :: Maybe Text
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 Amazon Web Services Region, occurring on a random day of the week.
Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.
Constraints: Minimum 30-minute window.
processorFeatures :: Maybe [ProcessorFeature]
The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
This setting doesn't apply to RDS Custom.
Amazon Aurora
Not applicable.
promotionTier :: Maybe Int
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.
This setting doesn't apply to RDS Custom.
Default: 1
Valid Values: 0 - 15
publiclyAccessible :: Maybe Bool
A value that indicates whether the DB instance is publicly accessible.
When the DB instance is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB instance's virtual private cloud (VPC). It resolves 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. 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.
storageEncrypted :: Maybe Bool
A value that indicates whether the DB instance is encrypted. By default, it isn't encrypted.
For RDS Custom instances, either set this parameter to true or leave it unset. If you set this parameter to false, RDS reports an error.
Amazon Aurora
Not applicable. The encryption for DB instances is managed by the DB cluster.
storageThroughput :: Maybe Int
Specifies the storage throughput value for the DB instance.
This setting applies only to the gp3 storage type.
This setting doesn't apply to RDS Custom or Amazon Aurora.
storageType :: Maybe Text
Specifies the storage type to be associated with the DB instance.
Valid values: gp2 | gp3 | io1 | standard
If you specify io1 or gp3, you must also include a value for the Iops parameter.
Default: io1 if the Iops parameter is specified, otherwise gp2
Amazon Aurora
Not applicable. Storage is managed by the DB cluster.
tags :: Maybe [Tag]
Tags to assign to the DB instance.
tdeCredentialArn :: Maybe Text
The ARN from the key store with which to associate the instance for TDE encryption.
This setting doesn't apply to RDS Custom.
Amazon Aurora
Not applicable.
tdeCredentialPassword :: Maybe Text
The password for the given ARN from the key store in order to access the device.
This setting doesn't apply to RDS Custom.
timezone :: Maybe Text
The time zone of the DB instance. The time zone parameter is currently supported only by Microsoft SQL Server.
vpcSecurityGroupIds :: Maybe [Text]
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.
dbInstanceIdentifier :: Text
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
dbInstanceClass :: Text
The compute and memory capacity of the DB instance, for example db.m5.large. Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines. For the full list of DB instance classes, and availability for your engine, see DB instance classes in the Amazon RDS User Guide or Aurora DB instance classes in the Amazon Aurora User Guide.

engine :: Text

The name of the database engine to be used for this instance.

Not every database engine is available for every Amazon Web Services Region.

Valid Values:

aurora (for MySQL 5.6-compatible Aurora)
aurora-mysql (for MySQL 5.7-compatible and MySQL 8.0-compatible Aurora)
```
aurora-postgresql
```

custom-oracle-ee (for RDS Custom for Oracle instances)

custom-sqlserver-ee (for RDS Custom for SQL Server instances)

custom-sqlserver-se (for RDS Custom for SQL Server instances)

custom-sqlserver-web (for RDS Custom for SQL Server instances)

```
mariadb
```
```
mysql
```
```
oracle-ee
```
```
oracle-ee-cdb
```
```
oracle-se2
```
```
oracle-se2-cdb
```
```
postgres
```
```
sqlserver-ee
```
```
sqlserver-se
```
```
sqlserver-ex
```
```
sqlserver-web
```

Instances

Instances details

ToHeaders CreateDBInstance Source #
Instance details Defined in Amazonka.RDS.CreateDBInstance Methods toHeaders :: CreateDBInstance -> [Header] #
ToPath CreateDBInstance Source #
Instance details Defined in Amazonka.RDS.CreateDBInstance Methods toPath :: CreateDBInstance -> ByteString #
ToQuery CreateDBInstance Source #
Instance details Defined in Amazonka.RDS.CreateDBInstance Methods toQuery :: CreateDBInstance -> QueryString #
AWSRequest CreateDBInstance Source #
Instance details Defined in Amazonka.RDS.CreateDBInstance Associated Types type AWSResponse CreateDBInstance # Methods request :: (Service -> Service) -> CreateDBInstance -> Request CreateDBInstance # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy CreateDBInstance -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateDBInstance))) #
Generic CreateDBInstance Source #
Instance details Defined in Amazonka.RDS.CreateDBInstance Associated Types type Rep CreateDBInstance :: Type -> Type # Methods from :: CreateDBInstance -> Rep CreateDBInstance x # to :: Rep CreateDBInstance x -> CreateDBInstance #
Read CreateDBInstance Source #
Instance details Defined in Amazonka.RDS.CreateDBInstance Methods readsPrec :: Int -> ReadS CreateDBInstance # readList :: ReadS [CreateDBInstance] # readPrec :: ReadPrec CreateDBInstance # readListPrec :: ReadPrec [CreateDBInstance] #
Show CreateDBInstance Source #
Instance details Defined in Amazonka.RDS.CreateDBInstance Methods showsPrec :: Int -> CreateDBInstance -> ShowS # show :: CreateDBInstance -> String # showList :: [CreateDBInstance] -> ShowS #
NFData CreateDBInstance Source #
Instance details Defined in Amazonka.RDS.CreateDBInstance Methods rnf :: CreateDBInstance -> () #
Eq CreateDBInstance Source #
Instance details Defined in Amazonka.RDS.CreateDBInstance Methods (==) :: CreateDBInstance -> CreateDBInstance -> Bool # (/=) :: CreateDBInstance -> CreateDBInstance -> Bool #
Hashable CreateDBInstance Source #
Instance details Defined in Amazonka.RDS.CreateDBInstance Methods hashWithSalt :: Int -> CreateDBInstance -> Int # hash :: CreateDBInstance -> Int #
type AWSResponse CreateDBInstance Source #
Instance details Defined in Amazonka.RDS.CreateDBInstance type AWSResponse CreateDBInstance = CreateDBInstanceResponse
type Rep CreateDBInstance Source #
Instance details Defined in Amazonka.RDS.CreateDBInstance type Rep CreateDBInstance = D1 ('MetaData "CreateDBInstance" "Amazonka.RDS.CreateDBInstance" "amazonka-rds-2.0-3xXyiLHmAvvCXXUIx1uhpP" 'False) (C1 ('MetaCons "CreateDBInstance'" 'PrefixI 'True) (((((S1 ('MetaSel ('Just "allocatedStorage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :: (S1 ('MetaSel ('Just "autoMinorVersionUpgrade") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "availabilityZone") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: (S1 ('MetaSel ('Just "backupRetentionPeriod") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :: (S1 ('MetaSel ('Just "backupTarget") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "cACertificateIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :: ((S1 ('MetaSel ('Just "characterSetName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "copyTagsToSnapshot") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "customIamInstanceProfile") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "dbClusterIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "dbName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "dbParameterGroupName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "dbSecurityGroups") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])))))) :: (((S1 ('MetaSel ('Just "dbSubnetGroupName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "deletionProtection") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "domain") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "domainIAMRoleName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "enableCloudwatchLogsExports") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text]))) :: (S1 ('MetaSel ('Just "enableCustomerOwnedIp") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "enableIAMDatabaseAuthentication") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))))) :: ((S1 ('MetaSel ('Just "enablePerformanceInsights") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: (S1 ('MetaSel ('Just "engineVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "iops") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)))) :: ((S1 ('MetaSel ('Just "kmsKeyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "licenseModel") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "manageMasterUserPassword") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "masterUserPassword") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))))) :: ((((S1 ('MetaSel ('Just "masterUserSecretKmsKeyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "masterUsername") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "maxAllocatedStorage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)))) :: ((S1 ('MetaSel ('Just "monitoringInterval") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :: S1 ('MetaSel ('Just "monitoringRoleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "multiAZ") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "ncharCharacterSetName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :: ((S1 ('MetaSel ('Just "networkType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "optionGroupName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "performanceInsightsKMSKeyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "performanceInsightsRetentionPeriod") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :: S1 ('MetaSel ('Just "port") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int))) :: (S1 ('MetaSel ('Just "preferredBackupWindow") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "preferredMaintenanceWindow") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))) :: (((S1 ('MetaSel ('Just "processorFeatures") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ProcessorFeature])) :: (S1 ('MetaSel ('Just "promotionTier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :: S1 ('MetaSel ('Just "publiclyAccessible") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)))) :: ((S1 ('MetaSel ('Just "storageEncrypted") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "storageThroughput") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int))) :: (S1 ('MetaSel ('Just "storageType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Tag]))))) :: ((S1 ('MetaSel ('Just "tdeCredentialArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "tdeCredentialPassword") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "timezone") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "vpcSecurityGroupIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :: S1 ('MetaSel ('Just "dbInstanceIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :: (S1 ('MetaSel ('Just "dbInstanceClass") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "engine") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))))))

newCreateDBInstance Source #

Arguments

:: Text	`CreateDBInstance`
-> Text	`CreateDBInstance`
-> Text	`CreateDBInstance`
-> CreateDBInstance

Create a value of CreateDBInstance with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

CreateDBInstance, createDBInstance_allocatedStorage - The amount of storage in gibibytes (GiB) 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.

Amazon RDS Custom

Constraints to the amount of storage for each storage type are the following:

General Purpose (SSD) storage (gp2, gp3): Must be an integer from 40 to 65536 for RDS Custom for Oracle, 16384 for RDS Custom for SQL Server.
Provisioned IOPS storage (io1): Must be an integer from 40 to 65536 for RDS Custom for Oracle, 16384 for RDS Custom for SQL Server.

MySQL

Constraints to the amount of storage for each storage type are the following:

General Purpose (SSD) storage (gp2, gp3): 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, gp3): 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, gp3): 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, gp3): 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, gp3):
- Enterprise and Standard editions: Must be an integer from 20 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 100 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 20 to 1024.
- Web and Express editions: Must be an integer from 20 to 1024.

CreateDBInstance, createDBInstance_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.

If you create an RDS Custom DB instance, you must set AutoMinorVersionUpgrade to false.

CreateDBInstance, createDBInstance_availabilityZone - The Availability Zone (AZ) where the database will be created. For information on Amazon Web Services Regions and Availability Zones, see Regions and Availability Zones.

Amazon Aurora

Each Aurora DB cluster hosts copies of its storage in three separate Availability Zones. Specify one of these Availability Zones. Aurora automatically chooses an appropriate Availability Zone if you don't specify one.

Default: A random, system-chosen Availability Zone in the endpoint's Amazon Web Services 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 Amazon Web Services Region as the current endpoint.

CreateDBInstance, createDBInstance_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
Can't be set to 0 for an RDS Custom for Oracle DB instance

CreateDBInstance, createDBInstance_backupTarget - Specifies where automated backups and manual snapshots are stored.

Possible values are outposts (Amazon Web Services Outposts) and region (Amazon Web Services Region). The default is region.

For more information, see Working with Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.

CreateDBInstance, createDBInstance_cACertificateIdentifier - Specifies the CA certificate identifier to use for the DB instance’s server certificate.

This setting doesn't apply to RDS Custom.

For more information, see Using SSL/TLS to encrypt a connection to a DB instance in the Amazon RDS User Guide and Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora User Guide.

CreateDBInstance, createDBInstance_characterSetName - For supported engines, this value indicates that the DB instance should be associated with the specified CharacterSet.

This setting doesn't apply to RDS Custom. However, if you need to change the character set, you can change it on the database itself.

Amazon Aurora

Not applicable. The character set is managed by the DB cluster. For more information, see CreateDBCluster.

CreateDBInstance, createDBInstance_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.

CreateDBInstance, createDBInstance_customIamInstanceProfile - The instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance. The instance profile must meet the following requirements:

The profile must exist in your account.
The profile must have an IAM role that Amazon EC2 has permissions to assume.
The instance profile name and the associated IAM role name must start with the prefix AWSRDSCustom.

For the list of permissions required for the IAM role, see Configure IAM and your VPC in the Amazon RDS User Guide.

This setting is required for RDS Custom.

CreateDBInstance, createDBInstance_dbClusterIdentifier - The identifier of the DB cluster that the instance will belong to.

This setting doesn't apply to RDS Custom.

CreateDBInstance, createDBInstance_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

Amazon RDS Custom for Oracle

The Oracle System ID (SID) of the created RDS Custom DB instance. If you don't specify a value, the default value is ORCL.

Default: ORCL

Constraints:

It must contain 1 to 8 alphanumeric characters.
It must contain a letter.
It can't be a word reserved by the database engine.

Amazon RDS Custom for SQL Server

Not applicable. Must be null.

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. Subsequent characters can be letters, underscores, or digits (0 to 9).
It can't be a word reserved by the database engine.

CreateDBInstance, createDBInstance_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.

This setting doesn't apply to RDS Custom.

Constraints:

It must be 1 to 255 letters, numbers, or hyphens.
The first character must be a letter.
It can't end with a hyphen or contain two consecutive hyphens.

CreateDBInstance, createDBInstance_dbSecurityGroups - A list of DB security groups to associate with this DB instance.

This setting applies to the legacy EC2-Classic platform, which is no longer used to create new DB instances. Use the VpcSecurityGroupIds setting instead.

CreateDBInstance, createDBInstance_dbSubnetGroupName - A DB subnet group to associate with this DB instance.

Constraints: Must match the name of an existing DBSubnetGroup. Must not be default.

Example: mydbsubnetgroup

CreateDBInstance, createDBInstance_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 isn't enabled. 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.

CreateDBInstance, createDBInstance_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.

This setting doesn't apply to RDS Custom.

Amazon Aurora

Not applicable. The domain is managed by the DB cluster.

$sel:domainIAMRoleName:CreateDBInstance', createDBInstance_domainIAMRoleName - Specify the name of the IAM role to be used when making API calls to the Directory Service.

This setting doesn't apply to RDS Custom.

Amazon Aurora

Not applicable. The domain is managed by the DB cluster.

$sel:enableCloudwatchLogsExports:CreateDBInstance', createDBInstance_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. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.

Amazon Aurora

Not applicable. CloudWatch Logs exports are managed by the DB cluster.

RDS Custom

Not applicable.

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.

$sel:enableCustomerOwnedIp:CreateDBInstance', createDBInstance_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 Amazon Web Services Outposts in the Amazon RDS User Guide.

For more information about CoIPs, see Customer-owned IP addresses in the Amazon Web Services Outposts User Guide.

$sel:enableIAMDatabaseAuthentication:CreateDBInstance', createDBInstance_enableIAMDatabaseAuthentication - A value that indicates whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts. By default, mapping isn't enabled.

For more information, see IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.

This setting doesn't apply to RDS Custom.

Amazon Aurora

Not applicable. Mapping Amazon Web Services IAM accounts to database accounts is managed by the DB cluster.

$sel:enablePerformanceInsights:CreateDBInstance', createDBInstance_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 RDS User Guide.

This setting doesn't apply to RDS Custom.

CreateDBInstance, createDBInstance_engineVersion - The version number of the database engine to use.

For a list of valid engine versions, use the DescribeDBEngineVersions operation.

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 Amazon Web Services 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.

Amazon RDS Custom for Oracle

A custom engine version (CEV) that you have previously created. This setting is required for RDS Custom for Oracle. The CEV name has the following format: 19.customized_string. A valid CEV name is 19.my_cev1. For more information, see Creating an RDS Custom for Oracle DB instance in the Amazon RDS User Guide.

Amazon RDS Custom for SQL Server

See RDS Custom for SQL Server general requirements in the Amazon RDS User Guide.

MariaDB

For information, see MariaDB on Amazon RDS Versions in the Amazon RDS User Guide.

Microsoft SQL Server

For information, see Microsoft SQL Server Versions on Amazon RDS in the Amazon RDS User Guide.

MySQL

For information, see MySQL on Amazon RDS Versions in the Amazon RDS User Guide.

Oracle

For information, see Oracle Database Engine Release Notes in the Amazon RDS User Guide.

PostgreSQL

For information, see Amazon RDS for PostgreSQL versions and extensions in the Amazon RDS User Guide.

CreateDBInstance, createDBInstance_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 DB instance storage 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.

Amazon Aurora

Not applicable. Storage is managed by the DB cluster.

CreateDBInstance, createDBInstance_kmsKeyId - The Amazon Web Services KMS key identifier for an encrypted DB instance.

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.

Amazon Aurora

Not applicable. The Amazon Web Services 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 KMS key. There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.

Amazon RDS Custom

A KMS key is required for RDS Custom instances. For most RDS engines, if you leave this parameter empty while enabling StorageEncrypted, the engine uses the default KMS key. However, RDS Custom doesn't use the default key when this parameter is empty. You must explicitly specify a key.

CreateDBInstance, createDBInstance_licenseModel - License model information for this DB instance.

Valid values: license-included | bring-your-own-license | general-public-license

This setting doesn't apply to RDS Custom.

Amazon Aurora

Not applicable.

$sel:manageMasterUserPassword:CreateDBInstance', createDBInstance_manageMasterUserPassword - A value that indicates whether to manage the master user password with Amazon Web Services Secrets Manager.

For more information, see Password management with Amazon Web Services Secrets Manager in the Amazon RDS User Guide.

Constraints:

Can't manage the master user password with Amazon Web Services Secrets Manager if MasterUserPassword is specified.

CreateDBInstance, createDBInstance_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.

Constraints: Can't be specified if ManageMasterUserPassword is turned on.

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.

$sel:masterUserSecretKmsKeyId:CreateDBInstance', createDBInstance_masterUserSecretKmsKeyId - The Amazon Web Services KMS key identifier to encrypt a secret that is automatically generated and managed in Amazon Web Services Secrets Manager.

This setting is valid only if the master user password is managed by RDS in Amazon Web Services Secrets Manager for the DB instance.

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.

If you don't specify MasterUserSecretKmsKeyId, then the aws/secretsmanager KMS key is used to encrypt the secret. If the secret is in a different Amazon Web Services account, then you can't use the aws/secretsmanager KMS key to encrypt the secret, and you must use a customer managed KMS key.

There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.

CreateDBInstance, createDBInstance_masterUsername - The name for the master user.

Amazon Aurora

Not applicable. The name for the master user is managed by the DB cluster.

Amazon RDS

Constraints:

Required.
Must be 1 to 16 letters, numbers, or underscores.
First character must be a letter.
Can't be a reserved word for the chosen database engine.

CreateDBInstance, createDBInstance_maxAllocatedStorage - The upper limit in gibibytes (GiB) 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.

This setting doesn't apply to RDS Custom.

Amazon Aurora

Not applicable. Storage is managed by the DB cluster.

CreateDBInstance, createDBInstance_monitoringInterval - The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collection of Enhanced Monitoring metrics, specify 0. The default is 0.

If MonitoringRoleArn is specified, then you must set MonitoringInterval to a value other than 0.

This setting doesn't apply to RDS Custom.

Valid Values: 0, 1, 5, 10, 15, 30, 60

CreateDBInstance, createDBInstance_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, see 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.

This setting doesn't apply to RDS Custom.

CreateDBInstance, createDBInstance_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.

This setting doesn't apply to RDS Custom.

Amazon Aurora

Not applicable. DB instance Availability Zones (AZs) are managed by the DB cluster.

CreateDBInstance, createDBInstance_ncharCharacterSetName - The name of the NCHAR character set for the Oracle DB instance.

This parameter doesn't apply to RDS Custom.

CreateDBInstance, createDBInstance_networkType - The network type of the DB instance.

Valid values:

```
IPV4
```
```
DUAL
```

The network type is determined by the DBSubnetGroup specified for the DB instance. A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (DUAL).

For more information, see Working with a DB instance in a VPC in the Amazon RDS User Guide.

CreateDBInstance, createDBInstance_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 after it is associated with a DB instance.

This setting doesn't apply to RDS Custom.

Amazon Aurora

Not applicable.

CreateDBInstance, createDBInstance_performanceInsightsKMSKeyId - The Amazon Web Services KMS key identifier for encryption of Performance Insights data.

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

If you do not specify a value for PerformanceInsightsKMSKeyId, then Amazon RDS uses your default KMS key. There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.

This setting doesn't apply to RDS Custom.

CreateDBInstance, createDBInstance_performanceInsightsRetentionPeriod - The number of days to retain Performance Insights data. The default is 7 days. The following values are valid:

7
month * 31, where month is a number of months from 1-23
731

For example, the following values are valid:

93 (3 months * 31)
341 (11 months * 31)
589 (19 months * 31)
731

If you specify a retention period such as 94, which isn't a valid value, RDS issues an error.

This setting doesn't apply to RDS Custom.

CreateDBInstance, createDBInstance_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

CreateDBInstance, createDBInstance_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 Amazon Web Services 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.

CreateDBInstance, createDBInstance_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 Amazon Web Services Region, occurring on a random day of the week.

Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.

Constraints: Minimum 30-minute window.

CreateDBInstance, createDBInstance_processorFeatures - The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.

This setting doesn't apply to RDS Custom.

Amazon Aurora

Not applicable.

CreateDBInstance, createDBInstance_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.

This setting doesn't apply to RDS Custom.

Default: 1

Valid Values: 0 - 15

CreateDBInstance, createDBInstance_publiclyAccessible - A value that indicates whether the DB instance is publicly accessible.

When the DB instance is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB instance's virtual private cloud (VPC). It resolves 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. 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.

CreateDBInstance, createDBInstance_storageEncrypted - A value that indicates whether the DB instance is encrypted. By default, it isn't encrypted.

For RDS Custom instances, either set this parameter to true or leave it unset. If you set this parameter to false, RDS reports an error.

Amazon Aurora

Not applicable. The encryption for DB instances is managed by the DB cluster.

CreateDBInstance, createDBInstance_storageThroughput - Specifies the storage throughput value for the DB instance.

This setting applies only to the gp3 storage type.

This setting doesn't apply to RDS Custom or Amazon Aurora.

CreateDBInstance, createDBInstance_storageType - Specifies the storage type to be associated with the DB instance.

Valid values: gp2 | gp3 | io1 | standard

If you specify io1 or gp3, you must also include a value for the Iops parameter.

Default: io1 if the Iops parameter is specified, otherwise gp2

Amazon Aurora

Not applicable. Storage is managed by the DB cluster.

$sel:tags:CreateDBInstance', createDBInstance_tags - Tags to assign to the DB instance.

CreateDBInstance, createDBInstance_tdeCredentialArn - The ARN from the key store with which to associate the instance for TDE encryption.

This setting doesn't apply to RDS Custom.

Amazon Aurora

Not applicable.

$sel:tdeCredentialPassword:CreateDBInstance', createDBInstance_tdeCredentialPassword - The password for the given ARN from the key store in order to access the device.

This setting doesn't apply to RDS Custom.

CreateDBInstance, createDBInstance_timezone - The time zone of the DB instance. The time zone parameter is currently supported only by Microsoft SQL Server.

CreateDBInstance, createDBInstance_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.

CreateDBInstance, createDBInstance_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

CreateDBInstance, createDBInstance_dbInstanceClass - The compute and memory capacity of the DB instance, for example db.m5.large. Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines. For the full list of DB instance classes, and availability for your engine, see DB instance classes in the Amazon RDS User Guide or Aurora DB instance classes in the Amazon Aurora User Guide.

CreateDBInstance, createDBInstance_engine - The name of the database engine to be used for this instance.

Not every database engine is available for every Amazon Web Services Region.

Valid Values:

aurora (for MySQL 5.6-compatible Aurora)
aurora-mysql (for MySQL 5.7-compatible and MySQL 8.0-compatible Aurora)
```
aurora-postgresql
```

custom-oracle-ee (for RDS Custom for Oracle instances)

custom-sqlserver-ee (for RDS Custom for SQL Server instances)

custom-sqlserver-se (for RDS Custom for SQL Server instances)

custom-sqlserver-web (for RDS Custom for SQL Server instances)

```
mariadb
```
```
mysql
```
```
oracle-ee
```
```
oracle-ee-cdb
```
```
oracle-se2
```
```
oracle-se2-cdb
```
```
postgres
```
```
sqlserver-ee
```
```
sqlserver-se
```
```
sqlserver-ex
```
```
sqlserver-web
```

Request Lenses

createDBInstance_allocatedStorage :: Lens' CreateDBInstance (Maybe Int) Source #

The amount of storage in gibibytes (GiB) 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.

Amazon RDS Custom

Constraints to the amount of storage for each storage type are the following:

General Purpose (SSD) storage (gp2, gp3): Must be an integer from 40 to 65536 for RDS Custom for Oracle, 16384 for RDS Custom for SQL Server.
Provisioned IOPS storage (io1): Must be an integer from 40 to 65536 for RDS Custom for Oracle, 16384 for RDS Custom for SQL Server.

MySQL

Constraints to the amount of storage for each storage type are the following:

General Purpose (SSD) storage (gp2, gp3): 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, gp3): 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, gp3): 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, gp3): 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, gp3):
- Enterprise and Standard editions: Must be an integer from 20 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 100 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 20 to 1024.
- Web and Express editions: Must be an integer from 20 to 1024.

createDBInstance_autoMinorVersionUpgrade :: Lens' CreateDBInstance (Maybe Bool) Source #

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.

If you create an RDS Custom DB instance, you must set AutoMinorVersionUpgrade to false.

createDBInstance_availabilityZone :: Lens' CreateDBInstance (Maybe Text) Source #

The Availability Zone (AZ) where the database will be created. For information on Amazon Web Services Regions and Availability Zones, see Regions and Availability Zones.

Amazon Aurora

Each Aurora DB cluster hosts copies of its storage in three separate Availability Zones. Specify one of these Availability Zones. Aurora automatically chooses an appropriate Availability Zone if you don't specify one.

Default: A random, system-chosen Availability Zone in the endpoint's Amazon Web Services 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 Amazon Web Services Region as the current endpoint.

createDBInstance_backupRetentionPeriod :: Lens' CreateDBInstance (Maybe Int) Source #

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
Can't be set to 0 for an RDS Custom for Oracle DB instance

createDBInstance_backupTarget :: Lens' CreateDBInstance (Maybe Text) Source #

Specifies where automated backups and manual snapshots are stored.

Possible values are outposts (Amazon Web Services Outposts) and region (Amazon Web Services Region). The default is region.

For more information, see Working with Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.

createDBInstance_cACertificateIdentifier :: Lens' CreateDBInstance (Maybe Text) Source #

Specifies the CA certificate identifier to use for the DB instance’s server certificate.

This setting doesn't apply to RDS Custom.

For more information, see Using SSL/TLS to encrypt a connection to a DB instance in the Amazon RDS User Guide and Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora User Guide.

createDBInstance_characterSetName :: Lens' CreateDBInstance (Maybe Text) Source #

For supported engines, this value indicates that the DB instance should be associated with the specified CharacterSet.

This setting doesn't apply to RDS Custom. However, if you need to change the character set, you can change it on the database itself.

Amazon Aurora

Not applicable. The character set is managed by the DB cluster. For more information, see CreateDBCluster.

createDBInstance_copyTagsToSnapshot :: Lens' CreateDBInstance (Maybe Bool) Source #

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.

createDBInstance_customIamInstanceProfile :: Lens' CreateDBInstance (Maybe Text) Source #

The instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance. The instance profile must meet the following requirements:

The profile must exist in your account.
The profile must have an IAM role that Amazon EC2 has permissions to assume.
The instance profile name and the associated IAM role name must start with the prefix AWSRDSCustom.

For the list of permissions required for the IAM role, see Configure IAM and your VPC in the Amazon RDS User Guide.

This setting is required for RDS Custom.

createDBInstance_dbClusterIdentifier :: Lens' CreateDBInstance (Maybe Text) Source #

The identifier of the DB cluster that the instance will belong to.

This setting doesn't apply to RDS Custom.

createDBInstance_dbName :: Lens' CreateDBInstance (Maybe Text) Source #

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

Amazon RDS Custom for Oracle

The Oracle System ID (SID) of the created RDS Custom DB instance. If you don't specify a value, the default value is ORCL.

Default: ORCL

Constraints:

It must contain 1 to 8 alphanumeric characters.
It must contain a letter.
It can't be a word reserved by the database engine.

Amazon RDS Custom for SQL Server

Not applicable. Must be null.

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. Subsequent characters can be letters, underscores, or digits (0 to 9).
It can't be a word reserved by the database engine.

createDBInstance_dbParameterGroupName :: Lens' CreateDBInstance (Maybe Text) Source #

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.

This setting doesn't apply to RDS Custom.

Constraints:

It must be 1 to 255 letters, numbers, or hyphens.
The first character must be a letter.
It can't end with a hyphen or contain two consecutive hyphens.

createDBInstance_dbSecurityGroups :: Lens' CreateDBInstance (Maybe [Text]) Source #

A list of DB security groups to associate with this DB instance.

This setting applies to the legacy EC2-Classic platform, which is no longer used to create new DB instances. Use the VpcSecurityGroupIds setting instead.

createDBInstance_dbSubnetGroupName :: Lens' CreateDBInstance (Maybe Text) Source #

A DB subnet group to associate with this DB instance.

Constraints: Must match the name of an existing DBSubnetGroup. Must not be default.

Example: mydbsubnetgroup

createDBInstance_deletionProtection :: Lens' CreateDBInstance (Maybe Bool) Source #

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 isn't enabled. 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.

createDBInstance_domain :: Lens' CreateDBInstance (Maybe Text) Source #

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.

This setting doesn't apply to RDS Custom.

Amazon Aurora

Not applicable. The domain is managed by the DB cluster.

createDBInstance_domainIAMRoleName :: Lens' CreateDBInstance (Maybe Text) Source #

Specify the name of the IAM role to be used when making API calls to the Directory Service.

This setting doesn't apply to RDS Custom.

Amazon Aurora

Not applicable. The domain is managed by the DB cluster.

createDBInstance_enableCloudwatchLogsExports :: Lens' CreateDBInstance (Maybe [Text]) Source #

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. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.

Amazon Aurora

Not applicable. CloudWatch Logs exports are managed by the DB cluster.

RDS Custom

Not applicable.

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.

createDBInstance_enableCustomerOwnedIp :: Lens' CreateDBInstance (Maybe Bool) Source #

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 Amazon Web Services Outposts in the Amazon RDS User Guide.

For more information about CoIPs, see Customer-owned IP addresses in the Amazon Web Services Outposts User Guide.

createDBInstance_enableIAMDatabaseAuthentication :: Lens' CreateDBInstance (Maybe Bool) Source #

A value that indicates whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts. By default, mapping isn't enabled.

For more information, see IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.

This setting doesn't apply to RDS Custom.

Amazon Aurora

Not applicable. Mapping Amazon Web Services IAM accounts to database accounts is managed by the DB cluster.

createDBInstance_enablePerformanceInsights :: Lens' CreateDBInstance (Maybe Bool) Source #

A value that indicates whether to enable Performance Insights for the DB instance. For more information, see Using Amazon Performance Insights in the Amazon RDS User Guide.

This setting doesn't apply to RDS Custom.

createDBInstance_engineVersion :: Lens' CreateDBInstance (Maybe Text) Source #

The version number of the database engine to use.

For a list of valid engine versions, use the DescribeDBEngineVersions operation.

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 Amazon Web Services 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.

Amazon RDS Custom for Oracle

A custom engine version (CEV) that you have previously created. This setting is required for RDS Custom for Oracle. The CEV name has the following format: 19.customized_string. A valid CEV name is 19.my_cev1. For more information, see Creating an RDS Custom for Oracle DB instance in the Amazon RDS User Guide.

Amazon RDS Custom for SQL Server

See RDS Custom for SQL Server general requirements in the Amazon RDS User Guide.

MariaDB

For information, see MariaDB on Amazon RDS Versions in the Amazon RDS User Guide.

Microsoft SQL Server

For information, see Microsoft SQL Server Versions on Amazon RDS in the Amazon RDS User Guide.

MySQL

For information, see MySQL on Amazon RDS Versions in the Amazon RDS User Guide.

Oracle

For information, see Oracle Database Engine Release Notes in the Amazon RDS User Guide.

PostgreSQL

For information, see Amazon RDS for PostgreSQL versions and extensions in the Amazon RDS User Guide.

createDBInstance_iops :: Lens' CreateDBInstance (Maybe Int) Source #

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 DB instance storage 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.

Amazon Aurora

Not applicable. Storage is managed by the DB cluster.

createDBInstance_kmsKeyId :: Lens' CreateDBInstance (Maybe Text) Source #

The Amazon Web Services KMS key identifier for an encrypted DB instance.

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.

Amazon Aurora

Not applicable. The Amazon Web Services 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 KMS key. There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.

Amazon RDS Custom

A KMS key is required for RDS Custom instances. For most RDS engines, if you leave this parameter empty while enabling StorageEncrypted, the engine uses the default KMS key. However, RDS Custom doesn't use the default key when this parameter is empty. You must explicitly specify a key.

createDBInstance_licenseModel :: Lens' CreateDBInstance (Maybe Text) Source #

License model information for this DB instance.

Valid values: license-included | bring-your-own-license | general-public-license

This setting doesn't apply to RDS Custom.

Amazon Aurora

Not applicable.

createDBInstance_manageMasterUserPassword :: Lens' CreateDBInstance (Maybe Bool) Source #

A value that indicates whether to manage the master user password with Amazon Web Services Secrets Manager.

For more information, see Password management with Amazon Web Services Secrets Manager in the Amazon RDS User Guide.

Constraints:

Can't manage the master user password with Amazon Web Services Secrets Manager if MasterUserPassword is specified.

createDBInstance_masterUserPassword :: Lens' CreateDBInstance (Maybe Text) Source #

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.

Constraints: Can't be specified if ManageMasterUserPassword is turned on.

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.

createDBInstance_masterUserSecretKmsKeyId :: Lens' CreateDBInstance (Maybe Text) Source #

The Amazon Web Services KMS key identifier to encrypt a secret that is automatically generated and managed in Amazon Web Services Secrets Manager.

This setting is valid only if the master user password is managed by RDS in Amazon Web Services Secrets Manager for the DB instance.

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.

If you don't specify MasterUserSecretKmsKeyId, then the aws/secretsmanager KMS key is used to encrypt the secret. If the secret is in a different Amazon Web Services account, then you can't use the aws/secretsmanager KMS key to encrypt the secret, and you must use a customer managed KMS key.

There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.

createDBInstance_masterUsername :: Lens' CreateDBInstance (Maybe Text) Source #

The name for the master user.

Amazon Aurora

Not applicable. The name for the master user is managed by the DB cluster.

Amazon RDS

Constraints:

Required.
Must be 1 to 16 letters, numbers, or underscores.
First character must be a letter.
Can't be a reserved word for the chosen database engine.

createDBInstance_maxAllocatedStorage :: Lens' CreateDBInstance (Maybe Int) Source #

The upper limit in gibibytes (GiB) 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.

This setting doesn't apply to RDS Custom.

Amazon Aurora

Not applicable. Storage is managed by the DB cluster.

createDBInstance_monitoringInterval :: Lens' CreateDBInstance (Maybe Int) Source #

The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collection of Enhanced Monitoring metrics, specify 0. The default is 0.

If MonitoringRoleArn is specified, then you must set MonitoringInterval to a value other than 0.

This setting doesn't apply to RDS Custom.

Valid Values: 0, 1, 5, 10, 15, 30, 60

createDBInstance_monitoringRoleArn :: Lens' CreateDBInstance (Maybe Text) Source #

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, see 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.

This setting doesn't apply to RDS Custom.

createDBInstance_multiAZ :: Lens' CreateDBInstance (Maybe Bool) Source #

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.

This setting doesn't apply to RDS Custom.

Amazon Aurora

Not applicable. DB instance Availability Zones (AZs) are managed by the DB cluster.

createDBInstance_ncharCharacterSetName :: Lens' CreateDBInstance (Maybe Text) Source #

The name of the NCHAR character set for the Oracle DB instance.

This parameter doesn't apply to RDS Custom.

createDBInstance_networkType :: Lens' CreateDBInstance (Maybe Text) Source #

The network type of the DB instance.

Valid values:

```
IPV4
```
```
DUAL
```

The network type is determined by the DBSubnetGroup specified for the DB instance. A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (DUAL).

For more information, see Working with a DB instance in a VPC in the Amazon RDS User Guide.

createDBInstance_optionGroupName :: Lens' CreateDBInstance (Maybe Text) Source #

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 after it is associated with a DB instance.

This setting doesn't apply to RDS Custom.

Amazon Aurora

Not applicable.

createDBInstance_performanceInsightsKMSKeyId :: Lens' CreateDBInstance (Maybe Text) Source #

The Amazon Web Services KMS key identifier for encryption of Performance Insights data.

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

If you do not specify a value for PerformanceInsightsKMSKeyId, then Amazon RDS uses your default KMS key. There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.

This setting doesn't apply to RDS Custom.

createDBInstance_performanceInsightsRetentionPeriod :: Lens' CreateDBInstance (Maybe Int) Source #

The number of days to retain Performance Insights data. The default is 7 days. The following values are valid:

7
month * 31, where month is a number of months from 1-23
731

For example, the following values are valid:

93 (3 months * 31)
341 (11 months * 31)
589 (19 months * 31)
731

If you specify a retention period such as 94, which isn't a valid value, RDS issues an error.

This setting doesn't apply to RDS Custom.

createDBInstance_port :: Lens' CreateDBInstance (Maybe Int) Source #

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

createDBInstance_preferredBackupWindow :: Lens' CreateDBInstance (Maybe Text) Source #

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 Amazon Web Services 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.

createDBInstance_preferredMaintenanceWindow :: Lens' CreateDBInstance (Maybe Text) Source #

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 Amazon Web Services Region, occurring on a random day of the week.

Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.

Constraints: Minimum 30-minute window.

createDBInstance_processorFeatures :: Lens' CreateDBInstance (Maybe [ProcessorFeature]) Source #

The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.

This setting doesn't apply to RDS Custom.

Amazon Aurora

Not applicable.

createDBInstance_promotionTier :: Lens' CreateDBInstance (Maybe Int) Source #

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.

This setting doesn't apply to RDS Custom.

Default: 1

Valid Values: 0 - 15

createDBInstance_publiclyAccessible :: Lens' CreateDBInstance (Maybe Bool) Source #

A value that indicates whether the DB instance is publicly accessible.

When the DB instance is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB instance's virtual private cloud (VPC). It resolves 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. 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.

createDBInstance_storageEncrypted :: Lens' CreateDBInstance (Maybe Bool) Source #

A value that indicates whether the DB instance is encrypted. By default, it isn't encrypted.

For RDS Custom instances, either set this parameter to true or leave it unset. If you set this parameter to false, RDS reports an error.

Amazon Aurora

Not applicable. The encryption for DB instances is managed by the DB cluster.

createDBInstance_storageThroughput :: Lens' CreateDBInstance (Maybe Int) Source #

Specifies the storage throughput value for the DB instance.

This setting applies only to the gp3 storage type.

This setting doesn't apply to RDS Custom or Amazon Aurora.

createDBInstance_storageType :: Lens' CreateDBInstance (Maybe Text) Source #

Specifies the storage type to be associated with the DB instance.

Valid values: gp2 | gp3 | io1 | standard

If you specify io1 or gp3, you must also include a value for the Iops parameter.

Default: io1 if the Iops parameter is specified, otherwise gp2

Amazon Aurora

Not applicable. Storage is managed by the DB cluster.

createDBInstance_tags :: Lens' CreateDBInstance (Maybe [Tag]) Source #

Tags to assign to the DB instance.

createDBInstance_tdeCredentialArn :: Lens' CreateDBInstance (Maybe Text) Source #

The ARN from the key store with which to associate the instance for TDE encryption.

This setting doesn't apply to RDS Custom.

Amazon Aurora

Not applicable.

createDBInstance_tdeCredentialPassword :: Lens' CreateDBInstance (Maybe Text) Source #

The password for the given ARN from the key store in order to access the device.

This setting doesn't apply to RDS Custom.

createDBInstance_timezone :: Lens' CreateDBInstance (Maybe Text) Source #

The time zone of the DB instance. The time zone parameter is currently supported only by Microsoft SQL Server.

createDBInstance_vpcSecurityGroupIds :: Lens' CreateDBInstance (Maybe [Text]) Source #

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.

createDBInstance_dbInstanceIdentifier :: Lens' CreateDBInstance Text Source #

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

createDBInstance_dbInstanceClass :: Lens' CreateDBInstance Text Source #

The compute and memory capacity of the DB instance, for example db.m5.large. Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines. For the full list of DB instance classes, and availability for your engine, see DB instance classes in the Amazon RDS User Guide or Aurora DB instance classes in the Amazon Aurora User Guide.

createDBInstance_engine :: Lens' CreateDBInstance Text Source #

The name of the database engine to be used for this instance.

Not every database engine is available for every Amazon Web Services Region.

Valid Values:

aurora (for MySQL 5.6-compatible Aurora)
aurora-mysql (for MySQL 5.7-compatible and MySQL 8.0-compatible Aurora)
```
aurora-postgresql
```

custom-oracle-ee (for RDS Custom for Oracle instances)

custom-sqlserver-ee (for RDS Custom for SQL Server instances)

custom-sqlserver-se (for RDS Custom for SQL Server instances)

custom-sqlserver-web (for RDS Custom for SQL Server instances)

```
mariadb
```
```
mysql
```
```
oracle-ee
```
```
oracle-ee-cdb
```
```
oracle-se2
```
```
oracle-se2-cdb
```
```
postgres
```
```
sqlserver-ee
```
```
sqlserver-se
```
```
sqlserver-ex
```
```
sqlserver-web
```

Destructuring the Response

data CreateDBInstanceResponse Source #

See: newCreateDBInstanceResponse smart constructor.

Constructors

CreateDBInstanceResponse'
Fields dbInstance :: Maybe DBInstance httpStatus :: Int The response's http status code.

Instances

Instances details

Generic CreateDBInstanceResponse Source #
Instance details Defined in Amazonka.RDS.CreateDBInstance Associated Types type Rep CreateDBInstanceResponse :: Type -> Type # Methods from :: CreateDBInstanceResponse -> Rep CreateDBInstanceResponse x # to :: Rep CreateDBInstanceResponse x -> CreateDBInstanceResponse #
Read CreateDBInstanceResponse Source #
Instance details Defined in Amazonka.RDS.CreateDBInstance Methods readsPrec :: Int -> ReadS CreateDBInstanceResponse # readList :: ReadS [CreateDBInstanceResponse] # readPrec :: ReadPrec CreateDBInstanceResponse # readListPrec :: ReadPrec [CreateDBInstanceResponse] #
Show CreateDBInstanceResponse Source #
Instance details Defined in Amazonka.RDS.CreateDBInstance Methods showsPrec :: Int -> CreateDBInstanceResponse -> ShowS # show :: CreateDBInstanceResponse -> String # showList :: [CreateDBInstanceResponse] -> ShowS #
NFData CreateDBInstanceResponse Source #
Instance details Defined in Amazonka.RDS.CreateDBInstance Methods rnf :: CreateDBInstanceResponse -> () #
Eq CreateDBInstanceResponse Source #
Instance details Defined in Amazonka.RDS.CreateDBInstance Methods (==) :: CreateDBInstanceResponse -> CreateDBInstanceResponse -> Bool # (/=) :: CreateDBInstanceResponse -> CreateDBInstanceResponse -> Bool #
type Rep CreateDBInstanceResponse Source #
Instance details Defined in Amazonka.RDS.CreateDBInstance type Rep CreateDBInstanceResponse = D1 ('MetaData "CreateDBInstanceResponse" "Amazonka.RDS.CreateDBInstance" "amazonka-rds-2.0-3xXyiLHmAvvCXXUIx1uhpP" 'False) (C1 ('MetaCons "CreateDBInstanceResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "dbInstance") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DBInstance)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newCreateDBInstanceResponse Source #

Arguments

:: Int	`$sel:httpStatus:CreateDBInstanceResponse'`
-> CreateDBInstanceResponse

Create a value of CreateDBInstanceResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:dbInstance:CreateDBInstanceResponse', createDBInstanceResponse_dbInstance - Undocumented member.

$sel:httpStatus:CreateDBInstanceResponse', createDBInstanceResponse_httpStatus - The response's http status code.

Response Lenses

createDBInstanceResponse_dbInstance :: Lens' CreateDBInstanceResponse (Maybe DBInstance) Source #

Undocumented member.

createDBInstanceResponse_httpStatus :: Lens' CreateDBInstanceResponse Int Source #

The response's http status code.