Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. rds
  5. getDbInstance

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-aws-native

aws-native.rds.getDbInstance

Explore with Pulumi AI

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-aws-native

The AWS::RDS::DBInstance resource creates an Amazon 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 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. If you import an existing DB instance, and the template configuration doesn’t match the actual configuration of the DB instance, AWS CloudFormation applies the changes in the template during the import operation. If a DB instance is deleted or replaced during an update, AWS CloudFormation deletes all automated snapshots. However, it retains manual DB snapshots. During an update that requires replacement, you can apply a stack policy to prevent DB instances from being replaced. For more information, see Prevent Updates to Stack Resources. Updating DB instances When properties labeled “Update requires: Replacement” are updated, AWS CloudFormation first creates a replacement DB instance, then changes references from other dependent resources to point to the replacement DB instance, and finally deletes the old DB instance. We highly recommend that you take a snapshot of the database before updating the stack. If you don’t, you lose the data when AWS CloudFormation replaces your DB instance. To preserve your data, perform the following procedure:

  1. Deactivate any applications that are using the DB instance so that there’s no activity on the DB instance.
  2. Create a snapshot of the DB instance. For more information, see Creating a DB Snapshot.
  3. If you want to restore your instance using a DB snapshot, modify the updated template with your DB instance changes and add the DBSnapshotIdentifier property with the ID of the DB snapshot that you want to use. After you restore a DB instance with a DBSnapshotIdentifier property, you can delete the DBSnapshotIdentifier property. When you specify this property for an update, the DB instance is not restored from the DB snapshot again, and the data in the database is not changed. However, if you don’t specify the DBSnapshotIdentifier property, an empty DB instance is created, and the original DB instance is deleted. If you specify a property that is different from the previous snapshot restore property, a new DB instance is restored from the specified DBSnapshotIdentifier property, and the original DB instance is deleted.
  4. Update the stack.

For more information about updating other properties of this resource, see ModifyDBInstance. For more information about updating stacks, see CloudFormation Stacks Updates. Deleting DB instances For DB instances that are part of an Aurora DB cluster, you can set a deletion policy for your DB instance to control how AWS CloudFormation handles the DB instance when the stack is deleted. For Amazon RDS DB instances, you can choose to retain the DB instance, to delete the DB instance, or to create a snapshot of the DB instance. The default AWS CloudFormation behavior depends on the DBClusterIdentifier property:

  1. For AWS::RDS::DBInstance resources that don’t specify the DBClusterIdentifier property, AWS CloudFormation saves a snapshot of the DB instance.
  2. For AWS::RDS::DBInstance resources that do specify the DBClusterIdentifier property, AWS CloudFormation deletes the DB instance.

For more information, see DeletionPolicy Attribute.

Using getDbInstance

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getDbInstance(args: GetDbInstanceArgs, opts?: InvokeOptions): Promise<GetDbInstanceResult>
function getDbInstanceOutput(args: GetDbInstanceOutputArgs, opts?: InvokeOptions): Output<GetDbInstanceResult>
Copy
def get_db_instance(db_instance_identifier: Optional[str] = None,
                    opts: Optional[InvokeOptions] = None) -> GetDbInstanceResult
def get_db_instance_output(db_instance_identifier: Optional[pulumi.Input[str]] = None,
                    opts: Optional[InvokeOptions] = None) -> Output[GetDbInstanceResult]
Copy
func LookupDbInstance(ctx *Context, args *LookupDbInstanceArgs, opts ...InvokeOption) (*LookupDbInstanceResult, error)
func LookupDbInstanceOutput(ctx *Context, args *LookupDbInstanceOutputArgs, opts ...InvokeOption) LookupDbInstanceResultOutput
Copy

> Note: This function is named LookupDbInstance in the Go SDK.

public static class GetDbInstance 
{
    public static Task<GetDbInstanceResult> InvokeAsync(GetDbInstanceArgs args, InvokeOptions? opts = null)
    public static Output<GetDbInstanceResult> Invoke(GetDbInstanceInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetDbInstanceResult> getDbInstance(GetDbInstanceArgs args, InvokeOptions options)
public static Output<GetDbInstanceResult> getDbInstance(GetDbInstanceArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: aws-native:rds:getDbInstance
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

DbInstanceIdentifier This property is required. string
A name for the DB instance. If you specify a name, AWS CloudFormation converts it to lowercase. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the DB instance. For more information, see Name Type. For information about constraints that apply to DB instance identifiers, see Naming constraints in Amazon RDS in the Amazon RDS User Guide. If you specify a name, you can't perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.
DbInstanceIdentifier This property is required. string
A name for the DB instance. If you specify a name, AWS CloudFormation converts it to lowercase. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the DB instance. For more information, see Name Type. For information about constraints that apply to DB instance identifiers, see Naming constraints in Amazon RDS in the Amazon RDS User Guide. If you specify a name, you can't perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.
dbInstanceIdentifier This property is required. String
A name for the DB instance. If you specify a name, AWS CloudFormation converts it to lowercase. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the DB instance. For more information, see Name Type. For information about constraints that apply to DB instance identifiers, see Naming constraints in Amazon RDS in the Amazon RDS User Guide. If you specify a name, you can't perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.
dbInstanceIdentifier This property is required. string
A name for the DB instance. If you specify a name, AWS CloudFormation converts it to lowercase. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the DB instance. For more information, see Name Type. For information about constraints that apply to DB instance identifiers, see Naming constraints in Amazon RDS in the Amazon RDS User Guide. If you specify a name, you can't perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.
db_instance_identifier This property is required. str
A name for the DB instance. If you specify a name, AWS CloudFormation converts it to lowercase. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the DB instance. For more information, see Name Type. For information about constraints that apply to DB instance identifiers, see Naming constraints in Amazon RDS in the Amazon RDS User Guide. If you specify a name, you can't perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.
dbInstanceIdentifier This property is required. String
A name for the DB instance. If you specify a name, AWS CloudFormation converts it to lowercase. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the DB instance. For more information, see Name Type. For information about constraints that apply to DB instance identifiers, see Naming constraints in Amazon RDS in the Amazon RDS User Guide. If you specify a name, you can't perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.

getDbInstance Result

The following output properties are available:

AllocatedStorage string

The amount of storage in gibibytes (GiB) to be initially allocated for the database instance. If any value is set in the Iops parameter, AllocatedStorage must be at least 100 GiB, which corresponds to the minimum Iops value of 1,000. If you increase the Iops value (in 1,000 IOPS increments), then you must also increase the AllocatedStorage value (in 100-GiB increments). 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. Db2 Constraints to the amount of storage for each storage type are the following:

  • General Purpose (SSD) storage (gp3): Must be an integer from 20 to 64000.
  • Provisioned IOPS storage (io1): Must be an integer from 100 to 64000.

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

  • General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536.
  • Provisioned IOPS storage (io1): Must be an integer from 100 to 65536.
  • Magnetic storage (standard): Must be an integer from 5 to 3072.

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

  • General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536.
  • Provisioned IOPS storage (io1): Must be an integer from 100 to 65536.
  • Magnetic storage (standard): Must be an integer from 5 to 3072.

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

  • General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536.
  • Provisioned IOPS storage (io1): Must be an integer from 100 to 65536.
  • Magnetic storage (standard): Must be an integer from 5 to 3072.

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

  • General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536.
  • Provisioned IOPS storage (io1): Must be an integer from 100 to 65536.
  • Magnetic storage (standard): Must be an integer from 10 to 3072.

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

  • General Purpose (SSD) storage (gp2):

  • Enterprise and Standard editions: Must be an integer from 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 20 to 16384.

  • Web and Express editions: Must be an integer from 20 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.

AssociatedRoles List<Pulumi.AwsNative.Rds.Outputs.DbInstanceDbInstanceRole>
The IAMlong (IAM) roles associated with the DB instance. Amazon Aurora Not applicable. The associated roles are managed by the DB cluster.
AutoMinorVersionUpgrade 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.
AutomaticBackupReplicationRegion string
The AWS-Region associated with the automated backup.
AutomaticBackupReplicationRetentionPeriod int
The retention period for automated backups in a different AWS Region. Use this parameter to set a unique retention period that only applies to cross-Region automated backups. To enable automated backups in a different Region, specify a positive value for the AutomaticBackupReplicationRegion parameter. If not specified, this parameter defaults to the value of the BackupRetentionPeriod parameter. The maximum allowed value is 35.
AvailabilityZone string

The Availability Zone (AZ) where the database will be created. For information on AWS-Regions and Availability Zones, see Regions and Availability Zones. For 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 AWS-Region. Constraints:

  • The AvailabilityZone parameter can't be specified if the DB instance is a Multi-AZ deployment.
  • The specified Availability Zone must be in the same AWS-Region as the current endpoint.

Example: us-east-1d

BackupRetentionPeriod 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
CaCertificateIdentifier string
The identifier of the CA certificate for this DB instance. 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.
CertificateDetails Pulumi.AwsNative.Rds.Outputs.DbInstanceCertificateDetails
CopyTagsToSnapshot bool
Specifies whether to copy tags from the DB instance to snapshots of the DB instance. By default, tags are not copied. This setting doesn't apply to Amazon Aurora DB instances. 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.
DatabaseInsightsMode string
The mode of Database Insights that is enabled for the instance.
DbClusterSnapshotIdentifier string
The identifier for the Multi-AZ DB cluster snapshot to restore from. For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide. Constraints:

  • Must match the identifier of an existing Multi-AZ DB cluster snapshot.
  • Can't be specified when DBSnapshotIdentifier is specified.
  • Must be specified when DBSnapshotIdentifier isn't specified.
  • If you are restoring from a shared manual Multi-AZ DB cluster snapshot, the DBClusterSnapshotIdentifier must be the ARN of the shared snapshot.
  • Can't be the identifier of an Aurora DB cluster snapshot.
DbInstanceArn string
The Amazon Resource Name (ARN) for the DB instance.
DbInstanceClass string
The compute and memory capacity of the DB instance, for example db.m5.large. Not all DB instance classes are available in all AWS-Regions, or for all database engines. For the full list of DB instance classes, and availability for your engine, see DB instance classes in the Amazon RDS User Guide or Aurora DB instance classes in the Amazon Aurora User Guide.
DbParameterGroupName string
The name of an existing DB parameter group or a reference to an AWS::RDS::DBParameterGroup resource created in the template. To list all of the available DB parameter group names, use the following command: aws rds describe-db-parameter-groups --query "DBParameterGroups[].DBParameterGroupName" --output text If any of the data members of the referenced parameter group are changed during an update, the DB instance might need to be restarted, which causes some interruption. If the parameter group contains static parameters, whether they were changed or not, an update triggers a reboot. If you don't specify a value for DBParameterGroupName property, the default DB parameter group for the specified engine and engine version is used.
DbSecurityGroups List<string>

A list of the DB security groups to assign to the DB instance. The list can include both the name of existing DB security groups or references to AWS::RDS::DBSecurityGroup resources created in the template. If you set DBSecurityGroups, you must not set VPCSecurityGroups, and vice versa. Also, note that the DBSecurityGroups property exists only for backwards compatibility with older regions and is no longer recommended for providing security information to an RDS DB instance. Instead, use VPCSecurityGroups. If you specify this property, AWS CloudFormation sends only the following properties (if specified) to Amazon RDS during create operations:

  • AllocatedStorage
  • AutoMinorVersionUpgrade
  • AvailabilityZone
  • BackupRetentionPeriod
  • CharacterSetName
  • DBInstanceClass
  • DBName
  • DBParameterGroupName
  • DBSecurityGroups
  • DBSubnetGroupName
  • Engine
  • EngineVersion
  • Iops
  • LicenseModel
  • MasterUsername
  • MasterUserPassword
  • MultiAZ
  • OptionGroupName
  • PreferredBackupWindow
  • PreferredMaintenanceWindow

All other properties are ignored. Specify a virtual private cloud (VPC) security group if you want to submit other properties, such as StorageType, StorageEncrypted, or KmsKeyId. If you're already using the DBSecurityGroups property, you can't use these other properties by updating your DB instance to use a VPC security group. You must recreate the DB instance.

DbiResourceId string
The AWS Region-unique, immutable identifier for the DB instance. This identifier is found in AWS CloudTrail log entries whenever the AWS KMS key for the DB instance is accessed.
DedicatedLogVolume bool
Indicates whether the DB instance has a dedicated log volume (DLV) enabled.
DeletionProtection bool
Specifies 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. This setting doesn't apply to Amazon Aurora DB instances. 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 string
The Active Directory directory ID to create the DB instance in. Currently, only Db2, 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.
DomainAuthSecretArn string
The ARN for the Secrets Manager secret with the credentials for the user joining the domain. Example: arn:aws:secretsmanager:region:account-number:secret:myselfmanagedADtestsecret-123456
DomainDnsIps List<string>

The IPv4 DNS IP addresses of your primary and secondary Active Directory domain controllers. Constraints:

  • Two IP addresses must be provided. If there isn't a secondary domain controller, use the IP address of the primary domain controller for both entries in the list.

Example: 123.124.125.126,234.235.236.237

DomainFqdn string

The fully qualified domain name (FQDN) of an Active Directory domain. Constraints:

  • Can't be longer than 64 characters.

Example: mymanagedADtest.mymanagedAD.mydomain

DomainIamRoleName string
The name of the IAM role to use when making API calls to the Directory Service. This setting doesn't apply to the following DB instances:

  • Amazon Aurora (The domain is managed by the DB cluster.)
  • RDS Custom
DomainOu string

The Active Directory organizational unit for your DB instance to join. Constraints:

  • Must be in the distinguished name format.
  • Can't be longer than 64 characters.

Example: OU=mymanagedADtestOU,DC=mymanagedADtest,DC=mymanagedAD,DC=mydomain

EnableCloudwatchLogsExports List<string>
The list of log types that need to be enabled for exporting to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Relational Database Service User Guide. Amazon Aurora Not applicable. CloudWatch Logs exports are managed by the DB cluster. Db2 Valid values: diag.log, notify.log MariaDB Valid values: audit, error, general, slowquery Microsoft SQL Server Valid values: agent, error MySQL Valid values: audit, error, general, slowquery Oracle Valid values: alert, audit, listener, trace, oemagent PostgreSQL Valid values: postgresql, upgrade
EnableIamDatabaseAuthentication bool
A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled. This property is supported for RDS for MariaDB, RDS for MySQL, and RDS for PostgreSQL. For more information, see IAM Database Authentication for MariaDB, MySQL, and PostgreSQL in the Amazon RDS User Guide. Amazon Aurora Not applicable. Mapping AWS IAM accounts to database accounts is managed by the DB cluster.
EnablePerformanceInsights bool
Specifies 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 DB instances.
Endpoint Pulumi.AwsNative.Rds.Outputs.DbInstanceEndpoint
Engine string
The name of the database engine to use for this DB instance. Not every database engine is available in every AWS Region. This property is required when creating a DB instance. You can convert an Oracle database from the non-CDB architecture to the container database (CDB) architecture by updating the Engine value in your templates from oracle-ee to oracle-ee-cdb or from oracle-se2 to oracle-se2-cdb. Converting to the CDB architecture requires an interruption. Valid Values:

  • aurora-mysql (for Aurora MySQL DB instances)
  • aurora-postgresql (for Aurora PostgreSQL DB instances)
  • custom-oracle-ee (for RDS Custom for Oracle DB instances)
  • custom-oracle-ee-cdb (for RDS Custom for Oracle DB instances)
  • custom-sqlserver-ee (for RDS Custom for SQL Server DB instances)
  • custom-sqlserver-se (for RDS Custom for SQL Server DB instances)
  • custom-sqlserver-web (for RDS Custom for SQL Server DB instances)
  • db2-ae
  • db2-se
  • mariadb
  • mysql
  • oracle-ee
  • oracle-ee-cdb
  • oracle-se2
  • oracle-se2-cdb
  • postgres
  • sqlserver-ee
  • sqlserver-se
  • sqlserver-ex
  • sqlserver-web
EngineLifecycleSupport string
The life cycle type for this DB instance. By default, this value is set to open-source-rds-extended-support, which enrolls your DB instance into Amazon RDS Extended Support. At the end of standard support, you can avoid charges for Extended Support by setting the value to open-source-rds-extended-support-disabled. In this case, creating the DB instance will fail if the DB major version is past its end of standard support date. This setting applies only to RDS for MySQL and RDS for PostgreSQL. For Amazon Aurora DB instances, the life cycle type is managed by the DB cluster. You can use this setting to enroll your DB instance into Amazon RDS Extended Support. With RDS Extended Support, you can run the selected major engine version on your DB instance past the end of standard support for that engine version. For more information, see Using Amazon RDS Extended Support in the Amazon RDS User Guide. Valid Values: open-source-rds-extended-support | open-source-rds-extended-support-disabled Default: open-source-rds-extended-support
EngineVersion string
The version number of the database engine to use. For a list of valid engine versions, use the DescribeDBEngineVersions action. The following are the database engines and links to information about the major and minor versions that are available with Amazon RDS. Not every database engine is available for every AWS Region. Amazon Aurora Not applicable. The version number of the database engine to be used by the DB instance is managed by the DB cluster. Db2 See Amazon RDS for Db2 in the Amazon RDS User Guide. MariaDB See MariaDB on Amazon RDS Versions in the Amazon RDS User Guide. Microsoft SQL Server See Microsoft SQL Server Versions on Amazon RDS in the Amazon RDS User Guide. MySQL See MySQL on Amazon RDS Versions in the Amazon RDS User Guide. Oracle See Oracle Database Engine Release Notes in the Amazon RDS User Guide. PostgreSQL See Supported PostgreSQL Database Versions in the Amazon RDS User Guide.
Iops int
The number of I/O operations per second (IOPS) that the database provisions. The value must be equal to or greater than 1000. If you specify this property, you must follow the range of allowed ratios of your requested IOPS rate to the amount of storage that you allocate (IOPS to allocated storage). For example, you can provision an Oracle database instance with 1000 IOPS and 200 GiB of storage (a ratio of 5:1), or specify 2000 IOPS with 200 GiB of storage (a ratio of 10:1). For more information, see Amazon RDS Provisioned IOPS Storage to Improve Performance in the Amazon RDS User Guide. If you specify io1 for the StorageType property, then you must also specify the Iops property. Constraints:

  • For RDS for Db2, MariaDB, MySQL, Oracle, and PostgreSQL - Must be a multiple between .5 and 50 of the storage amount for the DB instance.
  • For RDS for SQL Server - Must be a multiple between 1 and 50 of the storage amount for the DB instance.
LicenseModel string

License model information for this DB instance. Valid Values:

  • Aurora MySQL - general-public-license
  • Aurora PostgreSQL - postgresql-license
  • RDS for Db2 - bring-your-own-license. For more information about RDS for Db2 licensing, see in the Amazon RDS User Guide.
  • RDS for MariaDB - general-public-license
  • RDS for Microsoft SQL Server - license-included
  • RDS for MySQL - general-public-license
  • RDS for Oracle - bring-your-own-license or license-included
  • RDS for PostgreSQL - postgresql-license

If you've specified DBSecurityGroups and then you update the license model, AWS CloudFormation replaces the underlying DB instance. This will incur some interruptions to database availability.

ManageMasterUserPassword bool
Specifies whether to manage the master user password with AWS Secrets Manager. For more information, see Password management with Secrets Manager in the Amazon RDS User Guide. Constraints:

  • Can't manage the master user password with AWS Secrets Manager if MasterUserPassword is specified.
MasterUserSecret Pulumi.AwsNative.Rds.Outputs.DbInstanceMasterUserSecret
The secret managed by RDS in AWS Secrets Manager for the master user password. For more information, see Password management with Secrets Manager in the Amazon RDS User Guide.
MaxAllocatedStorage 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 the following DB instances:

  • Amazon Aurora (Storage is managed by the DB cluster.)
  • RDS Custom
MonitoringInterval 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. If MonitoringRoleArn is specified, then you must set MonitoringInterval to a value other than 0. This setting doesn't apply to RDS Custom DB instances. Valid Values: 0 | 1 | 5 | 10 | 15 | 30 | 60 Default: 0
MonitoringRoleArn string
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 DB instances.
MultiAz bool
Specifies 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 the following DB instances:

  • Amazon Aurora (DB instance Availability Zones (AZs) are managed by the DB cluster.)
  • RDS Custom
NetworkType string

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 IPv6 protocols (DUAL). For more information, see Working with a DB instance in a VPC in the Amazon RDS User Guide.

OptionGroupName string
Indicates that the DB instance should be associated with the specified option group. Permanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed from an option group. Also, that option group can't be removed from a DB instance once it is associated with a DB instance.
PerformanceInsightsKmsKeyId string
The AWS KMS key identifier for encryption of Performance Insights data. The 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 AWS account. Your AWS account has a different default KMS key for each AWS Region. For information about enabling Performance Insights, see EnablePerformanceInsights.
PerformanceInsightsRetentionPeriod int

The number of days to retain Performance Insights data. When creating a DB instance without enabling Performance Insights, you can't specify the parameter PerformanceInsightsRetentionPeriod. This setting doesn't apply to RDS Custom DB instances. Valid Values:

  • 7
  • month * 31, where month is a number of months from 1-23. Examples: 93 (3 months * 31), 341 (11 months * 31), 589 (19 months * 31)
  • 731

Default: 7 days If you specify a retention period that isn't valid, such as 94, Amazon RDS returns an error.

Port string

The port number on which the database accepts connections. This setting doesn't apply to Aurora DB instances. The port number is managed by the cluster. Valid Values: 1150-65535 Default:

  • RDS for Db2 - 50000
  • RDS for MariaDB - 3306
  • RDS for Microsoft SQL Server - 1433
  • RDS for MySQL - 3306
  • RDS for Oracle - 1521
  • RDS for PostgreSQL - 5432

Constraints:

  • For RDS for Microsoft SQL Server, the value can't be 1234, 1434, 3260, 3343, 3389, 47001, or 49152-49156.
PreferredBackupWindow string

The daily time range during which automated backups are created if automated backups are enabled, using the BackupRetentionPeriod parameter. For more information, see Backup Window in the Amazon RDS User Guide. Constraints:

  • Must be in the format hh24:mi-hh24:mi.
  • Must be in Universal Coordinated Time (UTC).
  • Must not conflict with the preferred maintenance window.
  • Must be at least 30 minutes.

Amazon Aurora Not applicable. The daily time range for creating automated backups is managed by the DB cluster.

PreferredMaintenanceWindow string
The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC). Format: ddd:hh24:mi-ddd:hh24:mi The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region, occurring on a random day of the week. To see the time blocks available, see Maintaining a DB instance in the Amazon RDS User Guide. This property applies when AWS CloudFormation initially creates the DB instance. If you use AWS CloudFormation to update the DB instance, those updates are applied immediately. Constraints: Minimum 30-minute window.
ProcessorFeatures List<Pulumi.AwsNative.Rds.Outputs.DbInstanceProcessorFeature>
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 Amazon Aurora or RDS Custom DB instances.
PromotionTier int
The order of priority 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 DB instances. Default: 1 Valid Values: 0 - 15
PubliclyAccessible bool
Indicates whether the DB instance is an internet-facing instance. If you specify true, AWS CloudFormation creates an instance with a publicly resolvable DNS name, which resolves to a public IP address. If you specify false, AWS CloudFormation creates an internal instance with a DNS name that resolves to a private IP address. The default behavior value depends on your VPC setup and the database subnet group. For more information, see the PubliclyAccessible parameter in the CreateDBInstance in the Amazon RDS API Reference.
ReplicaMode string
The open mode of an Oracle read replica. For more information, see Working with Oracle Read Replicas for Amazon RDS in the Amazon RDS User Guide. This setting is only supported in RDS for Oracle. Default: open-read-only Valid Values: open-read-only or mounted
SourceDbClusterIdentifier string
The identifier of the Multi-AZ DB cluster that will act as the source for the read replica. Each DB cluster can have up to 15 read replicas. Constraints:

  • Must be the identifier of an existing Multi-AZ DB cluster.
  • Can't be specified if the SourceDBInstanceIdentifier parameter is also specified.
  • The specified DB cluster must have automatic backups enabled, that is, its backup retention period must be greater than 0.
  • The source DB cluster must be in the same AWS-Region as the read replica. Cross-Region replication isn't supported.
StorageThroughput int
Specifies the storage throughput value, in mebibyte per second (MiBps), 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 string
The storage type to associate with the DB instance. If you specify io1, io2, or gp3, you must also include a value for the Iops parameter. This setting doesn't apply to Amazon Aurora DB instances. Storage is managed by the DB cluster. Valid Values: gp2 | gp3 | io1 | io2 | standard Default: io1, if the Iops parameter is specified. Otherwise, gp3.
Tags List<Pulumi.AwsNative.Outputs.Tag>
Tags to assign to the DB instance.
TdeCredentialArn string
VpcSecurityGroups List<string>

A list of the VPC security group IDs to assign to the DB instance. The list can include both the physical IDs of existing VPC security groups and references to AWS::EC2::SecurityGroup resources created in the template. If you plan to update the resource, don't specify VPC security groups in a shared VPC. If you set VPCSecurityGroups, you must not set DBSecurityGroups, and vice versa. You can migrate a DB instance in your stack from an RDS DB security group to a VPC security group, but keep the following in mind:

  • You can't revert to using an RDS security group after you establish a VPC security group membership.
  • When you migrate your DB instance to VPC security groups, if your stack update rolls back because the DB instance update fails or because an update fails in another AWS CloudFormation resource, the rollback fails because it can't revert to an RDS security group.
  • To use the properties that are available when you use a VPC security group, you must recreate the DB instance. If you don't, AWS CloudFormation submits only the property values that are listed in the DBSecurityGroups property.

To avoid this situation, migrate your DB instance to using VPC security groups only when that is the only change in your stack template. Amazon Aurora Not applicable. The associated list of EC2 VPC security groups is managed by the DB cluster. If specified, the setting must match the DB cluster setting.

AllocatedStorage string

The amount of storage in gibibytes (GiB) to be initially allocated for the database instance. If any value is set in the Iops parameter, AllocatedStorage must be at least 100 GiB, which corresponds to the minimum Iops value of 1,000. If you increase the Iops value (in 1,000 IOPS increments), then you must also increase the AllocatedStorage value (in 100-GiB increments). 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. Db2 Constraints to the amount of storage for each storage type are the following:

  • General Purpose (SSD) storage (gp3): Must be an integer from 20 to 64000.
  • Provisioned IOPS storage (io1): Must be an integer from 100 to 64000.

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

  • General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536.
  • Provisioned IOPS storage (io1): Must be an integer from 100 to 65536.
  • Magnetic storage (standard): Must be an integer from 5 to 3072.

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

  • General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536.
  • Provisioned IOPS storage (io1): Must be an integer from 100 to 65536.
  • Magnetic storage (standard): Must be an integer from 5 to 3072.

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

  • General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536.
  • Provisioned IOPS storage (io1): Must be an integer from 100 to 65536.
  • Magnetic storage (standard): Must be an integer from 5 to 3072.

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

  • General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536.
  • Provisioned IOPS storage (io1): Must be an integer from 100 to 65536.
  • Magnetic storage (standard): Must be an integer from 10 to 3072.

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

  • General Purpose (SSD) storage (gp2):

  • Enterprise and Standard editions: Must be an integer from 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 20 to 16384.

  • Web and Express editions: Must be an integer from 20 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.

AssociatedRoles []DbInstanceDbInstanceRole
The IAMlong (IAM) roles associated with the DB instance. Amazon Aurora Not applicable. The associated roles are managed by the DB cluster.
AutoMinorVersionUpgrade 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.
AutomaticBackupReplicationRegion string
The AWS-Region associated with the automated backup.
AutomaticBackupReplicationRetentionPeriod int
The retention period for automated backups in a different AWS Region. Use this parameter to set a unique retention period that only applies to cross-Region automated backups. To enable automated backups in a different Region, specify a positive value for the AutomaticBackupReplicationRegion parameter. If not specified, this parameter defaults to the value of the BackupRetentionPeriod parameter. The maximum allowed value is 35.
AvailabilityZone string

The Availability Zone (AZ) where the database will be created. For information on AWS-Regions and Availability Zones, see Regions and Availability Zones. For 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 AWS-Region. Constraints:

  • The AvailabilityZone parameter can't be specified if the DB instance is a Multi-AZ deployment.
  • The specified Availability Zone must be in the same AWS-Region as the current endpoint.

Example: us-east-1d

BackupRetentionPeriod 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
CaCertificateIdentifier string
The identifier of the CA certificate for this DB instance. 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.
CertificateDetails DbInstanceCertificateDetails
CopyTagsToSnapshot bool
Specifies whether to copy tags from the DB instance to snapshots of the DB instance. By default, tags are not copied. This setting doesn't apply to Amazon Aurora DB instances. 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.
DatabaseInsightsMode string
The mode of Database Insights that is enabled for the instance.
DbClusterSnapshotIdentifier string
The identifier for the Multi-AZ DB cluster snapshot to restore from. For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide. Constraints:

  • Must match the identifier of an existing Multi-AZ DB cluster snapshot.
  • Can't be specified when DBSnapshotIdentifier is specified.
  • Must be specified when DBSnapshotIdentifier isn't specified.
  • If you are restoring from a shared manual Multi-AZ DB cluster snapshot, the DBClusterSnapshotIdentifier must be the ARN of the shared snapshot.
  • Can't be the identifier of an Aurora DB cluster snapshot.
DbInstanceArn string
The Amazon Resource Name (ARN) for the DB instance.
DbInstanceClass string
The compute and memory capacity of the DB instance, for example db.m5.large. Not all DB instance classes are available in all AWS-Regions, or for all database engines. For the full list of DB instance classes, and availability for your engine, see DB instance classes in the Amazon RDS User Guide or Aurora DB instance classes in the Amazon Aurora User Guide.
DbParameterGroupName string
The name of an existing DB parameter group or a reference to an AWS::RDS::DBParameterGroup resource created in the template. To list all of the available DB parameter group names, use the following command: aws rds describe-db-parameter-groups --query "DBParameterGroups[].DBParameterGroupName" --output text If any of the data members of the referenced parameter group are changed during an update, the DB instance might need to be restarted, which causes some interruption. If the parameter group contains static parameters, whether they were changed or not, an update triggers a reboot. If you don't specify a value for DBParameterGroupName property, the default DB parameter group for the specified engine and engine version is used.
DbSecurityGroups []string

A list of the DB security groups to assign to the DB instance. The list can include both the name of existing DB security groups or references to AWS::RDS::DBSecurityGroup resources created in the template. If you set DBSecurityGroups, you must not set VPCSecurityGroups, and vice versa. Also, note that the DBSecurityGroups property exists only for backwards compatibility with older regions and is no longer recommended for providing security information to an RDS DB instance. Instead, use VPCSecurityGroups. If you specify this property, AWS CloudFormation sends only the following properties (if specified) to Amazon RDS during create operations:

  • AllocatedStorage
  • AutoMinorVersionUpgrade
  • AvailabilityZone
  • BackupRetentionPeriod
  • CharacterSetName
  • DBInstanceClass
  • DBName
  • DBParameterGroupName
  • DBSecurityGroups
  • DBSubnetGroupName
  • Engine
  • EngineVersion
  • Iops
  • LicenseModel
  • MasterUsername
  • MasterUserPassword
  • MultiAZ
  • OptionGroupName
  • PreferredBackupWindow
  • PreferredMaintenanceWindow

All other properties are ignored. Specify a virtual private cloud (VPC) security group if you want to submit other properties, such as StorageType, StorageEncrypted, or KmsKeyId. If you're already using the DBSecurityGroups property, you can't use these other properties by updating your DB instance to use a VPC security group. You must recreate the DB instance.

DbiResourceId string
The AWS Region-unique, immutable identifier for the DB instance. This identifier is found in AWS CloudTrail log entries whenever the AWS KMS key for the DB instance is accessed.
DedicatedLogVolume bool
Indicates whether the DB instance has a dedicated log volume (DLV) enabled.
DeletionProtection bool
Specifies 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. This setting doesn't apply to Amazon Aurora DB instances. 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 string
The Active Directory directory ID to create the DB instance in. Currently, only Db2, 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.
DomainAuthSecretArn string
The ARN for the Secrets Manager secret with the credentials for the user joining the domain. Example: arn:aws:secretsmanager:region:account-number:secret:myselfmanagedADtestsecret-123456
DomainDnsIps []string

The IPv4 DNS IP addresses of your primary and secondary Active Directory domain controllers. Constraints:

  • Two IP addresses must be provided. If there isn't a secondary domain controller, use the IP address of the primary domain controller for both entries in the list.

Example: 123.124.125.126,234.235.236.237

DomainFqdn string

The fully qualified domain name (FQDN) of an Active Directory domain. Constraints:

  • Can't be longer than 64 characters.

Example: mymanagedADtest.mymanagedAD.mydomain

DomainIamRoleName string
The name of the IAM role to use when making API calls to the Directory Service. This setting doesn't apply to the following DB instances:

  • Amazon Aurora (The domain is managed by the DB cluster.)
  • RDS Custom
DomainOu string

The Active Directory organizational unit for your DB instance to join. Constraints:

  • Must be in the distinguished name format.
  • Can't be longer than 64 characters.

Example: OU=mymanagedADtestOU,DC=mymanagedADtest,DC=mymanagedAD,DC=mydomain

EnableCloudwatchLogsExports []string
The list of log types that need to be enabled for exporting to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Relational Database Service User Guide. Amazon Aurora Not applicable. CloudWatch Logs exports are managed by the DB cluster. Db2 Valid values: diag.log, notify.log MariaDB Valid values: audit, error, general, slowquery Microsoft SQL Server Valid values: agent, error MySQL Valid values: audit, error, general, slowquery Oracle Valid values: alert, audit, listener, trace, oemagent PostgreSQL Valid values: postgresql, upgrade
EnableIamDatabaseAuthentication bool
A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled. This property is supported for RDS for MariaDB, RDS for MySQL, and RDS for PostgreSQL. For more information, see IAM Database Authentication for MariaDB, MySQL, and PostgreSQL in the Amazon RDS User Guide. Amazon Aurora Not applicable. Mapping AWS IAM accounts to database accounts is managed by the DB cluster.
EnablePerformanceInsights bool
Specifies 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 DB instances.
Endpoint DbInstanceEndpoint
Engine string
The name of the database engine to use for this DB instance. Not every database engine is available in every AWS Region. This property is required when creating a DB instance. You can convert an Oracle database from the non-CDB architecture to the container database (CDB) architecture by updating the Engine value in your templates from oracle-ee to oracle-ee-cdb or from oracle-se2 to oracle-se2-cdb. Converting to the CDB architecture requires an interruption. Valid Values:

  • aurora-mysql (for Aurora MySQL DB instances)
  • aurora-postgresql (for Aurora PostgreSQL DB instances)
  • custom-oracle-ee (for RDS Custom for Oracle DB instances)
  • custom-oracle-ee-cdb (for RDS Custom for Oracle DB instances)
  • custom-sqlserver-ee (for RDS Custom for SQL Server DB instances)
  • custom-sqlserver-se (for RDS Custom for SQL Server DB instances)
  • custom-sqlserver-web (for RDS Custom for SQL Server DB instances)
  • db2-ae
  • db2-se
  • mariadb
  • mysql
  • oracle-ee
  • oracle-ee-cdb
  • oracle-se2
  • oracle-se2-cdb
  • postgres
  • sqlserver-ee
  • sqlserver-se
  • sqlserver-ex
  • sqlserver-web
EngineLifecycleSupport string
The life cycle type for this DB instance. By default, this value is set to open-source-rds-extended-support, which enrolls your DB instance into Amazon RDS Extended Support. At the end of standard support, you can avoid charges for Extended Support by setting the value to open-source-rds-extended-support-disabled. In this case, creating the DB instance will fail if the DB major version is past its end of standard support date. This setting applies only to RDS for MySQL and RDS for PostgreSQL. For Amazon Aurora DB instances, the life cycle type is managed by the DB cluster. You can use this setting to enroll your DB instance into Amazon RDS Extended Support. With RDS Extended Support, you can run the selected major engine version on your DB instance past the end of standard support for that engine version. For more information, see Using Amazon RDS Extended Support in the Amazon RDS User Guide. Valid Values: open-source-rds-extended-support | open-source-rds-extended-support-disabled Default: open-source-rds-extended-support
EngineVersion string
The version number of the database engine to use. For a list of valid engine versions, use the DescribeDBEngineVersions action. The following are the database engines and links to information about the major and minor versions that are available with Amazon RDS. Not every database engine is available for every AWS Region. Amazon Aurora Not applicable. The version number of the database engine to be used by the DB instance is managed by the DB cluster. Db2 See Amazon RDS for Db2 in the Amazon RDS User Guide. MariaDB See MariaDB on Amazon RDS Versions in the Amazon RDS User Guide. Microsoft SQL Server See Microsoft SQL Server Versions on Amazon RDS in the Amazon RDS User Guide. MySQL See MySQL on Amazon RDS Versions in the Amazon RDS User Guide. Oracle See Oracle Database Engine Release Notes in the Amazon RDS User Guide. PostgreSQL See Supported PostgreSQL Database Versions in the Amazon RDS User Guide.
Iops int
The number of I/O operations per second (IOPS) that the database provisions. The value must be equal to or greater than 1000. If you specify this property, you must follow the range of allowed ratios of your requested IOPS rate to the amount of storage that you allocate (IOPS to allocated storage). For example, you can provision an Oracle database instance with 1000 IOPS and 200 GiB of storage (a ratio of 5:1), or specify 2000 IOPS with 200 GiB of storage (a ratio of 10:1). For more information, see Amazon RDS Provisioned IOPS Storage to Improve Performance in the Amazon RDS User Guide. If you specify io1 for the StorageType property, then you must also specify the Iops property. Constraints:

  • For RDS for Db2, MariaDB, MySQL, Oracle, and PostgreSQL - Must be a multiple between .5 and 50 of the storage amount for the DB instance.
  • For RDS for SQL Server - Must be a multiple between 1 and 50 of the storage amount for the DB instance.
LicenseModel string

License model information for this DB instance. Valid Values:

  • Aurora MySQL - general-public-license
  • Aurora PostgreSQL - postgresql-license
  • RDS for Db2 - bring-your-own-license. For more information about RDS for Db2 licensing, see in the Amazon RDS User Guide.
  • RDS for MariaDB - general-public-license
  • RDS for Microsoft SQL Server - license-included
  • RDS for MySQL - general-public-license
  • RDS for Oracle - bring-your-own-license or license-included
  • RDS for PostgreSQL - postgresql-license

If you've specified DBSecurityGroups and then you update the license model, AWS CloudFormation replaces the underlying DB instance. This will incur some interruptions to database availability.

ManageMasterUserPassword bool
Specifies whether to manage the master user password with AWS Secrets Manager. For more information, see Password management with Secrets Manager in the Amazon RDS User Guide. Constraints:

  • Can't manage the master user password with AWS Secrets Manager if MasterUserPassword is specified.
MasterUserSecret DbInstanceMasterUserSecret
The secret managed by RDS in AWS Secrets Manager for the master user password. For more information, see Password management with Secrets Manager in the Amazon RDS User Guide.
MaxAllocatedStorage 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 the following DB instances:

  • Amazon Aurora (Storage is managed by the DB cluster.)
  • RDS Custom
MonitoringInterval 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. If MonitoringRoleArn is specified, then you must set MonitoringInterval to a value other than 0. This setting doesn't apply to RDS Custom DB instances. Valid Values: 0 | 1 | 5 | 10 | 15 | 30 | 60 Default: 0
MonitoringRoleArn string
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 DB instances.
MultiAz bool
Specifies 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 the following DB instances:

  • Amazon Aurora (DB instance Availability Zones (AZs) are managed by the DB cluster.)
  • RDS Custom
NetworkType string

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 IPv6 protocols (DUAL). For more information, see Working with a DB instance in a VPC in the Amazon RDS User Guide.

OptionGroupName string
Indicates that the DB instance should be associated with the specified option group. Permanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed from an option group. Also, that option group can't be removed from a DB instance once it is associated with a DB instance.
PerformanceInsightsKmsKeyId string
The AWS KMS key identifier for encryption of Performance Insights data. The 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 AWS account. Your AWS account has a different default KMS key for each AWS Region. For information about enabling Performance Insights, see EnablePerformanceInsights.
PerformanceInsightsRetentionPeriod int

The number of days to retain Performance Insights data. When creating a DB instance without enabling Performance Insights, you can't specify the parameter PerformanceInsightsRetentionPeriod. This setting doesn't apply to RDS Custom DB instances. Valid Values:

  • 7
  • month * 31, where month is a number of months from 1-23. Examples: 93 (3 months * 31), 341 (11 months * 31), 589 (19 months * 31)
  • 731

Default: 7 days If you specify a retention period that isn't valid, such as 94, Amazon RDS returns an error.

Port string

The port number on which the database accepts connections. This setting doesn't apply to Aurora DB instances. The port number is managed by the cluster. Valid Values: 1150-65535 Default:

  • RDS for Db2 - 50000
  • RDS for MariaDB - 3306
  • RDS for Microsoft SQL Server - 1433
  • RDS for MySQL - 3306
  • RDS for Oracle - 1521
  • RDS for PostgreSQL - 5432

Constraints:

  • For RDS for Microsoft SQL Server, the value can't be 1234, 1434, 3260, 3343, 3389, 47001, or 49152-49156.
PreferredBackupWindow string

The daily time range during which automated backups are created if automated backups are enabled, using the BackupRetentionPeriod parameter. For more information, see Backup Window in the Amazon RDS User Guide. Constraints:

  • Must be in the format hh24:mi-hh24:mi.
  • Must be in Universal Coordinated Time (UTC).
  • Must not conflict with the preferred maintenance window.
  • Must be at least 30 minutes.

Amazon Aurora Not applicable. The daily time range for creating automated backups is managed by the DB cluster.

PreferredMaintenanceWindow string
The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC). Format: ddd:hh24:mi-ddd:hh24:mi The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region, occurring on a random day of the week. To see the time blocks available, see Maintaining a DB instance in the Amazon RDS User Guide. This property applies when AWS CloudFormation initially creates the DB instance. If you use AWS CloudFormation to update the DB instance, those updates are applied immediately. Constraints: Minimum 30-minute window.
ProcessorFeatures []DbInstanceProcessorFeature
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 Amazon Aurora or RDS Custom DB instances.
PromotionTier int
The order of priority 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 DB instances. Default: 1 Valid Values: 0 - 15
PubliclyAccessible bool
Indicates whether the DB instance is an internet-facing instance. If you specify true, AWS CloudFormation creates an instance with a publicly resolvable DNS name, which resolves to a public IP address. If you specify false, AWS CloudFormation creates an internal instance with a DNS name that resolves to a private IP address. The default behavior value depends on your VPC setup and the database subnet group. For more information, see the PubliclyAccessible parameter in the CreateDBInstance in the Amazon RDS API Reference.
ReplicaMode string
The open mode of an Oracle read replica. For more information, see Working with Oracle Read Replicas for Amazon RDS in the Amazon RDS User Guide. This setting is only supported in RDS for Oracle. Default: open-read-only Valid Values: open-read-only or mounted
SourceDbClusterIdentifier string
The identifier of the Multi-AZ DB cluster that will act as the source for the read replica. Each DB cluster can have up to 15 read replicas. Constraints:

  • Must be the identifier of an existing Multi-AZ DB cluster.
  • Can't be specified if the SourceDBInstanceIdentifier parameter is also specified.
  • The specified DB cluster must have automatic backups enabled, that is, its backup retention period must be greater than 0.
  • The source DB cluster must be in the same AWS-Region as the read replica. Cross-Region replication isn't supported.
StorageThroughput int
Specifies the storage throughput value, in mebibyte per second (MiBps), 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 string
The storage type to associate with the DB instance. If you specify io1, io2, or gp3, you must also include a value for the Iops parameter. This setting doesn't apply to Amazon Aurora DB instances. Storage is managed by the DB cluster. Valid Values: gp2 | gp3 | io1 | io2 | standard Default: io1, if the Iops parameter is specified. Otherwise, gp3.
Tags Tag
Tags to assign to the DB instance.
TdeCredentialArn string
VpcSecurityGroups []string

A list of the VPC security group IDs to assign to the DB instance. The list can include both the physical IDs of existing VPC security groups and references to AWS::EC2::SecurityGroup resources created in the template. If you plan to update the resource, don't specify VPC security groups in a shared VPC. If you set VPCSecurityGroups, you must not set DBSecurityGroups, and vice versa. You can migrate a DB instance in your stack from an RDS DB security group to a VPC security group, but keep the following in mind:

  • You can't revert to using an RDS security group after you establish a VPC security group membership.
  • When you migrate your DB instance to VPC security groups, if your stack update rolls back because the DB instance update fails or because an update fails in another AWS CloudFormation resource, the rollback fails because it can't revert to an RDS security group.
  • To use the properties that are available when you use a VPC security group, you must recreate the DB instance. If you don't, AWS CloudFormation submits only the property values that are listed in the DBSecurityGroups property.

To avoid this situation, migrate your DB instance to using VPC security groups only when that is the only change in your stack template. Amazon Aurora Not applicable. The associated list of EC2 VPC security groups is managed by the DB cluster. If specified, the setting must match the DB cluster setting.

allocatedStorage String

The amount of storage in gibibytes (GiB) to be initially allocated for the database instance. If any value is set in the Iops parameter, AllocatedStorage must be at least 100 GiB, which corresponds to the minimum Iops value of 1,000. If you increase the Iops value (in 1,000 IOPS increments), then you must also increase the AllocatedStorage value (in 100-GiB increments). 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. Db2 Constraints to the amount of storage for each storage type are the following:

  • General Purpose (SSD) storage (gp3): Must be an integer from 20 to 64000.
  • Provisioned IOPS storage (io1): Must be an integer from 100 to 64000.

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

  • General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536.
  • Provisioned IOPS storage (io1): Must be an integer from 100 to 65536.
  • Magnetic storage (standard): Must be an integer from 5 to 3072.

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

  • General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536.
  • Provisioned IOPS storage (io1): Must be an integer from 100 to 65536.
  • Magnetic storage (standard): Must be an integer from 5 to 3072.

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

  • General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536.
  • Provisioned IOPS storage (io1): Must be an integer from 100 to 65536.
  • Magnetic storage (standard): Must be an integer from 5 to 3072.

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

  • General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536.
  • Provisioned IOPS storage (io1): Must be an integer from 100 to 65536.
  • Magnetic storage (standard): Must be an integer from 10 to 3072.

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

  • General Purpose (SSD) storage (gp2):

  • Enterprise and Standard editions: Must be an integer from 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 20 to 16384.

  • Web and Express editions: Must be an integer from 20 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.

associatedRoles List<DbInstanceDbInstanceRole>
The IAMlong (IAM) roles associated with the DB instance. Amazon Aurora Not applicable. The associated roles are managed by the DB cluster.
autoMinorVersionUpgrade Boolean
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.
automaticBackupReplicationRegion String
The AWS-Region associated with the automated backup.
automaticBackupReplicationRetentionPeriod Integer
The retention period for automated backups in a different AWS Region. Use this parameter to set a unique retention period that only applies to cross-Region automated backups. To enable automated backups in a different Region, specify a positive value for the AutomaticBackupReplicationRegion parameter. If not specified, this parameter defaults to the value of the BackupRetentionPeriod parameter. The maximum allowed value is 35.
availabilityZone String

The Availability Zone (AZ) where the database will be created. For information on AWS-Regions and Availability Zones, see Regions and Availability Zones. For 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 AWS-Region. Constraints:

  • The AvailabilityZone parameter can't be specified if the DB instance is a Multi-AZ deployment.
  • The specified Availability Zone must be in the same AWS-Region as the current endpoint.

Example: us-east-1d

backupRetentionPeriod Integer
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
caCertificateIdentifier String
The identifier of the CA certificate for this DB instance. 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.
certificateDetails DbInstanceCertificateDetails
copyTagsToSnapshot Boolean
Specifies whether to copy tags from the DB instance to snapshots of the DB instance. By default, tags are not copied. This setting doesn't apply to Amazon Aurora DB instances. 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.
databaseInsightsMode String
The mode of Database Insights that is enabled for the instance.
dbClusterSnapshotIdentifier String
The identifier for the Multi-AZ DB cluster snapshot to restore from. For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide. Constraints:

  • Must match the identifier of an existing Multi-AZ DB cluster snapshot.
  • Can't be specified when DBSnapshotIdentifier is specified.
  • Must be specified when DBSnapshotIdentifier isn't specified.
  • If you are restoring from a shared manual Multi-AZ DB cluster snapshot, the DBClusterSnapshotIdentifier must be the ARN of the shared snapshot.
  • Can't be the identifier of an Aurora DB cluster snapshot.
dbInstanceArn String
The Amazon Resource Name (ARN) for the DB instance.
dbInstanceClass String
The compute and memory capacity of the DB instance, for example db.m5.large. Not all DB instance classes are available in all AWS-Regions, or for all database engines. For the full list of DB instance classes, and availability for your engine, see DB instance classes in the Amazon RDS User Guide or Aurora DB instance classes in the Amazon Aurora User Guide.
dbParameterGroupName String
The name of an existing DB parameter group or a reference to an AWS::RDS::DBParameterGroup resource created in the template. To list all of the available DB parameter group names, use the following command: aws rds describe-db-parameter-groups --query "DBParameterGroups[].DBParameterGroupName" --output text If any of the data members of the referenced parameter group are changed during an update, the DB instance might need to be restarted, which causes some interruption. If the parameter group contains static parameters, whether they were changed or not, an update triggers a reboot. If you don't specify a value for DBParameterGroupName property, the default DB parameter group for the specified engine and engine version is used.
dbSecurityGroups List<String>

A list of the DB security groups to assign to the DB instance. The list can include both the name of existing DB security groups or references to AWS::RDS::DBSecurityGroup resources created in the template. If you set DBSecurityGroups, you must not set VPCSecurityGroups, and vice versa. Also, note that the DBSecurityGroups property exists only for backwards compatibility with older regions and is no longer recommended for providing security information to an RDS DB instance. Instead, use VPCSecurityGroups. If you specify this property, AWS CloudFormation sends only the following properties (if specified) to Amazon RDS during create operations:

  • AllocatedStorage
  • AutoMinorVersionUpgrade
  • AvailabilityZone
  • BackupRetentionPeriod
  • CharacterSetName
  • DBInstanceClass
  • DBName
  • DBParameterGroupName
  • DBSecurityGroups
  • DBSubnetGroupName
  • Engine
  • EngineVersion
  • Iops
  • LicenseModel
  • MasterUsername
  • MasterUserPassword
  • MultiAZ
  • OptionGroupName
  • PreferredBackupWindow
  • PreferredMaintenanceWindow

All other properties are ignored. Specify a virtual private cloud (VPC) security group if you want to submit other properties, such as StorageType, StorageEncrypted, or KmsKeyId. If you're already using the DBSecurityGroups property, you can't use these other properties by updating your DB instance to use a VPC security group. You must recreate the DB instance.

dbiResourceId String
The AWS Region-unique, immutable identifier for the DB instance. This identifier is found in AWS CloudTrail log entries whenever the AWS KMS key for the DB instance is accessed.
dedicatedLogVolume Boolean
Indicates whether the DB instance has a dedicated log volume (DLV) enabled.
deletionProtection Boolean
Specifies 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. This setting doesn't apply to Amazon Aurora DB instances. 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 String
The Active Directory directory ID to create the DB instance in. Currently, only Db2, 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.
domainAuthSecretArn String
The ARN for the Secrets Manager secret with the credentials for the user joining the domain. Example: arn:aws:secretsmanager:region:account-number:secret:myselfmanagedADtestsecret-123456
domainDnsIps List<String>

The IPv4 DNS IP addresses of your primary and secondary Active Directory domain controllers. Constraints:

  • Two IP addresses must be provided. If there isn't a secondary domain controller, use the IP address of the primary domain controller for both entries in the list.

Example: 123.124.125.126,234.235.236.237

domainFqdn String

The fully qualified domain name (FQDN) of an Active Directory domain. Constraints:

  • Can't be longer than 64 characters.

Example: mymanagedADtest.mymanagedAD.mydomain

domainIamRoleName String
The name of the IAM role to use when making API calls to the Directory Service. This setting doesn't apply to the following DB instances:

  • Amazon Aurora (The domain is managed by the DB cluster.)
  • RDS Custom
domainOu String

The Active Directory organizational unit for your DB instance to join. Constraints:

  • Must be in the distinguished name format.
  • Can't be longer than 64 characters.

Example: OU=mymanagedADtestOU,DC=mymanagedADtest,DC=mymanagedAD,DC=mydomain

enableCloudwatchLogsExports List<String>
The list of log types that need to be enabled for exporting to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Relational Database Service User Guide. Amazon Aurora Not applicable. CloudWatch Logs exports are managed by the DB cluster. Db2 Valid values: diag.log, notify.log MariaDB Valid values: audit, error, general, slowquery Microsoft SQL Server Valid values: agent, error MySQL Valid values: audit, error, general, slowquery Oracle Valid values: alert, audit, listener, trace, oemagent PostgreSQL Valid values: postgresql, upgrade
enableIamDatabaseAuthentication Boolean
A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled. This property is supported for RDS for MariaDB, RDS for MySQL, and RDS for PostgreSQL. For more information, see IAM Database Authentication for MariaDB, MySQL, and PostgreSQL in the Amazon RDS User Guide. Amazon Aurora Not applicable. Mapping AWS IAM accounts to database accounts is managed by the DB cluster.
enablePerformanceInsights Boolean
Specifies 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 DB instances.
endpoint DbInstanceEndpoint
engine String
The name of the database engine to use for this DB instance. Not every database engine is available in every AWS Region. This property is required when creating a DB instance. You can convert an Oracle database from the non-CDB architecture to the container database (CDB) architecture by updating the Engine value in your templates from oracle-ee to oracle-ee-cdb or from oracle-se2 to oracle-se2-cdb. Converting to the CDB architecture requires an interruption. Valid Values:

  • aurora-mysql (for Aurora MySQL DB instances)
  • aurora-postgresql (for Aurora PostgreSQL DB instances)
  • custom-oracle-ee (for RDS Custom for Oracle DB instances)
  • custom-oracle-ee-cdb (for RDS Custom for Oracle DB instances)
  • custom-sqlserver-ee (for RDS Custom for SQL Server DB instances)
  • custom-sqlserver-se (for RDS Custom for SQL Server DB instances)
  • custom-sqlserver-web (for RDS Custom for SQL Server DB instances)
  • db2-ae
  • db2-se
  • mariadb
  • mysql
  • oracle-ee
  • oracle-ee-cdb
  • oracle-se2
  • oracle-se2-cdb
  • postgres
  • sqlserver-ee
  • sqlserver-se
  • sqlserver-ex
  • sqlserver-web
engineLifecycleSupport String
The life cycle type for this DB instance. By default, this value is set to open-source-rds-extended-support, which enrolls your DB instance into Amazon RDS Extended Support. At the end of standard support, you can avoid charges for Extended Support by setting the value to open-source-rds-extended-support-disabled. In this case, creating the DB instance will fail if the DB major version is past its end of standard support date. This setting applies only to RDS for MySQL and RDS for PostgreSQL. For Amazon Aurora DB instances, the life cycle type is managed by the DB cluster. You can use this setting to enroll your DB instance into Amazon RDS Extended Support. With RDS Extended Support, you can run the selected major engine version on your DB instance past the end of standard support for that engine version. For more information, see Using Amazon RDS Extended Support in the Amazon RDS User Guide. Valid Values: open-source-rds-extended-support | open-source-rds-extended-support-disabled Default: open-source-rds-extended-support
engineVersion String
The version number of the database engine to use. For a list of valid engine versions, use the DescribeDBEngineVersions action. The following are the database engines and links to information about the major and minor versions that are available with Amazon RDS. Not every database engine is available for every AWS Region. Amazon Aurora Not applicable. The version number of the database engine to be used by the DB instance is managed by the DB cluster. Db2 See Amazon RDS for Db2 in the Amazon RDS User Guide. MariaDB See MariaDB on Amazon RDS Versions in the Amazon RDS User Guide. Microsoft SQL Server See Microsoft SQL Server Versions on Amazon RDS in the Amazon RDS User Guide. MySQL See MySQL on Amazon RDS Versions in the Amazon RDS User Guide. Oracle See Oracle Database Engine Release Notes in the Amazon RDS User Guide. PostgreSQL See Supported PostgreSQL Database Versions in the Amazon RDS User Guide.
iops Integer
The number of I/O operations per second (IOPS) that the database provisions. The value must be equal to or greater than 1000. If you specify this property, you must follow the range of allowed ratios of your requested IOPS rate to the amount of storage that you allocate (IOPS to allocated storage). For example, you can provision an Oracle database instance with 1000 IOPS and 200 GiB of storage (a ratio of 5:1), or specify 2000 IOPS with 200 GiB of storage (a ratio of 10:1). For more information, see Amazon RDS Provisioned IOPS Storage to Improve Performance in the Amazon RDS User Guide. If you specify io1 for the StorageType property, then you must also specify the Iops property. Constraints:

  • For RDS for Db2, MariaDB, MySQL, Oracle, and PostgreSQL - Must be a multiple between .5 and 50 of the storage amount for the DB instance.
  • For RDS for SQL Server - Must be a multiple between 1 and 50 of the storage amount for the DB instance.
licenseModel String

License model information for this DB instance. Valid Values:

  • Aurora MySQL - general-public-license
  • Aurora PostgreSQL - postgresql-license
  • RDS for Db2 - bring-your-own-license. For more information about RDS for Db2 licensing, see in the Amazon RDS User Guide.
  • RDS for MariaDB - general-public-license
  • RDS for Microsoft SQL Server - license-included
  • RDS for MySQL - general-public-license
  • RDS for Oracle - bring-your-own-license or license-included
  • RDS for PostgreSQL - postgresql-license

If you've specified DBSecurityGroups and then you update the license model, AWS CloudFormation replaces the underlying DB instance. This will incur some interruptions to database availability.

manageMasterUserPassword Boolean
Specifies whether to manage the master user password with AWS Secrets Manager. For more information, see Password management with Secrets Manager in the Amazon RDS User Guide. Constraints:

  • Can't manage the master user password with AWS Secrets Manager if MasterUserPassword is specified.
masterUserSecret DbInstanceMasterUserSecret
The secret managed by RDS in AWS Secrets Manager for the master user password. For more information, see Password management with Secrets Manager in the Amazon RDS User Guide.
maxAllocatedStorage Integer
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 the following DB instances:

  • Amazon Aurora (Storage is managed by the DB cluster.)
  • RDS Custom
monitoringInterval Integer
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. If MonitoringRoleArn is specified, then you must set MonitoringInterval to a value other than 0. This setting doesn't apply to RDS Custom DB instances. Valid Values: 0 | 1 | 5 | 10 | 15 | 30 | 60 Default: 0
monitoringRoleArn String
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 DB instances.
multiAz Boolean
Specifies 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 the following DB instances:

  • Amazon Aurora (DB instance Availability Zones (AZs) are managed by the DB cluster.)
  • RDS Custom
networkType String

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 IPv6 protocols (DUAL). For more information, see Working with a DB instance in a VPC in the Amazon RDS User Guide.

optionGroupName String
Indicates that the DB instance should be associated with the specified option group. Permanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed from an option group. Also, that option group can't be removed from a DB instance once it is associated with a DB instance.
performanceInsightsKmsKeyId String
The AWS KMS key identifier for encryption of Performance Insights data. The 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 AWS account. Your AWS account has a different default KMS key for each AWS Region. For information about enabling Performance Insights, see EnablePerformanceInsights.
performanceInsightsRetentionPeriod Integer

The number of days to retain Performance Insights data. When creating a DB instance without enabling Performance Insights, you can't specify the parameter PerformanceInsightsRetentionPeriod. This setting doesn't apply to RDS Custom DB instances. Valid Values:

  • 7
  • month * 31, where month is a number of months from 1-23. Examples: 93 (3 months * 31), 341 (11 months * 31), 589 (19 months * 31)
  • 731

Default: 7 days If you specify a retention period that isn't valid, such as 94, Amazon RDS returns an error.

port String

The port number on which the database accepts connections. This setting doesn't apply to Aurora DB instances. The port number is managed by the cluster. Valid Values: 1150-65535 Default:

  • RDS for Db2 - 50000
  • RDS for MariaDB - 3306
  • RDS for Microsoft SQL Server - 1433
  • RDS for MySQL - 3306
  • RDS for Oracle - 1521
  • RDS for PostgreSQL - 5432

Constraints:

  • For RDS for Microsoft SQL Server, the value can't be 1234, 1434, 3260, 3343, 3389, 47001, or 49152-49156.
preferredBackupWindow String

The daily time range during which automated backups are created if automated backups are enabled, using the BackupRetentionPeriod parameter. For more information, see Backup Window in the Amazon RDS User Guide. Constraints:

  • Must be in the format hh24:mi-hh24:mi.
  • Must be in Universal Coordinated Time (UTC).
  • Must not conflict with the preferred maintenance window.
  • Must be at least 30 minutes.

Amazon Aurora Not applicable. The daily time range for creating automated backups is managed by the DB cluster.

preferredMaintenanceWindow String
The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC). Format: ddd:hh24:mi-ddd:hh24:mi The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region, occurring on a random day of the week. To see the time blocks available, see Maintaining a DB instance in the Amazon RDS User Guide. This property applies when AWS CloudFormation initially creates the DB instance. If you use AWS CloudFormation to update the DB instance, those updates are applied immediately. Constraints: Minimum 30-minute window.
processorFeatures List<DbInstanceProcessorFeature>
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 Amazon Aurora or RDS Custom DB instances.
promotionTier Integer
The order of priority 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 DB instances. Default: 1 Valid Values: 0 - 15
publiclyAccessible Boolean
Indicates whether the DB instance is an internet-facing instance. If you specify true, AWS CloudFormation creates an instance with a publicly resolvable DNS name, which resolves to a public IP address. If you specify false, AWS CloudFormation creates an internal instance with a DNS name that resolves to a private IP address. The default behavior value depends on your VPC setup and the database subnet group. For more information, see the PubliclyAccessible parameter in the CreateDBInstance in the Amazon RDS API Reference.
replicaMode String
The open mode of an Oracle read replica. For more information, see Working with Oracle Read Replicas for Amazon RDS in the Amazon RDS User Guide. This setting is only supported in RDS for Oracle. Default: open-read-only Valid Values: open-read-only or mounted
sourceDbClusterIdentifier String
The identifier of the Multi-AZ DB cluster that will act as the source for the read replica. Each DB cluster can have up to 15 read replicas. Constraints:

  • Must be the identifier of an existing Multi-AZ DB cluster.
  • Can't be specified if the SourceDBInstanceIdentifier parameter is also specified.
  • The specified DB cluster must have automatic backups enabled, that is, its backup retention period must be greater than 0.
  • The source DB cluster must be in the same AWS-Region as the read replica. Cross-Region replication isn't supported.
storageThroughput Integer
Specifies the storage throughput value, in mebibyte per second (MiBps), 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 String
The storage type to associate with the DB instance. If you specify io1, io2, or gp3, you must also include a value for the Iops parameter. This setting doesn't apply to Amazon Aurora DB instances. Storage is managed by the DB cluster. Valid Values: gp2 | gp3 | io1 | io2 | standard Default: io1, if the Iops parameter is specified. Otherwise, gp3.
tags List<Tag>
Tags to assign to the DB instance.
tdeCredentialArn String
vpcSecurityGroups List<String>

A list of the VPC security group IDs to assign to the DB instance. The list can include both the physical IDs of existing VPC security groups and references to AWS::EC2::SecurityGroup resources created in the template. If you plan to update the resource, don't specify VPC security groups in a shared VPC. If you set VPCSecurityGroups, you must not set DBSecurityGroups, and vice versa. You can migrate a DB instance in your stack from an RDS DB security group to a VPC security group, but keep the following in mind:

  • You can't revert to using an RDS security group after you establish a VPC security group membership.
  • When you migrate your DB instance to VPC security groups, if your stack update rolls back because the DB instance update fails or because an update fails in another AWS CloudFormation resource, the rollback fails because it can't revert to an RDS security group.
  • To use the properties that are available when you use a VPC security group, you must recreate the DB instance. If you don't, AWS CloudFormation submits only the property values that are listed in the DBSecurityGroups property.

To avoid this situation, migrate your DB instance to using VPC security groups only when that is the only change in your stack template. Amazon Aurora Not applicable. The associated list of EC2 VPC security groups is managed by the DB cluster. If specified, the setting must match the DB cluster setting.

allocatedStorage string

The amount of storage in gibibytes (GiB) to be initially allocated for the database instance. If any value is set in the Iops parameter, AllocatedStorage must be at least 100 GiB, which corresponds to the minimum Iops value of 1,000. If you increase the Iops value (in 1,000 IOPS increments), then you must also increase the AllocatedStorage value (in 100-GiB increments). 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. Db2 Constraints to the amount of storage for each storage type are the following:

  • General Purpose (SSD) storage (gp3): Must be an integer from 20 to 64000.
  • Provisioned IOPS storage (io1): Must be an integer from 100 to 64000.

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

  • General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536.
  • Provisioned IOPS storage (io1): Must be an integer from 100 to 65536.
  • Magnetic storage (standard): Must be an integer from 5 to 3072.

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

  • General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536.
  • Provisioned IOPS storage (io1): Must be an integer from 100 to 65536.
  • Magnetic storage (standard): Must be an integer from 5 to 3072.

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

  • General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536.
  • Provisioned IOPS storage (io1): Must be an integer from 100 to 65536.
  • Magnetic storage (standard): Must be an integer from 5 to 3072.

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

  • General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536.
  • Provisioned IOPS storage (io1): Must be an integer from 100 to 65536.
  • Magnetic storage (standard): Must be an integer from 10 to 3072.

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

  • General Purpose (SSD) storage (gp2):

  • Enterprise and Standard editions: Must be an integer from 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 20 to 16384.

  • Web and Express editions: Must be an integer from 20 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.

associatedRoles DbInstanceDbInstanceRole[]
The IAMlong (IAM) roles associated with the DB instance. Amazon Aurora Not applicable. The associated roles are managed by the DB cluster.
autoMinorVersionUpgrade boolean
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.
automaticBackupReplicationRegion string
The AWS-Region associated with the automated backup.
automaticBackupReplicationRetentionPeriod number
The retention period for automated backups in a different AWS Region. Use this parameter to set a unique retention period that only applies to cross-Region automated backups. To enable automated backups in a different Region, specify a positive value for the AutomaticBackupReplicationRegion parameter. If not specified, this parameter defaults to the value of the BackupRetentionPeriod parameter. The maximum allowed value is 35.
availabilityZone string

The Availability Zone (AZ) where the database will be created. For information on AWS-Regions and Availability Zones, see Regions and Availability Zones. For 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 AWS-Region. Constraints:

  • The AvailabilityZone parameter can't be specified if the DB instance is a Multi-AZ deployment.
  • The specified Availability Zone must be in the same AWS-Region as the current endpoint.

Example: us-east-1d

backupRetentionPeriod number
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
caCertificateIdentifier string
The identifier of the CA certificate for this DB instance. 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.
certificateDetails DbInstanceCertificateDetails
copyTagsToSnapshot boolean
Specifies whether to copy tags from the DB instance to snapshots of the DB instance. By default, tags are not copied. This setting doesn't apply to Amazon Aurora DB instances. 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.
databaseInsightsMode string
The mode of Database Insights that is enabled for the instance.
dbClusterSnapshotIdentifier string
The identifier for the Multi-AZ DB cluster snapshot to restore from. For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide. Constraints:

  • Must match the identifier of an existing Multi-AZ DB cluster snapshot.
  • Can't be specified when DBSnapshotIdentifier is specified.
  • Must be specified when DBSnapshotIdentifier isn't specified.
  • If you are restoring from a shared manual Multi-AZ DB cluster snapshot, the DBClusterSnapshotIdentifier must be the ARN of the shared snapshot.
  • Can't be the identifier of an Aurora DB cluster snapshot.
dbInstanceArn string
The Amazon Resource Name (ARN) for the DB instance.
dbInstanceClass string
The compute and memory capacity of the DB instance, for example db.m5.large. Not all DB instance classes are available in all AWS-Regions, or for all database engines. For the full list of DB instance classes, and availability for your engine, see DB instance classes in the Amazon RDS User Guide or Aurora DB instance classes in the Amazon Aurora User Guide.
dbParameterGroupName string
The name of an existing DB parameter group or a reference to an AWS::RDS::DBParameterGroup resource created in the template. To list all of the available DB parameter group names, use the following command: aws rds describe-db-parameter-groups --query "DBParameterGroups[].DBParameterGroupName" --output text If any of the data members of the referenced parameter group are changed during an update, the DB instance might need to be restarted, which causes some interruption. If the parameter group contains static parameters, whether they were changed or not, an update triggers a reboot. If you don't specify a value for DBParameterGroupName property, the default DB parameter group for the specified engine and engine version is used.
dbSecurityGroups string[]

A list of the DB security groups to assign to the DB instance. The list can include both the name of existing DB security groups or references to AWS::RDS::DBSecurityGroup resources created in the template. If you set DBSecurityGroups, you must not set VPCSecurityGroups, and vice versa. Also, note that the DBSecurityGroups property exists only for backwards compatibility with older regions and is no longer recommended for providing security information to an RDS DB instance. Instead, use VPCSecurityGroups. If you specify this property, AWS CloudFormation sends only the following properties (if specified) to Amazon RDS during create operations:

  • AllocatedStorage
  • AutoMinorVersionUpgrade
  • AvailabilityZone
  • BackupRetentionPeriod
  • CharacterSetName
  • DBInstanceClass
  • DBName
  • DBParameterGroupName
  • DBSecurityGroups
  • DBSubnetGroupName
  • Engine
  • EngineVersion
  • Iops
  • LicenseModel
  • MasterUsername
  • MasterUserPassword
  • MultiAZ
  • OptionGroupName
  • PreferredBackupWindow
  • PreferredMaintenanceWindow

All other properties are ignored. Specify a virtual private cloud (VPC) security group if you want to submit other properties, such as StorageType, StorageEncrypted, or KmsKeyId. If you're already using the DBSecurityGroups property, you can't use these other properties by updating your DB instance to use a VPC security group. You must recreate the DB instance.

dbiResourceId string
The AWS Region-unique, immutable identifier for the DB instance. This identifier is found in AWS CloudTrail log entries whenever the AWS KMS key for the DB instance is accessed.
dedicatedLogVolume boolean
Indicates whether the DB instance has a dedicated log volume (DLV) enabled.
deletionProtection boolean
Specifies 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. This setting doesn't apply to Amazon Aurora DB instances. 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 string
The Active Directory directory ID to create the DB instance in. Currently, only Db2, 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.
domainAuthSecretArn string
The ARN for the Secrets Manager secret with the credentials for the user joining the domain. Example: arn:aws:secretsmanager:region:account-number:secret:myselfmanagedADtestsecret-123456
domainDnsIps string[]

The IPv4 DNS IP addresses of your primary and secondary Active Directory domain controllers. Constraints:

  • Two IP addresses must be provided. If there isn't a secondary domain controller, use the IP address of the primary domain controller for both entries in the list.

Example: 123.124.125.126,234.235.236.237

domainFqdn string

The fully qualified domain name (FQDN) of an Active Directory domain. Constraints:

  • Can't be longer than 64 characters.

Example: mymanagedADtest.mymanagedAD.mydomain

domainIamRoleName string
The name of the IAM role to use when making API calls to the Directory Service. This setting doesn't apply to the following DB instances:

  • Amazon Aurora (The domain is managed by the DB cluster.)
  • RDS Custom
domainOu string

The Active Directory organizational unit for your DB instance to join. Constraints:

  • Must be in the distinguished name format.
  • Can't be longer than 64 characters.

Example: OU=mymanagedADtestOU,DC=mymanagedADtest,DC=mymanagedAD,DC=mydomain

enableCloudwatchLogsExports string[]
The list of log types that need to be enabled for exporting to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Relational Database Service User Guide. Amazon Aurora Not applicable. CloudWatch Logs exports are managed by the DB cluster. Db2 Valid values: diag.log, notify.log MariaDB Valid values: audit, error, general, slowquery Microsoft SQL Server Valid values: agent, error MySQL Valid values: audit, error, general, slowquery Oracle Valid values: alert, audit, listener, trace, oemagent PostgreSQL Valid values: postgresql, upgrade
enableIamDatabaseAuthentication boolean
A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled. This property is supported for RDS for MariaDB, RDS for MySQL, and RDS for PostgreSQL. For more information, see IAM Database Authentication for MariaDB, MySQL, and PostgreSQL in the Amazon RDS User Guide. Amazon Aurora Not applicable. Mapping AWS IAM accounts to database accounts is managed by the DB cluster.
enablePerformanceInsights boolean
Specifies 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 DB instances.
endpoint DbInstanceEndpoint
engine string
The name of the database engine to use for this DB instance. Not every database engine is available in every AWS Region. This property is required when creating a DB instance. You can convert an Oracle database from the non-CDB architecture to the container database (CDB) architecture by updating the Engine value in your templates from oracle-ee to oracle-ee-cdb or from oracle-se2 to oracle-se2-cdb. Converting to the CDB architecture requires an interruption. Valid Values:

  • aurora-mysql (for Aurora MySQL DB instances)
  • aurora-postgresql (for Aurora PostgreSQL DB instances)
  • custom-oracle-ee (for RDS Custom for Oracle DB instances)
  • custom-oracle-ee-cdb (for RDS Custom for Oracle DB instances)
  • custom-sqlserver-ee (for RDS Custom for SQL Server DB instances)
  • custom-sqlserver-se (for RDS Custom for SQL Server DB instances)
  • custom-sqlserver-web (for RDS Custom for SQL Server DB instances)
  • db2-ae
  • db2-se
  • mariadb
  • mysql
  • oracle-ee
  • oracle-ee-cdb
  • oracle-se2
  • oracle-se2-cdb
  • postgres
  • sqlserver-ee
  • sqlserver-se
  • sqlserver-ex
  • sqlserver-web
engineLifecycleSupport string
The life cycle type for this DB instance. By default, this value is set to open-source-rds-extended-support, which enrolls your DB instance into Amazon RDS Extended Support. At the end of standard support, you can avoid charges for Extended Support by setting the value to open-source-rds-extended-support-disabled. In this case, creating the DB instance will fail if the DB major version is past its end of standard support date. This setting applies only to RDS for MySQL and RDS for PostgreSQL. For Amazon Aurora DB instances, the life cycle type is managed by the DB cluster. You can use this setting to enroll your DB instance into Amazon RDS Extended Support. With RDS Extended Support, you can run the selected major engine version on your DB instance past the end of standard support for that engine version. For more information, see Using Amazon RDS Extended Support in the Amazon RDS User Guide. Valid Values: open-source-rds-extended-support | open-source-rds-extended-support-disabled Default: open-source-rds-extended-support
engineVersion string
The version number of the database engine to use. For a list of valid engine versions, use the DescribeDBEngineVersions action. The following are the database engines and links to information about the major and minor versions that are available with Amazon RDS. Not every database engine is available for every AWS Region. Amazon Aurora Not applicable. The version number of the database engine to be used by the DB instance is managed by the DB cluster. Db2 See Amazon RDS for Db2 in the Amazon RDS User Guide. MariaDB See MariaDB on Amazon RDS Versions in the Amazon RDS User Guide. Microsoft SQL Server See Microsoft SQL Server Versions on Amazon RDS in the Amazon RDS User Guide. MySQL See MySQL on Amazon RDS Versions in the Amazon RDS User Guide. Oracle See Oracle Database Engine Release Notes in the Amazon RDS User Guide. PostgreSQL See Supported PostgreSQL Database Versions in the Amazon RDS User Guide.
iops number
The number of I/O operations per second (IOPS) that the database provisions. The value must be equal to or greater than 1000. If you specify this property, you must follow the range of allowed ratios of your requested IOPS rate to the amount of storage that you allocate (IOPS to allocated storage). For example, you can provision an Oracle database instance with 1000 IOPS and 200 GiB of storage (a ratio of 5:1), or specify 2000 IOPS with 200 GiB of storage (a ratio of 10:1). For more information, see Amazon RDS Provisioned IOPS Storage to Improve Performance in the Amazon RDS User Guide. If you specify io1 for the StorageType property, then you must also specify the Iops property. Constraints:

  • For RDS for Db2, MariaDB, MySQL, Oracle, and PostgreSQL - Must be a multiple between .5 and 50 of the storage amount for the DB instance.
  • For RDS for SQL Server - Must be a multiple between 1 and 50 of the storage amount for the DB instance.
licenseModel string

License model information for this DB instance. Valid Values:

  • Aurora MySQL - general-public-license
  • Aurora PostgreSQL - postgresql-license
  • RDS for Db2 - bring-your-own-license. For more information about RDS for Db2 licensing, see in the Amazon RDS User Guide.
  • RDS for MariaDB - general-public-license
  • RDS for Microsoft SQL Server - license-included
  • RDS for MySQL - general-public-license
  • RDS for Oracle - bring-your-own-license or license-included
  • RDS for PostgreSQL - postgresql-license

If you've specified DBSecurityGroups and then you update the license model, AWS CloudFormation replaces the underlying DB instance. This will incur some interruptions to database availability.

manageMasterUserPassword boolean
Specifies whether to manage the master user password with AWS Secrets Manager. For more information, see Password management with Secrets Manager in the Amazon RDS User Guide. Constraints:

  • Can't manage the master user password with AWS Secrets Manager if MasterUserPassword is specified.
masterUserSecret DbInstanceMasterUserSecret
The secret managed by RDS in AWS Secrets Manager for the master user password. For more information, see Password management with Secrets Manager in the Amazon RDS User Guide.
maxAllocatedStorage number
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 the following DB instances:

  • Amazon Aurora (Storage is managed by the DB cluster.)
  • RDS Custom
monitoringInterval number
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. If MonitoringRoleArn is specified, then you must set MonitoringInterval to a value other than 0. This setting doesn't apply to RDS Custom DB instances. Valid Values: 0 | 1 | 5 | 10 | 15 | 30 | 60 Default: 0
monitoringRoleArn string
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 DB instances.
multiAz boolean
Specifies 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 the following DB instances:

  • Amazon Aurora (DB instance Availability Zones (AZs) are managed by the DB cluster.)
  • RDS Custom
networkType string

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 IPv6 protocols (DUAL). For more information, see Working with a DB instance in a VPC in the Amazon RDS User Guide.

optionGroupName string
Indicates that the DB instance should be associated with the specified option group. Permanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed from an option group. Also, that option group can't be removed from a DB instance once it is associated with a DB instance.
performanceInsightsKmsKeyId string
The AWS KMS key identifier for encryption of Performance Insights data. The 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 AWS account. Your AWS account has a different default KMS key for each AWS Region. For information about enabling Performance Insights, see EnablePerformanceInsights.
performanceInsightsRetentionPeriod number

The number of days to retain Performance Insights data. When creating a DB instance without enabling Performance Insights, you can't specify the parameter PerformanceInsightsRetentionPeriod. This setting doesn't apply to RDS Custom DB instances. Valid Values:

  • 7
  • month * 31, where month is a number of months from 1-23. Examples: 93 (3 months * 31), 341 (11 months * 31), 589 (19 months * 31)
  • 731

Default: 7 days If you specify a retention period that isn't valid, such as 94, Amazon RDS returns an error.

port string

The port number on which the database accepts connections. This setting doesn't apply to Aurora DB instances. The port number is managed by the cluster. Valid Values: 1150-65535 Default:

  • RDS for Db2 - 50000
  • RDS for MariaDB - 3306
  • RDS for Microsoft SQL Server - 1433
  • RDS for MySQL - 3306
  • RDS for Oracle - 1521
  • RDS for PostgreSQL - 5432

Constraints:

  • For RDS for Microsoft SQL Server, the value can't be 1234, 1434, 3260, 3343, 3389, 47001, or 49152-49156.
preferredBackupWindow string

The daily time range during which automated backups are created if automated backups are enabled, using the BackupRetentionPeriod parameter. For more information, see Backup Window in the Amazon RDS User Guide. Constraints:

  • Must be in the format hh24:mi-hh24:mi.
  • Must be in Universal Coordinated Time (UTC).
  • Must not conflict with the preferred maintenance window.
  • Must be at least 30 minutes.

Amazon Aurora Not applicable. The daily time range for creating automated backups is managed by the DB cluster.

preferredMaintenanceWindow string
The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC). Format: ddd:hh24:mi-ddd:hh24:mi The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region, occurring on a random day of the week. To see the time blocks available, see Maintaining a DB instance in the Amazon RDS User Guide. This property applies when AWS CloudFormation initially creates the DB instance. If you use AWS CloudFormation to update the DB instance, those updates are applied immediately. Constraints: Minimum 30-minute window.
processorFeatures DbInstanceProcessorFeature[]
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 Amazon Aurora or RDS Custom DB instances.
promotionTier number
The order of priority 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 DB instances. Default: 1 Valid Values: 0 - 15
publiclyAccessible boolean
Indicates whether the DB instance is an internet-facing instance. If you specify true, AWS CloudFormation creates an instance with a publicly resolvable DNS name, which resolves to a public IP address. If you specify false, AWS CloudFormation creates an internal instance with a DNS name that resolves to a private IP address. The default behavior value depends on your VPC setup and the database subnet group. For more information, see the PubliclyAccessible parameter in the CreateDBInstance in the Amazon RDS API Reference.
replicaMode string
The open mode of an Oracle read replica. For more information, see Working with Oracle Read Replicas for Amazon RDS in the Amazon RDS User Guide. This setting is only supported in RDS for Oracle. Default: open-read-only Valid Values: open-read-only or mounted
sourceDbClusterIdentifier string
The identifier of the Multi-AZ DB cluster that will act as the source for the read replica. Each DB cluster can have up to 15 read replicas. Constraints:

  • Must be the identifier of an existing Multi-AZ DB cluster.
  • Can't be specified if the SourceDBInstanceIdentifier parameter is also specified.
  • The specified DB cluster must have automatic backups enabled, that is, its backup retention period must be greater than 0.
  • The source DB cluster must be in the same AWS-Region as the read replica. Cross-Region replication isn't supported.
storageThroughput number
Specifies the storage throughput value, in mebibyte per second (MiBps), 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 string
The storage type to associate with the DB instance. If you specify io1, io2, or gp3, you must also include a value for the Iops parameter. This setting doesn't apply to Amazon Aurora DB instances. Storage is managed by the DB cluster. Valid Values: gp2 | gp3 | io1 | io2 | standard Default: io1, if the Iops parameter is specified. Otherwise, gp3.
tags Tag[]
Tags to assign to the DB instance.
tdeCredentialArn string
vpcSecurityGroups string[]

A list of the VPC security group IDs to assign to the DB instance. The list can include both the physical IDs of existing VPC security groups and references to AWS::EC2::SecurityGroup resources created in the template. If you plan to update the resource, don't specify VPC security groups in a shared VPC. If you set VPCSecurityGroups, you must not set DBSecurityGroups, and vice versa. You can migrate a DB instance in your stack from an RDS DB security group to a VPC security group, but keep the following in mind:

  • You can't revert to using an RDS security group after you establish a VPC security group membership.
  • When you migrate your DB instance to VPC security groups, if your stack update rolls back because the DB instance update fails or because an update fails in another AWS CloudFormation resource, the rollback fails because it can't revert to an RDS security group.
  • To use the properties that are available when you use a VPC security group, you must recreate the DB instance. If you don't, AWS CloudFormation submits only the property values that are listed in the DBSecurityGroups property.

To avoid this situation, migrate your DB instance to using VPC security groups only when that is the only change in your stack template. Amazon Aurora Not applicable. The associated list of EC2 VPC security groups is managed by the DB cluster. If specified, the setting must match the DB cluster setting.

allocated_storage str

The amount of storage in gibibytes (GiB) to be initially allocated for the database instance. If any value is set in the Iops parameter, AllocatedStorage must be at least 100 GiB, which corresponds to the minimum Iops value of 1,000. If you increase the Iops value (in 1,000 IOPS increments), then you must also increase the AllocatedStorage value (in 100-GiB increments). 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. Db2 Constraints to the amount of storage for each storage type are the following:

  • General Purpose (SSD) storage (gp3): Must be an integer from 20 to 64000.
  • Provisioned IOPS storage (io1): Must be an integer from 100 to 64000.

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

  • General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536.
  • Provisioned IOPS storage (io1): Must be an integer from 100 to 65536.
  • Magnetic storage (standard): Must be an integer from 5 to 3072.

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

  • General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536.
  • Provisioned IOPS storage (io1): Must be an integer from 100 to 65536.
  • Magnetic storage (standard): Must be an integer from 5 to 3072.

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

  • General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536.
  • Provisioned IOPS storage (io1): Must be an integer from 100 to 65536.
  • Magnetic storage (standard): Must be an integer from 5 to 3072.

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

  • General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536.
  • Provisioned IOPS storage (io1): Must be an integer from 100 to 65536.
  • Magnetic storage (standard): Must be an integer from 10 to 3072.

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

  • General Purpose (SSD) storage (gp2):

  • Enterprise and Standard editions: Must be an integer from 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 20 to 16384.

  • Web and Express editions: Must be an integer from 20 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.

associated_roles Sequence[DbInstanceDbInstanceRole]
The IAMlong (IAM) roles associated with the DB instance. Amazon Aurora Not applicable. The associated roles are managed by the DB cluster.
auto_minor_version_upgrade 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.
automatic_backup_replication_region str
The AWS-Region associated with the automated backup.
automatic_backup_replication_retention_period int
The retention period for automated backups in a different AWS Region. Use this parameter to set a unique retention period that only applies to cross-Region automated backups. To enable automated backups in a different Region, specify a positive value for the AutomaticBackupReplicationRegion parameter. If not specified, this parameter defaults to the value of the BackupRetentionPeriod parameter. The maximum allowed value is 35.
availability_zone str

The Availability Zone (AZ) where the database will be created. For information on AWS-Regions and Availability Zones, see Regions and Availability Zones. For 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 AWS-Region. Constraints:

  • The AvailabilityZone parameter can't be specified if the DB instance is a Multi-AZ deployment.
  • The specified Availability Zone must be in the same AWS-Region as the current endpoint.

Example: us-east-1d

backup_retention_period 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
ca_certificate_identifier str
The identifier of the CA certificate for this DB instance. 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.
certificate_details DbInstanceCertificateDetails
copy_tags_to_snapshot bool
Specifies whether to copy tags from the DB instance to snapshots of the DB instance. By default, tags are not copied. This setting doesn't apply to Amazon Aurora DB instances. 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.
database_insights_mode str
The mode of Database Insights that is enabled for the instance.
db_cluster_snapshot_identifier str
The identifier for the Multi-AZ DB cluster snapshot to restore from. For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide. Constraints:

  • Must match the identifier of an existing Multi-AZ DB cluster snapshot.
  • Can't be specified when DBSnapshotIdentifier is specified.
  • Must be specified when DBSnapshotIdentifier isn't specified.
  • If you are restoring from a shared manual Multi-AZ DB cluster snapshot, the DBClusterSnapshotIdentifier must be the ARN of the shared snapshot.
  • Can't be the identifier of an Aurora DB cluster snapshot.
db_instance_arn str
The Amazon Resource Name (ARN) for the DB instance.
db_instance_class str
The compute and memory capacity of the DB instance, for example db.m5.large. Not all DB instance classes are available in all AWS-Regions, or for all database engines. For the full list of DB instance classes, and availability for your engine, see DB instance classes in the Amazon RDS User Guide or Aurora DB instance classes in the Amazon Aurora User Guide.
db_parameter_group_name str
The name of an existing DB parameter group or a reference to an AWS::RDS::DBParameterGroup resource created in the template. To list all of the available DB parameter group names, use the following command: aws rds describe-db-parameter-groups --query "DBParameterGroups[].DBParameterGroupName" --output text If any of the data members of the referenced parameter group are changed during an update, the DB instance might need to be restarted, which causes some interruption. If the parameter group contains static parameters, whether they were changed or not, an update triggers a reboot. If you don't specify a value for DBParameterGroupName property, the default DB parameter group for the specified engine and engine version is used.
db_security_groups Sequence[str]

A list of the DB security groups to assign to the DB instance. The list can include both the name of existing DB security groups or references to AWS::RDS::DBSecurityGroup resources created in the template. If you set DBSecurityGroups, you must not set VPCSecurityGroups, and vice versa. Also, note that the DBSecurityGroups property exists only for backwards compatibility with older regions and is no longer recommended for providing security information to an RDS DB instance. Instead, use VPCSecurityGroups. If you specify this property, AWS CloudFormation sends only the following properties (if specified) to Amazon RDS during create operations:

  • AllocatedStorage
  • AutoMinorVersionUpgrade
  • AvailabilityZone
  • BackupRetentionPeriod
  • CharacterSetName
  • DBInstanceClass
  • DBName
  • DBParameterGroupName
  • DBSecurityGroups
  • DBSubnetGroupName
  • Engine
  • EngineVersion
  • Iops
  • LicenseModel
  • MasterUsername
  • MasterUserPassword
  • MultiAZ
  • OptionGroupName
  • PreferredBackupWindow
  • PreferredMaintenanceWindow

All other properties are ignored. Specify a virtual private cloud (VPC) security group if you want to submit other properties, such as StorageType, StorageEncrypted, or KmsKeyId. If you're already using the DBSecurityGroups property, you can't use these other properties by updating your DB instance to use a VPC security group. You must recreate the DB instance.

dbi_resource_id str
The AWS Region-unique, immutable identifier for the DB instance. This identifier is found in AWS CloudTrail log entries whenever the AWS KMS key for the DB instance is accessed.
dedicated_log_volume bool
Indicates whether the DB instance has a dedicated log volume (DLV) enabled.
deletion_protection bool
Specifies 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. This setting doesn't apply to Amazon Aurora DB instances. 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 str
The Active Directory directory ID to create the DB instance in. Currently, only Db2, MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB instances can be created in an Active Directory Domain. For more information, see Kerberos Authentication in the Amazon RDS User Guide.
domain_auth_secret_arn str
The ARN for the Secrets Manager secret with the credentials for the user joining the domain. Example: arn:aws:secretsmanager:region:account-number:secret:myselfmanagedADtestsecret-123456
domain_dns_ips Sequence[str]

The IPv4 DNS IP addresses of your primary and secondary Active Directory domain controllers. Constraints:

  • Two IP addresses must be provided. If there isn't a secondary domain controller, use the IP address of the primary domain controller for both entries in the list.

Example: 123.124.125.126,234.235.236.237

domain_fqdn str

The fully qualified domain name (FQDN) of an Active Directory domain. Constraints:

  • Can't be longer than 64 characters.

Example: mymanagedADtest.mymanagedAD.mydomain

domain_iam_role_name str
The name of the IAM role to use when making API calls to the Directory Service. This setting doesn't apply to the following DB instances:

  • Amazon Aurora (The domain is managed by the DB cluster.)
  • RDS Custom
domain_ou str

The Active Directory organizational unit for your DB instance to join. Constraints:

  • Must be in the distinguished name format.
  • Can't be longer than 64 characters.

Example: OU=mymanagedADtestOU,DC=mymanagedADtest,DC=mymanagedAD,DC=mydomain

enable_cloudwatch_logs_exports Sequence[str]
The list of log types that need to be enabled for exporting to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Relational Database Service User Guide. Amazon Aurora Not applicable. CloudWatch Logs exports are managed by the DB cluster. Db2 Valid values: diag.log, notify.log MariaDB Valid values: audit, error, general, slowquery Microsoft SQL Server Valid values: agent, error MySQL Valid values: audit, error, general, slowquery Oracle Valid values: alert, audit, listener, trace, oemagent PostgreSQL Valid values: postgresql, upgrade
enable_iam_database_authentication bool
A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled. This property is supported for RDS for MariaDB, RDS for MySQL, and RDS for PostgreSQL. For more information, see IAM Database Authentication for MariaDB, MySQL, and PostgreSQL in the Amazon RDS User Guide. Amazon Aurora Not applicable. Mapping AWS IAM accounts to database accounts is managed by the DB cluster.
enable_performance_insights bool
Specifies 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 DB instances.
endpoint DbInstanceEndpoint
engine str
The name of the database engine to use for this DB instance. Not every database engine is available in every AWS Region. This property is required when creating a DB instance. You can convert an Oracle database from the non-CDB architecture to the container database (CDB) architecture by updating the Engine value in your templates from oracle-ee to oracle-ee-cdb or from oracle-se2 to oracle-se2-cdb. Converting to the CDB architecture requires an interruption. Valid Values:

  • aurora-mysql (for Aurora MySQL DB instances)
  • aurora-postgresql (for Aurora PostgreSQL DB instances)
  • custom-oracle-ee (for RDS Custom for Oracle DB instances)
  • custom-oracle-ee-cdb (for RDS Custom for Oracle DB instances)
  • custom-sqlserver-ee (for RDS Custom for SQL Server DB instances)
  • custom-sqlserver-se (for RDS Custom for SQL Server DB instances)
  • custom-sqlserver-web (for RDS Custom for SQL Server DB instances)
  • db2-ae
  • db2-se
  • mariadb
  • mysql
  • oracle-ee
  • oracle-ee-cdb
  • oracle-se2
  • oracle-se2-cdb
  • postgres
  • sqlserver-ee
  • sqlserver-se
  • sqlserver-ex
  • sqlserver-web
engine_lifecycle_support str
The life cycle type for this DB instance. By default, this value is set to open-source-rds-extended-support, which enrolls your DB instance into Amazon RDS Extended Support. At the end of standard support, you can avoid charges for Extended Support by setting the value to open-source-rds-extended-support-disabled. In this case, creating the DB instance will fail if the DB major version is past its end of standard support date. This setting applies only to RDS for MySQL and RDS for PostgreSQL. For Amazon Aurora DB instances, the life cycle type is managed by the DB cluster. You can use this setting to enroll your DB instance into Amazon RDS Extended Support. With RDS Extended Support, you can run the selected major engine version on your DB instance past the end of standard support for that engine version. For more information, see Using Amazon RDS Extended Support in the Amazon RDS User Guide. Valid Values: open-source-rds-extended-support | open-source-rds-extended-support-disabled Default: open-source-rds-extended-support
engine_version str
The version number of the database engine to use. For a list of valid engine versions, use the DescribeDBEngineVersions action. The following are the database engines and links to information about the major and minor versions that are available with Amazon RDS. Not every database engine is available for every AWS Region. Amazon Aurora Not applicable. The version number of the database engine to be used by the DB instance is managed by the DB cluster. Db2 See Amazon RDS for Db2 in the Amazon RDS User Guide. MariaDB See MariaDB on Amazon RDS Versions in the Amazon RDS User Guide. Microsoft SQL Server See Microsoft SQL Server Versions on Amazon RDS in the Amazon RDS User Guide. MySQL See MySQL on Amazon RDS Versions in the Amazon RDS User Guide. Oracle See Oracle Database Engine Release Notes in the Amazon RDS User Guide. PostgreSQL See Supported PostgreSQL Database Versions in the Amazon RDS User Guide.
iops int
The number of I/O operations per second (IOPS) that the database provisions. The value must be equal to or greater than 1000. If you specify this property, you must follow the range of allowed ratios of your requested IOPS rate to the amount of storage that you allocate (IOPS to allocated storage). For example, you can provision an Oracle database instance with 1000 IOPS and 200 GiB of storage (a ratio of 5:1), or specify 2000 IOPS with 200 GiB of storage (a ratio of 10:1). For more information, see Amazon RDS Provisioned IOPS Storage to Improve Performance in the Amazon RDS User Guide. If you specify io1 for the StorageType property, then you must also specify the Iops property. Constraints:

  • For RDS for Db2, MariaDB, MySQL, Oracle, and PostgreSQL - Must be a multiple between .5 and 50 of the storage amount for the DB instance.
  • For RDS for SQL Server - Must be a multiple between 1 and 50 of the storage amount for the DB instance.
license_model str

License model information for this DB instance. Valid Values:

  • Aurora MySQL - general-public-license
  • Aurora PostgreSQL - postgresql-license
  • RDS for Db2 - bring-your-own-license. For more information about RDS for Db2 licensing, see in the Amazon RDS User Guide.
  • RDS for MariaDB - general-public-license
  • RDS for Microsoft SQL Server - license-included
  • RDS for MySQL - general-public-license
  • RDS for Oracle - bring-your-own-license or license-included
  • RDS for PostgreSQL - postgresql-license

If you've specified DBSecurityGroups and then you update the license model, AWS CloudFormation replaces the underlying DB instance. This will incur some interruptions to database availability.

manage_master_user_password bool
Specifies whether to manage the master user password with AWS Secrets Manager. For more information, see Password management with Secrets Manager in the Amazon RDS User Guide. Constraints:

  • Can't manage the master user password with AWS Secrets Manager if MasterUserPassword is specified.
master_user_secret DbInstanceMasterUserSecret
The secret managed by RDS in AWS Secrets Manager for the master user password. For more information, see Password management with Secrets Manager in the Amazon RDS User Guide.
max_allocated_storage 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 the following DB instances:

  • Amazon Aurora (Storage is managed by the DB cluster.)
  • RDS Custom
monitoring_interval 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. If MonitoringRoleArn is specified, then you must set MonitoringInterval to a value other than 0. This setting doesn't apply to RDS Custom DB instances. Valid Values: 0 | 1 | 5 | 10 | 15 | 30 | 60 Default: 0
monitoring_role_arn str
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 DB instances.
multi_az bool
Specifies 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 the following DB instances:

  • Amazon Aurora (DB instance Availability Zones (AZs) are managed by the DB cluster.)
  • RDS Custom
network_type str

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 IPv6 protocols (DUAL). For more information, see Working with a DB instance in a VPC in the Amazon RDS User Guide.

option_group_name str
Indicates that the DB instance should be associated with the specified option group. Permanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed from an option group. Also, that option group can't be removed from a DB instance once it is associated with a DB instance.
performance_insights_kms_key_id str
The AWS KMS key identifier for encryption of Performance Insights data. The 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 AWS account. Your AWS account has a different default KMS key for each AWS Region. For information about enabling Performance Insights, see EnablePerformanceInsights.
performance_insights_retention_period int

The number of days to retain Performance Insights data. When creating a DB instance without enabling Performance Insights, you can't specify the parameter PerformanceInsightsRetentionPeriod. This setting doesn't apply to RDS Custom DB instances. Valid Values:

  • 7
  • month * 31, where month is a number of months from 1-23. Examples: 93 (3 months * 31), 341 (11 months * 31), 589 (19 months * 31)
  • 731

Default: 7 days If you specify a retention period that isn't valid, such as 94, Amazon RDS returns an error.

port str

The port number on which the database accepts connections. This setting doesn't apply to Aurora DB instances. The port number is managed by the cluster. Valid Values: 1150-65535 Default:

  • RDS for Db2 - 50000
  • RDS for MariaDB - 3306
  • RDS for Microsoft SQL Server - 1433
  • RDS for MySQL - 3306
  • RDS for Oracle - 1521
  • RDS for PostgreSQL - 5432

Constraints:

  • For RDS for Microsoft SQL Server, the value can't be 1234, 1434, 3260, 3343, 3389, 47001, or 49152-49156.
preferred_backup_window str

The daily time range during which automated backups are created if automated backups are enabled, using the BackupRetentionPeriod parameter. For more information, see Backup Window in the Amazon RDS User Guide. Constraints:

  • Must be in the format hh24:mi-hh24:mi.
  • Must be in Universal Coordinated Time (UTC).
  • Must not conflict with the preferred maintenance window.
  • Must be at least 30 minutes.

Amazon Aurora Not applicable. The daily time range for creating automated backups is managed by the DB cluster.

preferred_maintenance_window str
The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC). Format: ddd:hh24:mi-ddd:hh24:mi The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region, occurring on a random day of the week. To see the time blocks available, see Maintaining a DB instance in the Amazon RDS User Guide. This property applies when AWS CloudFormation initially creates the DB instance. If you use AWS CloudFormation to update the DB instance, those updates are applied immediately. Constraints: Minimum 30-minute window.
processor_features Sequence[DbInstanceProcessorFeature]
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 Amazon Aurora or RDS Custom DB instances.
promotion_tier int
The order of priority 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 DB instances. Default: 1 Valid Values: 0 - 15
publicly_accessible bool
Indicates whether the DB instance is an internet-facing instance. If you specify true, AWS CloudFormation creates an instance with a publicly resolvable DNS name, which resolves to a public IP address. If you specify false, AWS CloudFormation creates an internal instance with a DNS name that resolves to a private IP address. The default behavior value depends on your VPC setup and the database subnet group. For more information, see the PubliclyAccessible parameter in the CreateDBInstance in the Amazon RDS API Reference.
replica_mode str
The open mode of an Oracle read replica. For more information, see Working with Oracle Read Replicas for Amazon RDS in the Amazon RDS User Guide. This setting is only supported in RDS for Oracle. Default: open-read-only Valid Values: open-read-only or mounted
source_db_cluster_identifier str
The identifier of the Multi-AZ DB cluster that will act as the source for the read replica. Each DB cluster can have up to 15 read replicas. Constraints:

  • Must be the identifier of an existing Multi-AZ DB cluster.
  • Can't be specified if the SourceDBInstanceIdentifier parameter is also specified.
  • The specified DB cluster must have automatic backups enabled, that is, its backup retention period must be greater than 0.
  • The source DB cluster must be in the same AWS-Region as the read replica. Cross-Region replication isn't supported.
storage_throughput int
Specifies the storage throughput value, in mebibyte per second (MiBps), for the DB instance. This setting applies only to the gp3 storage type. This setting doesn't apply to RDS Custom or Amazon Aurora.
storage_type str
The storage type to associate with the DB instance. If you specify io1, io2, or gp3, you must also include a value for the Iops parameter. This setting doesn't apply to Amazon Aurora DB instances. Storage is managed by the DB cluster. Valid Values: gp2 | gp3 | io1 | io2 | standard Default: io1, if the Iops parameter is specified. Otherwise, gp3.
tags Sequence[root_Tag]
Tags to assign to the DB instance.
tde_credential_arn str
vpc_security_groups Sequence[str]

A list of the VPC security group IDs to assign to the DB instance. The list can include both the physical IDs of existing VPC security groups and references to AWS::EC2::SecurityGroup resources created in the template. If you plan to update the resource, don't specify VPC security groups in a shared VPC. If you set VPCSecurityGroups, you must not set DBSecurityGroups, and vice versa. You can migrate a DB instance in your stack from an RDS DB security group to a VPC security group, but keep the following in mind:

  • You can't revert to using an RDS security group after you establish a VPC security group membership.
  • When you migrate your DB instance to VPC security groups, if your stack update rolls back because the DB instance update fails or because an update fails in another AWS CloudFormation resource, the rollback fails because it can't revert to an RDS security group.
  • To use the properties that are available when you use a VPC security group, you must recreate the DB instance. If you don't, AWS CloudFormation submits only the property values that are listed in the DBSecurityGroups property.

To avoid this situation, migrate your DB instance to using VPC security groups only when that is the only change in your stack template. Amazon Aurora Not applicable. The associated list of EC2 VPC security groups is managed by the DB cluster. If specified, the setting must match the DB cluster setting.

allocatedStorage String

The amount of storage in gibibytes (GiB) to be initially allocated for the database instance. If any value is set in the Iops parameter, AllocatedStorage must be at least 100 GiB, which corresponds to the minimum Iops value of 1,000. If you increase the Iops value (in 1,000 IOPS increments), then you must also increase the AllocatedStorage value (in 100-GiB increments). 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. Db2 Constraints to the amount of storage for each storage type are the following:

  • General Purpose (SSD) storage (gp3): Must be an integer from 20 to 64000.
  • Provisioned IOPS storage (io1): Must be an integer from 100 to 64000.

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

  • General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536.
  • Provisioned IOPS storage (io1): Must be an integer from 100 to 65536.
  • Magnetic storage (standard): Must be an integer from 5 to 3072.

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

  • General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536.
  • Provisioned IOPS storage (io1): Must be an integer from 100 to 65536.
  • Magnetic storage (standard): Must be an integer from 5 to 3072.

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

  • General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536.
  • Provisioned IOPS storage (io1): Must be an integer from 100 to 65536.
  • Magnetic storage (standard): Must be an integer from 5 to 3072.

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

  • General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536.
  • Provisioned IOPS storage (io1): Must be an integer from 100 to 65536.
  • Magnetic storage (standard): Must be an integer from 10 to 3072.

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

  • General Purpose (SSD) storage (gp2):

  • Enterprise and Standard editions: Must be an integer from 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 20 to 16384.

  • Web and Express editions: Must be an integer from 20 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.

associatedRoles List<Property Map>
The IAMlong (IAM) roles associated with the DB instance. Amazon Aurora Not applicable. The associated roles are managed by the DB cluster.
autoMinorVersionUpgrade Boolean
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.
automaticBackupReplicationRegion String
The AWS-Region associated with the automated backup.
automaticBackupReplicationRetentionPeriod Number
The retention period for automated backups in a different AWS Region. Use this parameter to set a unique retention period that only applies to cross-Region automated backups. To enable automated backups in a different Region, specify a positive value for the AutomaticBackupReplicationRegion parameter. If not specified, this parameter defaults to the value of the BackupRetentionPeriod parameter. The maximum allowed value is 35.
availabilityZone String

The Availability Zone (AZ) where the database will be created. For information on AWS-Regions and Availability Zones, see Regions and Availability Zones. For 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 AWS-Region. Constraints:

  • The AvailabilityZone parameter can't be specified if the DB instance is a Multi-AZ deployment.
  • The specified Availability Zone must be in the same AWS-Region as the current endpoint.

Example: us-east-1d

backupRetentionPeriod Number
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
caCertificateIdentifier String
The identifier of the CA certificate for this DB instance. 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.
certificateDetails Property Map
copyTagsToSnapshot Boolean
Specifies whether to copy tags from the DB instance to snapshots of the DB instance. By default, tags are not copied. This setting doesn't apply to Amazon Aurora DB instances. 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.
databaseInsightsMode String
The mode of Database Insights that is enabled for the instance.
dbClusterSnapshotIdentifier String
The identifier for the Multi-AZ DB cluster snapshot to restore from. For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide. Constraints:

  • Must match the identifier of an existing Multi-AZ DB cluster snapshot.
  • Can't be specified when DBSnapshotIdentifier is specified.
  • Must be specified when DBSnapshotIdentifier isn't specified.
  • If you are restoring from a shared manual Multi-AZ DB cluster snapshot, the DBClusterSnapshotIdentifier must be the ARN of the shared snapshot.
  • Can't be the identifier of an Aurora DB cluster snapshot.
dbInstanceArn String
The Amazon Resource Name (ARN) for the DB instance.
dbInstanceClass String
The compute and memory capacity of the DB instance, for example db.m5.large. Not all DB instance classes are available in all AWS-Regions, or for all database engines. For the full list of DB instance classes, and availability for your engine, see DB instance classes in the Amazon RDS User Guide or Aurora DB instance classes in the Amazon Aurora User Guide.
dbParameterGroupName String
The name of an existing DB parameter group or a reference to an AWS::RDS::DBParameterGroup resource created in the template. To list all of the available DB parameter group names, use the following command: aws rds describe-db-parameter-groups --query "DBParameterGroups[].DBParameterGroupName" --output text If any of the data members of the referenced parameter group are changed during an update, the DB instance might need to be restarted, which causes some interruption. If the parameter group contains static parameters, whether they were changed or not, an update triggers a reboot. If you don't specify a value for DBParameterGroupName property, the default DB parameter group for the specified engine and engine version is used.
dbSecurityGroups List<String>

A list of the DB security groups to assign to the DB instance. The list can include both the name of existing DB security groups or references to AWS::RDS::DBSecurityGroup resources created in the template. If you set DBSecurityGroups, you must not set VPCSecurityGroups, and vice versa. Also, note that the DBSecurityGroups property exists only for backwards compatibility with older regions and is no longer recommended for providing security information to an RDS DB instance. Instead, use VPCSecurityGroups. If you specify this property, AWS CloudFormation sends only the following properties (if specified) to Amazon RDS during create operations:

  • AllocatedStorage
  • AutoMinorVersionUpgrade
  • AvailabilityZone
  • BackupRetentionPeriod
  • CharacterSetName
  • DBInstanceClass
  • DBName
  • DBParameterGroupName
  • DBSecurityGroups
  • DBSubnetGroupName
  • Engine
  • EngineVersion
  • Iops
  • LicenseModel
  • MasterUsername
  • MasterUserPassword
  • MultiAZ
  • OptionGroupName
  • PreferredBackupWindow
  • PreferredMaintenanceWindow

All other properties are ignored. Specify a virtual private cloud (VPC) security group if you want to submit other properties, such as StorageType, StorageEncrypted, or KmsKeyId. If you're already using the DBSecurityGroups property, you can't use these other properties by updating your DB instance to use a VPC security group. You must recreate the DB instance.

dbiResourceId String
The AWS Region-unique, immutable identifier for the DB instance. This identifier is found in AWS CloudTrail log entries whenever the AWS KMS key for the DB instance is accessed.
dedicatedLogVolume Boolean
Indicates whether the DB instance has a dedicated log volume (DLV) enabled.
deletionProtection Boolean
Specifies 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. This setting doesn't apply to Amazon Aurora DB instances. 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 String
The Active Directory directory ID to create the DB instance in. Currently, only Db2, 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.
domainAuthSecretArn String
The ARN for the Secrets Manager secret with the credentials for the user joining the domain. Example: arn:aws:secretsmanager:region:account-number:secret:myselfmanagedADtestsecret-123456
domainDnsIps List<String>

The IPv4 DNS IP addresses of your primary and secondary Active Directory domain controllers. Constraints:

  • Two IP addresses must be provided. If there isn't a secondary domain controller, use the IP address of the primary domain controller for both entries in the list.

Example: 123.124.125.126,234.235.236.237

domainFqdn String

The fully qualified domain name (FQDN) of an Active Directory domain. Constraints:

  • Can't be longer than 64 characters.

Example: mymanagedADtest.mymanagedAD.mydomain

domainIamRoleName String
The name of the IAM role to use when making API calls to the Directory Service. This setting doesn't apply to the following DB instances:

  • Amazon Aurora (The domain is managed by the DB cluster.)
  • RDS Custom
domainOu String

The Active Directory organizational unit for your DB instance to join. Constraints:

  • Must be in the distinguished name format.
  • Can't be longer than 64 characters.

Example: OU=mymanagedADtestOU,DC=mymanagedADtest,DC=mymanagedAD,DC=mydomain

enableCloudwatchLogsExports List<String>
The list of log types that need to be enabled for exporting to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Relational Database Service User Guide. Amazon Aurora Not applicable. CloudWatch Logs exports are managed by the DB cluster. Db2 Valid values: diag.log, notify.log MariaDB Valid values: audit, error, general, slowquery Microsoft SQL Server Valid values: agent, error MySQL Valid values: audit, error, general, slowquery Oracle Valid values: alert, audit, listener, trace, oemagent PostgreSQL Valid values: postgresql, upgrade
enableIamDatabaseAuthentication Boolean
A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled. This property is supported for RDS for MariaDB, RDS for MySQL, and RDS for PostgreSQL. For more information, see IAM Database Authentication for MariaDB, MySQL, and PostgreSQL in the Amazon RDS User Guide. Amazon Aurora Not applicable. Mapping AWS IAM accounts to database accounts is managed by the DB cluster.
enablePerformanceInsights Boolean
Specifies 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 DB instances.
endpoint Property Map
engine String
The name of the database engine to use for this DB instance. Not every database engine is available in every AWS Region. This property is required when creating a DB instance. You can convert an Oracle database from the non-CDB architecture to the container database (CDB) architecture by updating the Engine value in your templates from oracle-ee to oracle-ee-cdb or from oracle-se2 to oracle-se2-cdb. Converting to the CDB architecture requires an interruption. Valid Values:

  • aurora-mysql (for Aurora MySQL DB instances)
  • aurora-postgresql (for Aurora PostgreSQL DB instances)
  • custom-oracle-ee (for RDS Custom for Oracle DB instances)
  • custom-oracle-ee-cdb (for RDS Custom for Oracle DB instances)
  • custom-sqlserver-ee (for RDS Custom for SQL Server DB instances)
  • custom-sqlserver-se (for RDS Custom for SQL Server DB instances)
  • custom-sqlserver-web (for RDS Custom for SQL Server DB instances)
  • db2-ae
  • db2-se
  • mariadb
  • mysql
  • oracle-ee
  • oracle-ee-cdb
  • oracle-se2
  • oracle-se2-cdb
  • postgres
  • sqlserver-ee
  • sqlserver-se
  • sqlserver-ex
  • sqlserver-web
engineLifecycleSupport String
The life cycle type for this DB instance. By default, this value is set to open-source-rds-extended-support, which enrolls your DB instance into Amazon RDS Extended Support. At the end of standard support, you can avoid charges for Extended Support by setting the value to open-source-rds-extended-support-disabled. In this case, creating the DB instance will fail if the DB major version is past its end of standard support date. This setting applies only to RDS for MySQL and RDS for PostgreSQL. For Amazon Aurora DB instances, the life cycle type is managed by the DB cluster. You can use this setting to enroll your DB instance into Amazon RDS Extended Support. With RDS Extended Support, you can run the selected major engine version on your DB instance past the end of standard support for that engine version. For more information, see Using Amazon RDS Extended Support in the Amazon RDS User Guide. Valid Values: open-source-rds-extended-support | open-source-rds-extended-support-disabled Default: open-source-rds-extended-support
engineVersion String
The version number of the database engine to use. For a list of valid engine versions, use the DescribeDBEngineVersions action. The following are the database engines and links to information about the major and minor versions that are available with Amazon RDS. Not every database engine is available for every AWS Region. Amazon Aurora Not applicable. The version number of the database engine to be used by the DB instance is managed by the DB cluster. Db2 See Amazon RDS for Db2 in the Amazon RDS User Guide. MariaDB See MariaDB on Amazon RDS Versions in the Amazon RDS User Guide. Microsoft SQL Server See Microsoft SQL Server Versions on Amazon RDS in the Amazon RDS User Guide. MySQL See MySQL on Amazon RDS Versions in the Amazon RDS User Guide. Oracle See Oracle Database Engine Release Notes in the Amazon RDS User Guide. PostgreSQL See Supported PostgreSQL Database Versions in the Amazon RDS User Guide.
iops Number
The number of I/O operations per second (IOPS) that the database provisions. The value must be equal to or greater than 1000. If you specify this property, you must follow the range of allowed ratios of your requested IOPS rate to the amount of storage that you allocate (IOPS to allocated storage). For example, you can provision an Oracle database instance with 1000 IOPS and 200 GiB of storage (a ratio of 5:1), or specify 2000 IOPS with 200 GiB of storage (a ratio of 10:1). For more information, see Amazon RDS Provisioned IOPS Storage to Improve Performance in the Amazon RDS User Guide. If you specify io1 for the StorageType property, then you must also specify the Iops property. Constraints:

  • For RDS for Db2, MariaDB, MySQL, Oracle, and PostgreSQL - Must be a multiple between .5 and 50 of the storage amount for the DB instance.
  • For RDS for SQL Server - Must be a multiple between 1 and 50 of the storage amount for the DB instance.
licenseModel String

License model information for this DB instance. Valid Values:

  • Aurora MySQL - general-public-license
  • Aurora PostgreSQL - postgresql-license
  • RDS for Db2 - bring-your-own-license. For more information about RDS for Db2 licensing, see in the Amazon RDS User Guide.
  • RDS for MariaDB - general-public-license
  • RDS for Microsoft SQL Server - license-included
  • RDS for MySQL - general-public-license
  • RDS for Oracle - bring-your-own-license or license-included
  • RDS for PostgreSQL - postgresql-license

If you've specified DBSecurityGroups and then you update the license model, AWS CloudFormation replaces the underlying DB instance. This will incur some interruptions to database availability.

manageMasterUserPassword Boolean
Specifies whether to manage the master user password with AWS Secrets Manager. For more information, see Password management with Secrets Manager in the Amazon RDS User Guide. Constraints:

  • Can't manage the master user password with AWS Secrets Manager if MasterUserPassword is specified.
masterUserSecret Property Map
The secret managed by RDS in AWS Secrets Manager for the master user password. For more information, see Password management with Secrets Manager in the Amazon RDS User Guide.
maxAllocatedStorage Number
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 the following DB instances:

  • Amazon Aurora (Storage is managed by the DB cluster.)
  • RDS Custom
monitoringInterval Number
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. If MonitoringRoleArn is specified, then you must set MonitoringInterval to a value other than 0. This setting doesn't apply to RDS Custom DB instances. Valid Values: 0 | 1 | 5 | 10 | 15 | 30 | 60 Default: 0
monitoringRoleArn String
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 DB instances.
multiAz Boolean
Specifies 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 the following DB instances:

  • Amazon Aurora (DB instance Availability Zones (AZs) are managed by the DB cluster.)
  • RDS Custom
networkType String

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 IPv6 protocols (DUAL). For more information, see Working with a DB instance in a VPC in the Amazon RDS User Guide.

optionGroupName String
Indicates that the DB instance should be associated with the specified option group. Permanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed from an option group. Also, that option group can't be removed from a DB instance once it is associated with a DB instance.
performanceInsightsKmsKeyId String
The AWS KMS key identifier for encryption of Performance Insights data. The 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 AWS account. Your AWS account has a different default KMS key for each AWS Region. For information about enabling Performance Insights, see EnablePerformanceInsights.
performanceInsightsRetentionPeriod Number

The number of days to retain Performance Insights data. When creating a DB instance without enabling Performance Insights, you can't specify the parameter PerformanceInsightsRetentionPeriod. This setting doesn't apply to RDS Custom DB instances. Valid Values:

  • 7
  • month * 31, where month is a number of months from 1-23. Examples: 93 (3 months * 31), 341 (11 months * 31), 589 (19 months * 31)
  • 731

Default: 7 days If you specify a retention period that isn't valid, such as 94, Amazon RDS returns an error.

port String

The port number on which the database accepts connections. This setting doesn't apply to Aurora DB instances. The port number is managed by the cluster. Valid Values: 1150-65535 Default:

  • RDS for Db2 - 50000
  • RDS for MariaDB - 3306
  • RDS for Microsoft SQL Server - 1433
  • RDS for MySQL - 3306
  • RDS for Oracle - 1521
  • RDS for PostgreSQL - 5432

Constraints:

  • For RDS for Microsoft SQL Server, the value can't be 1234, 1434, 3260, 3343, 3389, 47001, or 49152-49156.
preferredBackupWindow String

The daily time range during which automated backups are created if automated backups are enabled, using the BackupRetentionPeriod parameter. For more information, see Backup Window in the Amazon RDS User Guide. Constraints:

  • Must be in the format hh24:mi-hh24:mi.
  • Must be in Universal Coordinated Time (UTC).
  • Must not conflict with the preferred maintenance window.
  • Must be at least 30 minutes.

Amazon Aurora Not applicable. The daily time range for creating automated backups is managed by the DB cluster.

preferredMaintenanceWindow String
The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC). Format: ddd:hh24:mi-ddd:hh24:mi The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region, occurring on a random day of the week. To see the time blocks available, see Maintaining a DB instance in the Amazon RDS User Guide. This property applies when AWS CloudFormation initially creates the DB instance. If you use AWS CloudFormation to update the DB instance, those updates are applied immediately. Constraints: Minimum 30-minute window.
processorFeatures List<Property Map>
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 Amazon Aurora or RDS Custom DB instances.
promotionTier Number
The order of priority 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 DB instances. Default: 1 Valid Values: 0 - 15
publiclyAccessible Boolean
Indicates whether the DB instance is an internet-facing instance. If you specify true, AWS CloudFormation creates an instance with a publicly resolvable DNS name, which resolves to a public IP address. If you specify false, AWS CloudFormation creates an internal instance with a DNS name that resolves to a private IP address. The default behavior value depends on your VPC setup and the database subnet group. For more information, see the PubliclyAccessible parameter in the CreateDBInstance in the Amazon RDS API Reference.
replicaMode String
The open mode of an Oracle read replica. For more information, see Working with Oracle Read Replicas for Amazon RDS in the Amazon RDS User Guide. This setting is only supported in RDS for Oracle. Default: open-read-only Valid Values: open-read-only or mounted
sourceDbClusterIdentifier String
The identifier of the Multi-AZ DB cluster that will act as the source for the read replica. Each DB cluster can have up to 15 read replicas. Constraints:

  • Must be the identifier of an existing Multi-AZ DB cluster.
  • Can't be specified if the SourceDBInstanceIdentifier parameter is also specified.
  • The specified DB cluster must have automatic backups enabled, that is, its backup retention period must be greater than 0.
  • The source DB cluster must be in the same AWS-Region as the read replica. Cross-Region replication isn't supported.
storageThroughput Number
Specifies the storage throughput value, in mebibyte per second (MiBps), 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 String
The storage type to associate with the DB instance. If you specify io1, io2, or gp3, you must also include a value for the Iops parameter. This setting doesn't apply to Amazon Aurora DB instances. Storage is managed by the DB cluster. Valid Values: gp2 | gp3 | io1 | io2 | standard Default: io1, if the Iops parameter is specified. Otherwise, gp3.
tags List<Property Map>
Tags to assign to the DB instance.
tdeCredentialArn String
vpcSecurityGroups List<String>

A list of the VPC security group IDs to assign to the DB instance. The list can include both the physical IDs of existing VPC security groups and references to AWS::EC2::SecurityGroup resources created in the template. If you plan to update the resource, don't specify VPC security groups in a shared VPC. If you set VPCSecurityGroups, you must not set DBSecurityGroups, and vice versa. You can migrate a DB instance in your stack from an RDS DB security group to a VPC security group, but keep the following in mind:

  • You can't revert to using an RDS security group after you establish a VPC security group membership.
  • When you migrate your DB instance to VPC security groups, if your stack update rolls back because the DB instance update fails or because an update fails in another AWS CloudFormation resource, the rollback fails because it can't revert to an RDS security group.
  • To use the properties that are available when you use a VPC security group, you must recreate the DB instance. If you don't, AWS CloudFormation submits only the property values that are listed in the DBSecurityGroups property.

To avoid this situation, migrate your DB instance to using VPC security groups only when that is the only change in your stack template. Amazon Aurora Not applicable. The associated list of EC2 VPC security groups is managed by the DB cluster. If specified, the setting must match the DB cluster setting.

Supporting Types

DbInstanceCertificateDetails

CaIdentifier string
The CA identifier of the CA certificate used for the DB instance's server certificate.
ValidTill string
The expiration date of the DB instance’s server certificate.
CaIdentifier string
The CA identifier of the CA certificate used for the DB instance's server certificate.
ValidTill string
The expiration date of the DB instance’s server certificate.
caIdentifier String
The CA identifier of the CA certificate used for the DB instance's server certificate.
validTill String
The expiration date of the DB instance’s server certificate.
caIdentifier string
The CA identifier of the CA certificate used for the DB instance's server certificate.
validTill string
The expiration date of the DB instance’s server certificate.
ca_identifier str
The CA identifier of the CA certificate used for the DB instance's server certificate.
valid_till str
The expiration date of the DB instance’s server certificate.
caIdentifier String
The CA identifier of the CA certificate used for the DB instance's server certificate.
validTill String
The expiration date of the DB instance’s server certificate.

DbInstanceDbInstanceRole

FeatureName This property is required. string
The name of the feature associated with the AWS Identity and Access Management (IAM) role. IAM roles that are associated with a DB instance grant permission for the DB instance to access other AWS services on your behalf. For the list of supported feature names, see the SupportedFeatureNames description in DBEngineVersion in the Amazon RDS API Reference.
RoleArn This property is required. string
The Amazon Resource Name (ARN) of the IAM role that is associated with the DB instance.
FeatureName This property is required. string
The name of the feature associated with the AWS Identity and Access Management (IAM) role. IAM roles that are associated with a DB instance grant permission for the DB instance to access other AWS services on your behalf. For the list of supported feature names, see the SupportedFeatureNames description in DBEngineVersion in the Amazon RDS API Reference.
RoleArn This property is required. string
The Amazon Resource Name (ARN) of the IAM role that is associated with the DB instance.
featureName This property is required. String
The name of the feature associated with the AWS Identity and Access Management (IAM) role. IAM roles that are associated with a DB instance grant permission for the DB instance to access other AWS services on your behalf. For the list of supported feature names, see the SupportedFeatureNames description in DBEngineVersion in the Amazon RDS API Reference.
roleArn This property is required. String
The Amazon Resource Name (ARN) of the IAM role that is associated with the DB instance.
featureName This property is required. string
The name of the feature associated with the AWS Identity and Access Management (IAM) role. IAM roles that are associated with a DB instance grant permission for the DB instance to access other AWS services on your behalf. For the list of supported feature names, see the SupportedFeatureNames description in DBEngineVersion in the Amazon RDS API Reference.
roleArn This property is required. string
The Amazon Resource Name (ARN) of the IAM role that is associated with the DB instance.
feature_name This property is required. str
The name of the feature associated with the AWS Identity and Access Management (IAM) role. IAM roles that are associated with a DB instance grant permission for the DB instance to access other AWS services on your behalf. For the list of supported feature names, see the SupportedFeatureNames description in DBEngineVersion in the Amazon RDS API Reference.
role_arn This property is required. str
The Amazon Resource Name (ARN) of the IAM role that is associated with the DB instance.
featureName This property is required. String
The name of the feature associated with the AWS Identity and Access Management (IAM) role. IAM roles that are associated with a DB instance grant permission for the DB instance to access other AWS services on your behalf. For the list of supported feature names, see the SupportedFeatureNames description in DBEngineVersion in the Amazon RDS API Reference.
roleArn This property is required. String
The Amazon Resource Name (ARN) of the IAM role that is associated with the DB instance.

DbInstanceEndpoint

Address string
Specifies the DNS address of the DB instance.
HostedZoneId string
Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.
Port string
Specifies the port that the database engine is listening on.
Address string
Specifies the DNS address of the DB instance.
HostedZoneId string
Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.
Port string
Specifies the port that the database engine is listening on.
address String
Specifies the DNS address of the DB instance.
hostedZoneId String
Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.
port String
Specifies the port that the database engine is listening on.
address string
Specifies the DNS address of the DB instance.
hostedZoneId string
Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.
port string
Specifies the port that the database engine is listening on.
address str
Specifies the DNS address of the DB instance.
hosted_zone_id str
Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.
port str
Specifies the port that the database engine is listening on.
address String
Specifies the DNS address of the DB instance.
hostedZoneId String
Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.
port String
Specifies the port that the database engine is listening on.

DbInstanceMasterUserSecret

KmsKeyId string
The AWS KMS key identifier that is used to encrypt the secret.
SecretArn string
The Amazon Resource Name (ARN) of the secret. This parameter is a return value that you can retrieve using the Fn::GetAtt intrinsic function. For more information, see Return values.
KmsKeyId string
The AWS KMS key identifier that is used to encrypt the secret.
SecretArn string
The Amazon Resource Name (ARN) of the secret. This parameter is a return value that you can retrieve using the Fn::GetAtt intrinsic function. For more information, see Return values.
kmsKeyId String
The AWS KMS key identifier that is used to encrypt the secret.
secretArn String
The Amazon Resource Name (ARN) of the secret. This parameter is a return value that you can retrieve using the Fn::GetAtt intrinsic function. For more information, see Return values.
kmsKeyId string
The AWS KMS key identifier that is used to encrypt the secret.
secretArn string
The Amazon Resource Name (ARN) of the secret. This parameter is a return value that you can retrieve using the Fn::GetAtt intrinsic function. For more information, see Return values.
kms_key_id str
The AWS KMS key identifier that is used to encrypt the secret.
secret_arn str
The Amazon Resource Name (ARN) of the secret. This parameter is a return value that you can retrieve using the Fn::GetAtt intrinsic function. For more information, see Return values.
kmsKeyId String
The AWS KMS key identifier that is used to encrypt the secret.
secretArn String
The Amazon Resource Name (ARN) of the secret. This parameter is a return value that you can retrieve using the Fn::GetAtt intrinsic function. For more information, see Return values.

DbInstanceProcessorFeature

Name Pulumi.AwsNative.Rds.DbInstanceProcessorFeatureName
The name of the processor feature. Valid names are coreCount and threadsPerCore.
Value string
The value of a processor feature.
Name DbInstanceProcessorFeatureName
The name of the processor feature. Valid names are coreCount and threadsPerCore.
Value string
The value of a processor feature.
name DbInstanceProcessorFeatureName
The name of the processor feature. Valid names are coreCount and threadsPerCore.
value String
The value of a processor feature.
name DbInstanceProcessorFeatureName
The name of the processor feature. Valid names are coreCount and threadsPerCore.
value string
The value of a processor feature.
name DbInstanceProcessorFeatureName
The name of the processor feature. Valid names are coreCount and threadsPerCore.
value str
The value of a processor feature.
name "coreCount" | "threadsPerCore"
The name of the processor feature. Valid names are coreCount and threadsPerCore.
value String
The value of a processor feature.

DbInstanceProcessorFeatureName

Tag

Key This property is required. string
The key name of the tag
Value This property is required. string
The value of the tag
Key This property is required. string
The key name of the tag
Value This property is required. string
The value of the tag
key This property is required. String
The key name of the tag
value This property is required. String
The value of the tag
key This property is required. string
The key name of the tag
value This property is required. string
The value of the tag
key This property is required. str
The key name of the tag
value This property is required. str
The value of the tag
key This property is required. String
The key name of the tag
value This property is required. String
The value of the tag

Package Details

Repository
AWS Native pulumi/pulumi-aws-native
License
Apache-2.0

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-aws-native