aws-cdk-lib.aws_rds.CfnDBInstance

CfnDBInstance L1 construct

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:

• Deactivate any applications that are using the DB instance so that there's no activity on the DB instance.
• Create a snapshot of the DB instance. For more information, see Creating a DB Snapshot .
• 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.

• Update the stack.

For more information about updating other properties of this resource, see [ModifyDBInstance](https://docs.aws.amazon.com//AmazonRDS/latest/APIReference/API_ModifyDBInstance.html) . For more information about updating stacks, see AWS 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:

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

For more information, see DeletionPolicy Attribute .

Construct›CfnElement›CfnRefElement›CfnResource›CfnDBInstance

implements

• IInspectable,
• ITaggable,
• IEnvironmentAware,
• IDBInstanceRef,
• 2 more

  • IConstruct,
  • IDependable

CloudFormation

AWS::RDS::DBInstance

Source

Generated code

Type last changed

v2.269.0 · 10 Sep 2026

Example

declare const scope: Construct;
declare const parent: Construct;
declare const bucket: s3.CfnBucket;

// Apply DESTROY policy to all resources in a scope
RemovalPolicies.of(scope).destroy();

// Apply RETAIN policy to all resources in a scope
RemovalPolicies.of(scope).retain();

// Apply SNAPSHOT policy to all resources in a scope
RemovalPolicies.of(scope).snapshot();

// Apply RETAIN_ON_UPDATE_OR_DELETE policy to all resources in a scope
RemovalPolicies.of(scope).retainOnUpdateOrDelete();

// Apply RETAIN policy only to specific resource types
RemovalPolicies.of(parent).retain({
  applyToResourceTypes: [
    'AWS::DynamoDB::Table',
    bucket.cfnResourceType, // 'AWS::S3::Bucket'
    rds.CfnDBInstance.CFN_RESOURCE_TYPE_NAME, // 'AWS::RDS::DBInstance'
  ],
});

// Apply SNAPSHOT policy excluding specific resource types
RemovalPolicies.of(scope).snapshot({
  excludeResourceTypes: ['AWS::Test::Resource'],
});

# scope: Construct
# parent: Construct
# bucket: s3.CfnBucket


# Apply DESTROY policy to all resources in a scope
RemovalPolicies.of(scope).destroy()

# Apply RETAIN policy to all resources in a scope
RemovalPolicies.of(scope).retain()

# Apply SNAPSHOT policy to all resources in a scope
RemovalPolicies.of(scope).snapshot()

# Apply RETAIN_ON_UPDATE_OR_DELETE policy to all resources in a scope
RemovalPolicies.of(scope).retain_on_update_or_delete()

# Apply RETAIN policy only to specific resource types
RemovalPolicies.of(parent).retain(
    apply_to_resource_types=["AWS::DynamoDB::Table", bucket.cfn_resource_type, rds.CfnDBInstance.CFN_RESOURCE_TYPE_NAME
    ]
)

# Apply SNAPSHOT policy excluding specific resource types
RemovalPolicies.of(scope).snapshot(
    exclude_resource_types=["AWS::Test::Resource"]
)

Construct scope;
Construct parent;
CfnBucket bucket;


// Apply DESTROY policy to all resources in a scope
RemovalPolicies.of(scope).destroy();

// Apply RETAIN policy to all resources in a scope
RemovalPolicies.of(scope).retain();

// Apply SNAPSHOT policy to all resources in a scope
RemovalPolicies.of(scope).snapshot();

// Apply RETAIN_ON_UPDATE_OR_DELETE policy to all resources in a scope
RemovalPolicies.of(scope).retainOnUpdateOrDelete();

// Apply RETAIN policy only to specific resource types
RemovalPolicies.of(parent).retain(RemovalPolicyProps.builder()
        .applyToResourceTypes(List.of("AWS::DynamoDB::Table", bucket.getCfnResourceType(), CfnDBInstance.CFN_RESOURCE_TYPE_NAME))
        .build());

// Apply SNAPSHOT policy excluding specific resource types
RemovalPolicies.of(scope).snapshot(RemovalPolicyProps.builder()
        .excludeResourceTypes(List.of("AWS::Test::Resource"))
        .build());

// Install: dotnet add package Amazon.CDK.Lib
Construct scope;
Construct parent;
CfnBucket bucket;


// Apply DESTROY policy to all resources in a scope
RemovalPolicies.Of(scope).Destroy();

// Apply RETAIN policy to all resources in a scope
RemovalPolicies.Of(scope).Retain();

// Apply SNAPSHOT policy to all resources in a scope
RemovalPolicies.Of(scope).Snapshot();

// Apply RETAIN_ON_UPDATE_OR_DELETE policy to all resources in a scope
RemovalPolicies.Of(scope).RetainOnUpdateOrDelete();

// Apply RETAIN policy only to specific resource types
RemovalPolicies.Of(parent).Retain(new RemovalPolicyProps {
    ApplyToResourceTypes = new [] { "AWS::DynamoDB::Table", bucket.CfnResourceType, CfnDBInstance.CFN_RESOURCE_TYPE_NAME }
});

// Apply SNAPSHOT policy excluding specific resource types
RemovalPolicies.Of(scope).Snapshot(new RemovalPolicyProps {
    ExcludeResourceTypes = new [] { "AWS::Test::Resource" }
});

// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
var scope Construct
var parent Construct
var bucket CfnBucket


// Apply DESTROY policy to all resources in a scope
awscdk.RemovalPolicies_Of(*scope).Destroy()

// Apply RETAIN policy to all resources in a scope
awscdk.RemovalPolicies_Of(*scope).Retain()

// Apply SNAPSHOT policy to all resources in a scope
awscdk.RemovalPolicies_Of(*scope).Snapshot()

// Apply RETAIN_ON_UPDATE_OR_DELETE policy to all resources in a scope
awscdk.RemovalPolicies_Of(*scope).RetainOnUpdateOrDelete()

// Apply RETAIN policy only to specific resource types
awscdk.RemovalPolicies_Of(parent).Retain(&RemovalPolicyProps{
	ApplyToResourceTypes: []*string{
		jsii.String("AWS::DynamoDB::Table"),
		bucket.CfnResourceType,
		rds.CfnDBInstance_CFN_RESOURCE_TYPE_NAME(),
	},
})

// Apply SNAPSHOT policy excluding specific resource types
awscdk.RemovalPolicies_Of(*scope).Snapshot(&RemovalPolicyProps{
	ExcludeResourceTypes: []*string{
		jsii.String("AWS::Test::Resource"),
	},
})

Initializer

new CfnDBInstance(scope: Construct, id: string, props?: CfnDBInstanceProps)

CfnDBInstance(scope: Construct, id: str, props: typing.Optional[CfnDBInstanceProps] = None)

new CfnDBInstance(Construct scope, String id, CfnDBInstanceProps props)

new CfnDBInstance(Construct scope, string id, CfnDBInstanceProps? props = null)

NewCfnDBInstance(Scope Construct, Id *string, Props CfnDBInstanceProps)

Construct Props

additionalStorageVolumes?optionalIResolvable | IResolvable | CfnDBInstance.AdditionalStorageVolumeProperty[]additional_storage_volumes?optionaltyping.Union[IResolvable, typing.List[typing.Union[IResolvable, AdditionalStorageVolumeProperty]]]additionalStorageVolumes?optionalIResolvableAdditionalStorageVolumes?optionalIResolvableAdditionalStorageVolumes?optionalinterface{}#

The additional storage volumes associated with the DB instance.

RDS supports additional storage volumes for RDS for Oracle and RDS for SQL Server.

allocatedStorage?optionalstringallocated_storage?optionalstrallocatedStorage?optionalStringAllocatedStorage?optionalstringAllocatedStorage?optional*string#

The amount of storage in gibibytes (GiB) to be initially allocated for the database instance.

notes

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.

allowMajorVersionUpgrade?optionalboolean | IResolvableallow_major_version_upgrade?optionaltyping.Union[bool, IResolvable]allowMajorVersionUpgrade?optionalBooleanAllowMajorVersionUpgrade?optionalboolAllowMajorVersionUpgrade?optionalinterface{}#

A value that indicates whether major version upgrades are allowed.

notes

Changing this parameter doesn't result in an outage and the change is asynchronously applied as soon as possible.

Constraints: Major version upgrades must be allowed when specifying a value for the EngineVersion parameter that is a different major version than the DB instance's current version.

applyImmediately?optionalboolean | IResolvableapply_immediately?optionaltyping.Union[bool, IResolvable]applyImmediately?optionalBooleanApplyImmediately?optionalboolApplyImmediately?optionalinterface{}#

Specifies whether changes to the DB instance and any pending modifications are applied immediately, regardless of the `PreferredMaintenanceWindow` setting.

notes

If set to false , changes are applied during the next maintenance window. Until RDS applies the changes, the DB instance remains in a drift state. As a result, the configuration doesn't fully reflect the requested modifications and temporarily diverges from the intended state.

In addition to the settings described in Modifying a DB instance , this property also determines whether the DB instance reboots when a static parameter is modified in the associated DB parameter group.

Default: true

associatedRoles?optionalIResolvable | IResolvable | CfnDBInstance.DBInstanceRoleProperty[]associated_roles?optionaltyping.Union[IResolvable, typing.List[typing.Union[IResolvable, DBInstanceRoleProperty]]]associatedRoles?optionalIResolvableAssociatedRoles?optionalIResolvableAssociatedRoles?optionalinterface{}#

The AWS Identity and Access Management (IAM) roles associated with the DB instance.

Amazon Aurora

Not applicable. The associated roles are managed by the DB cluster.

automaticBackupReplicationKmsKeyId?optionalstringautomatic_backup_replication_kms_key_id?optionalstrautomaticBackupReplicationKmsKeyId?optionalStringAutomaticBackupReplicationKmsKeyId?optionalstringAutomaticBackupReplicationKmsKeyId?optional*string#

The AWS KMS key identifier for encryption of the replicated automated backups.

The KMS key ID is the Amazon Resource Name (ARN) for the KMS encryption key in the destination AWS Region , for example, arn:aws:kms:us-east-1:123456789012:key/AKIAIOSFODNN7EXAMPLE .

automaticBackupReplicationRegion?optionalstringautomatic_backup_replication_region?optionalstrautomaticBackupReplicationRegion?optionalStringAutomaticBackupReplicationRegion?optionalstringAutomaticBackupReplicationRegion?optional*string#

The AWS Region associated with the automated backup.

automaticBackupReplicationRetentionPeriod?optionalnumberautomatic_backup_replication_retention_period?optionalint | floatautomaticBackupReplicationRetentionPeriod?optionalNumberAutomaticBackupReplicationRetentionPeriod?optionaldoubleAutomaticBackupReplicationRetentionPeriod?optional*float64#

The retention period for automated backups in a different AWS Region.

notes

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.

autoMinorVersionUpgrade?optionalboolean | IResolvableauto_minor_version_upgrade?optionaltyping.Union[bool, IResolvable]autoMinorVersionUpgrade?optionalBooleanAutoMinorVersionUpgrade?optionalboolAutoMinorVersionUpgrade?optionalinterface{}#

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.

availabilityZone?optionalstringavailability_zone?optionalstravailabilityZone?optionalStringAvailabilityZone?optionalstringAvailabilityZone?optional*string#

The Availability Zone (AZ) where the database will be created.

notes

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?optionalnumberbackup_retention_period?optionalint | floatbackupRetentionPeriod?optionalNumberBackupRetentionPeriod?optionaldoubleBackupRetentionPeriod?optional*float64#

The number of days for which automated backups are retained.

notes

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

backupTarget?optionalstringbackup_target?optionalstrbackupTarget?optionalStringBackupTarget?optionalstringBackupTarget?optional*string#

The location for storing automated backups and manual snapshots.

notes

Valid Values:

• local (Dedicated Local Zone)
• outposts ( AWS Outposts)
• region ( AWS Region )

Default: region

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

caCertificateIdentifier?optionalstringca_certificate_identifier?optionalstrcaCertificateIdentifier?optionalStringCaCertificateIdentifier?optionalstringCaCertificateIdentifier?optional*string#

The identifier of the CA certificate for this DB instance.

notes

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 .

certificateRotationRestart?optionalboolean | IResolvablecertificate_rotation_restart?optionaltyping.Union[bool, IResolvable]certificateRotationRestart?optionalBooleanCertificateRotationRestart?optionalboolCertificateRotationRestart?optionalinterface{}#

Specifies whether the DB instance is restarted when you rotate your SSL/TLS certificate.

notes

By default, the DB instance is restarted when you rotate your SSL/TLS certificate. The certificate is not updated until the DB instance is restarted.

Set this parameter only if you are not using SSL/TLS to connect to the DB instance.

If you are using SSL/TLS to connect to the DB instance, follow the appropriate instructions for your DB engine to rotate your SSL/TLS certificate:

• For more information about rotating your SSL/TLS certificate for RDS DB engines, see Rotating Your SSL/TLS Certificate. in the Amazon RDS User Guide.
• For more information about rotating your SSL/TLS certificate for Aurora DB engines, see Rotating Your SSL/TLS Certificate in the Amazon Aurora User Guide .

This setting doesn't apply to RDS Custom DB instances.

characterSetName?optionalstringcharacter_set_name?optionalstrcharacterSetName?optionalStringCharacterSetName?optionalstringCharacterSetName?optional*string#

For supported engines, indicates that the DB instance should be associated with the specified character set.

Amazon Aurora

Not applicable. The character set is managed by the DB cluster. For more information, see AWS::RDS::DBCluster .

copyTagsToSnapshot?optionalboolean | IResolvablecopy_tags_to_snapshot?optionaltyping.Union[bool, IResolvable]copyTagsToSnapshot?optionalBooleanCopyTagsToSnapshot?optionalboolCopyTagsToSnapshot?optionalinterface{}#

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.

customIamInstanceProfile?optionalstringcustom_iam_instance_profile?optionalstrcustomIamInstanceProfile?optionalStringCustomIamInstanceProfile?optionalstringCustomIamInstanceProfile?optional*string#

The instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance.

notes

This setting is required for RDS Custom.

Constraints:

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

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

databaseInsightsMode?optionalstringdatabase_insights_mode?optionalstrdatabaseInsightsMode?optionalStringDatabaseInsightsMode?optionalstringDatabaseInsightsMode?optional*string#

The mode of Database Insights to enable for the DB instance.

Aurora DB instances inherit this value from the DB cluster, so you can't change this value.

dbClusterIdentifier?optionalstring | IDBClusterRefdb_cluster_identifier?optionaltyping.Union[str, IDBClusterRef]dbClusterIdentifier?optionalStringDbClusterIdentifier?optionalstringDbClusterIdentifier?optionalinterface{}#

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

This setting doesn't apply to RDS Custom DB instances.

dbClusterSnapshotIdentifier?optionalstringdb_cluster_snapshot_identifier?optionalstrdbClusterSnapshotIdentifier?optionalStringDbClusterSnapshotIdentifier?optionalstringDbClusterSnapshotIdentifier?optional*string#

The identifier for the Multi-AZ DB cluster snapshot to restore from.

notes

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.

dbInstanceClass?optionalstringdb_instance_class?optionalstrdbInstanceClass?optionalStringDbInstanceClass?optionalstringDbInstanceClass?optional*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](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html) in the *Amazon RDS User Guide* or [Aurora DB instance classes](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Concepts.DBInstanceClass.html) in the *Amazon Aurora User Guide* .

dbInstanceIdentifier?optionalstringdb_instance_identifier?optionalstrdbInstanceIdentifier?optionalStringDbInstanceIdentifier?optionalstringDbInstanceIdentifier?optional*string#

A name for the DB instance.

notes

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.

dbName?optionalstringdb_name?optionalstrdbName?optionalStringDbName?optionalstringDbName?optional*string#

The meaning of this parameter differs according to the database engine you use.

notes

If you specify the [DBSnapshotIdentifier](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-dbsnapshotidentifier) property, this property only applies to RDS for Oracle.

Amazon Aurora

Not applicable. The database name is managed by the DB cluster.

Db2

The name of the database to create when the DB instance is created. If this parameter isn't specified, no database is created in the DB instance.

Constraints:

• Must contain 1 to 64 letters or numbers.
• Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9).
• Can't be a word reserved by the specified database engine.

MySQL

The name of the database to create when the DB instance is created. If this parameter is not specified, no database is created in the DB instance.

Constraints:

• Must contain 1 to 64 letters or numbers.
• Can't be a word reserved by the specified database engine

MariaDB

The name of the database to create when the DB instance is created. If this parameter is not specified, no database is created in the DB instance.

Constraints:

• Must contain 1 to 64 letters or numbers.
• Can't be a word reserved by the specified database engine

PostgreSQL

The name of the database to create when the DB instance is created. If this parameter is not specified, the default postgres database is created in the DB instance.

Constraints:

• Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9).
• Must contain 1 to 63 characters.
• Can't be a word reserved by the specified database engine

Oracle

The Oracle System ID (SID) of the created DB instance. If you specify null , the default value ORCL is used. You can't specify the string NULL, or any other reserved word, for DBName .

Default: ORCL

Constraints:

• Can't be longer than 8 characters

SQL Server

Not applicable. Must be null.

dbParameterGroupName?optionalstring | IDBParameterGroupRefdb_parameter_group_name?optionaltyping.Union[str, IDBParameterGroupRef]dbParameterGroupName?optionalStringDbParameterGroupName?optionalstringDbParameterGroupName?optionalinterface{}#

The name of an existing DB parameter group or a reference to an [AWS::RDS::DBParameterGroup](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbparametergroup.html) resource created in the template.

notes

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?optionalstring[]db_security_groups?optionaltyping.List[str]dbSecurityGroups?optionalList<String>DbSecurityGroups?optionalstring[]DbSecurityGroups?optional*[]*string#

A list of the DB security groups to assign to the DB instance.

notes

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.

dbSnapshotIdentifier?optionalstringdb_snapshot_identifier?optionalstrdbSnapshotIdentifier?optionalStringDbSnapshotIdentifier?optionalstringDbSnapshotIdentifier?optional*string#

The name or Amazon Resource Name (ARN) of the DB snapshot that's used to restore the DB instance.

notes

If you're restoring from a shared manual DB snapshot, you must specify the ARN of the snapshot.

By specifying this property, you can create a DB instance from the specified DB snapshot. If the DBSnapshotIdentifier property is an empty string or the AWS::RDS::DBInstance declaration has no DBSnapshotIdentifier property, AWS CloudFormation creates a new database. If the property contains a value (other than an empty string), AWS CloudFormation creates a database from the specified snapshot. If a snapshot with the specified name doesn't exist, AWS CloudFormation can't create the database and it rolls back the stack.

Some DB instance properties aren't valid when you restore from a snapshot, such as the MasterUsername and MasterUserPassword properties, and the point-in-time recovery properties RestoreTime and UseLatestRestorableTime . For information about the properties that you can specify, see the RestoreDBInstanceFromDBSnapshot action in the Amazon RDS API Reference .

After you restore a DB instance with a DBSnapshotIdentifier property, you must specify the same DBSnapshotIdentifier property for any future updates to the DB instance. 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.

If you specify the DBSnapshotIdentifier property to restore a DB instance (as opposed to specifying it for DB instance updates), then don't specify the following properties:

• CharacterSetName
• DBClusterIdentifier
• DBName
• KmsKeyId
• MasterUsername
• MasterUserPassword
• PromotionTier
• SourceDBInstanceIdentifier
• SourceRegion
• StorageEncrypted (for an unencrypted snapshot)
• Timezone

Amazon Aurora

Not applicable. Snapshot restore is managed by the DB cluster.

dbSubnetGroupName?optionalstring | IDBSubnetGroupRefdb_subnet_group_name?optionaltyping.Union[str, IDBSubnetGroupRef]dbSubnetGroupName?optionalStringDbSubnetGroupName?optionalstringDbSubnetGroupName?optionalinterface{}#

A DB subnet group to associate with the DB instance.

notes

If you update this value, the new subnet group must be a subnet group in a new VPC.

If you don't specify a DB subnet group, RDS uses the default DB subnet group if one exists. If a default DB subnet group does not exist, and you don't specify a DBSubnetGroupName , the DB instance fails to launch.

For more information about using Amazon RDS in a VPC, see Amazon VPC and Amazon RDS in the Amazon RDS User Guide .

This setting doesn't apply to Amazon Aurora DB instances. The DB subnet group is managed by the DB cluster. If specified, the setting must match the DB cluster setting.

dbSystemId?optionalstringdb_system_id?optionalstrdbSystemId?optionalStringDbSystemId?optionalstringDbSystemId?optional*string#

The Oracle system identifier (SID), which is the name of the Oracle database instance that manages your database files.

notes

In this context, the term "Oracle database instance" refers exclusively to the system global area (SGA) and Oracle background processes. If you don't specify a SID, the value defaults to RDSCDB . The Oracle SID is also the name of your CDB.

dedicatedLogVolume?optionalboolean | IResolvablededicated_log_volume?optionaltyping.Union[bool, IResolvable]dedicatedLogVolume?optionalBooleanDedicatedLogVolume?optionalboolDedicatedLogVolume?optionalinterface{}#

Indicates whether the DB instance has a dedicated log volume (DLV) enabled.

deleteAutomatedBackups?optionalboolean | IResolvabledelete_automated_backups?optionaltyping.Union[bool, IResolvable]deleteAutomatedBackups?optionalBooleanDeleteAutomatedBackups?optionalboolDeleteAutomatedBackups?optionalinterface{}#

A value that indicates whether to remove automated backups immediately after the DB instance is deleted.

notes

This parameter isn't case-sensitive. The default is to remove automated backups immediately after the DB instance is deleted.

Amazon Aurora

Not applicable. When you delete a DB cluster, all automated backups for that DB cluster are deleted and can't be recovered. Manual DB cluster snapshots of the DB cluster are not deleted.

deletionProtection?optionalboolean | IResolvabledeletion_protection?optionaltyping.Union[bool, IResolvable]deletionProtection?optionalBooleanDeletionProtection?optionalboolDeletionProtection?optionalinterface{}#

Specifies whether the DB instance has deletion protection enabled.

notes

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?optionalstringdomain?optionalstrdomain?optionalStringDomain?optionalstringDomain?optional*string#

The Active Directory directory ID to create the DB instance in.

notes

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?optionalstringdomain_auth_secret_arn?optionalstrdomainAuthSecretArn?optionalStringDomainAuthSecretArn?optionalstringDomainAuthSecretArn?optional*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?optionalstring[]domain_dns_ips?optionaltyping.List[str]domainDnsIps?optionalList<String>DomainDnsIps?optionalstring[]DomainDnsIps?optional*[]*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?optionalstringdomain_fqdn?optionalstrdomainFqdn?optionalStringDomainFqdn?optionalstringDomainFqdn?optional*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?optionalstringdomain_iam_role_name?optionalstrdomainIamRoleName?optionalStringDomainIamRoleName?optionalstringDomainIamRoleName?optional*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?optionalstringdomain_ou?optionalstrdomainOu?optionalStringDomainOu?optionalstringDomainOu?optional*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?optionalstring[]enable_cloudwatch_logs_exports?optionaltyping.List[str]enableCloudwatchLogsExports?optionalList<String>EnableCloudwatchLogsExports?optionalstring[]EnableCloudwatchLogsExports?optional*[]*string#

The list of log types that need to be enabled for exporting to CloudWatch Logs.

notes

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?optionalboolean | IResolvableenable_iam_database_authentication?optionaltyping.Union[bool, IResolvable]enableIamDatabaseAuthentication?optionalBooleanEnableIamDatabaseAuthentication?optionalboolEnableIamDatabaseAuthentication?optionalinterface{}#

A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts.

notes

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?optionalboolean | IResolvableenable_performance_insights?optionaltyping.Union[bool, IResolvable]enablePerformanceInsights?optionalBooleanEnablePerformanceInsights?optionalboolEnablePerformanceInsights?optionalinterface{}#

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.

engine?optionalstringengine?optionalstrengine?optionalStringEngine?optionalstringEngine?optional*string#

The name of the database engine to use for this DB instance.

notes

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?optionalstringengine_lifecycle_support?optionalstrengineLifecycleSupport?optionalStringEngineLifecycleSupport?optionalstringEngineLifecycleSupport?optional*string#

The life cycle type for this DB instance.

notes

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 Amazon RDS Extended Support with Amazon RDS 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?optionalstringengine_version?optionalstrengineVersion?optionalStringEngineVersion?optionalstringEngineVersion?optional*string#

The version number of the database engine to use.

notes

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?optionalnumberiops?optionalint | floatiops?optionalNumberIops?optionaldoubleIops?optional*float64#

The number of I/O operations per second (IOPS) that the database provisions.

notes

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.

kmsKeyId?optionalstring | IKeyRefkms_key_id?optionaltyping.Union[str, IKeyRef]kmsKeyId?optionalStringKmsKeyId?optionalstringKmsKeyId?optionalinterface{}#

The ARN of the AWS KMS key that's used to encrypt the DB instance, such as `arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef` .

notes

If you enable the StorageEncrypted property but don't specify this property, AWS CloudFormation uses the default KMS key. If you specify this property, you must set the StorageEncrypted property to true.

If you specify the SourceDBInstanceIdentifier or SourceDbiResourceId property, don't specify this property. The value is inherited from the source DB instance, and if the DB instance is encrypted, the specified KmsKeyId property is used. However, if the source DB instance is in a different AWS Region, you must specify a KMS key ID.

If you specify the SourceDBInstanceAutomatedBackupsArn property, don't specify this property. The value is inherited from the source DB instance automated backup, and if the automated backup is encrypted, the specified KmsKeyId property is used.

If you create an encrypted read replica in a different AWS Region, then you must specify a KMS key for the destination AWS Region. KMS encryption keys are specific to the region that they're created in, and you can't use encryption keys from one region in another region.

If you specify the DBSnapshotIdentifier property, don't specify this property. The StorageEncrypted property value is inherited from the snapshot. If the DB instance is encrypted, the specified KmsKeyId property is also inherited from the snapshot.

If you specify DBSecurityGroups , AWS CloudFormation ignores this property. To specify both a security group and this property, you must use a VPC security group. For more information about Amazon RDS and VPC, see Using Amazon RDS with Amazon VPC in the Amazon RDS User Guide .

Amazon Aurora

Not applicable. The KMS key identifier is managed by the DB cluster.

licenseModel?optionalstringlicense_model?optionalstrlicenseModel?optionalStringLicenseModel?optionalstringLicenseModel?optional*string#

License model information for this DB instance.

notes

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?optionalboolean | IResolvablemanage_master_user_password?optionaltyping.Union[bool, IResolvable]manageMasterUserPassword?optionalBooleanManageMasterUserPassword?optionalboolManageMasterUserPassword?optionalinterface{}#

Specifies whether to manage the master user password with AWS Secrets Manager.

notes

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

Constraints:

• Can't manage the master user password with AWS Secrets Manager if MasterUserPassword is specified.

masterUserAuthenticationType?optionalstringmaster_user_authentication_type?optionalstrmasterUserAuthenticationType?optionalStringMasterUserAuthenticationType?optionalstringMasterUserAuthenticationType?optional*string#

Specifies the authentication type for the master user.

notes

With IAM master user authentication, you can configure the master DB user with IAM database authentication when you create a DB instance.

You can specify one of the following values:

• password - Use standard database authentication with a password.
• iam-db-auth - Use IAM database authentication for the master user.

This option is only valid for RDS for MySQL, RDS for MariaDB, RDS for PostgreSQL, Aurora MySQL, and Aurora PostgreSQL engines.

masterUsername?optionalstringmaster_username?optionalstrmasterUsername?optionalStringMasterUsername?optionalstringMasterUsername?optional*string#

The master user name for the DB instance.

notes

If you specify the SourceDBInstanceIdentifier or DBSnapshotIdentifier property, don't specify this property. The value is inherited from the source DB instance or snapshot.

When migrating a self-managed Db2 database, we recommend that you use the same master username as your self-managed Db2 instance name.

Amazon Aurora

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

RDS for Db2

Constraints:

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

RDS for MariaDB

Constraints:

• Must be 1 to 16 letters or numbers.
• Can't be a reserved word for the chosen database engine.

RDS for Microsoft SQL Server

Constraints:

• Must be 1 to 128 letters or numbers.
• First character must be a letter.
• Can't be a reserved word for the chosen database engine.

RDS for MySQL

Constraints:

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

RDS for Oracle

Constraints:

• Must be 1 to 30 letters or numbers.
• First character must be a letter.
• Can't be a reserved word for the chosen database engine.

RDS for PostgreSQL

Constraints:

• Must be 1 to 63 letters or numbers.
• First character must be a letter.
• Can't be a reserved word for the chosen database engine.

masterUserPassword?optionalstringmaster_user_password?optionalstrmasterUserPassword?optionalStringMasterUserPassword?optionalstringMasterUserPassword?optional*string#

The password for the master user. The password can include any printable ASCII character except "/", """, or "@".

notes

Amazon Aurora

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

RDS for Db2

Must contain from 8 to 255 characters.

RDS for MariaDB

Constraints: Must contain from 8 to 41 characters.

RDS for Microsoft SQL Server

Constraints: Must contain from 8 to 128 characters.

RDS for MySQL

Constraints: Must contain from 8 to 41 characters.

RDS for Oracle

Constraints: Must contain from 8 to 30 characters.

RDS for PostgreSQL

Constraints: Must contain from 8 to 128 characters.

masterUserSecret?optionalIResolvable | CfnDBInstance.MasterUserSecretPropertymaster_user_secret?optionaltyping.Union[IResolvable, MasterUserSecretProperty]masterUserSecret?optionalIResolvableMasterUserSecret?optionalIResolvableMasterUserSecret?optionalinterface{}#

The secret managed by RDS in AWS Secrets Manager for the master user password.

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

maxAllocatedStorage?optionalnumbermax_allocated_storage?optionalint | floatmaxAllocatedStorage?optionalNumberMaxAllocatedStorage?optionaldoubleMaxAllocatedStorage?optional*float64#

The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance.

notes

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?optionalnumbermonitoring_interval?optionalint | floatmonitoringInterval?optionalNumberMonitoringInterval?optionaldoubleMonitoringInterval?optional*float64#

The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance.

notes

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?optionalstring | IRoleRefmonitoring_role_arn?optionaltyping.Union[str, IRoleRef]monitoringRoleArn?optionalStringMonitoringRoleArn?optionalstringMonitoringRoleArn?optionalinterface{}#

The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs.

notes

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?optionalboolean | IResolvablemulti_az?optionaltyping.Union[bool, IResolvable]multiAz?optionalBooleanMultiAz?optionalboolMultiAz?optionalinterface{}#

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 Amazon Aurora because the DB instance Availability Zones (AZs) are managed by the DB cluster.

ncharCharacterSetName?optionalstringnchar_character_set_name?optionalstrncharCharacterSetName?optionalStringNcharCharacterSetName?optionalstringNcharCharacterSetName?optional*string#

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

This setting doesn't apply to RDS Custom DB instances.

networkType?optionalstringnetwork_type?optionalstrnetworkType?optionalStringNetworkType?optionalstringNetworkType?optional*string#

The network type of the DB instance.

notes

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?optionalstringoption_group_name?optionalstroptionGroupName?optionalStringOptionGroupName?optionalstringOptionGroupName?optional*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?optionalstring | IKeyRefperformance_insights_kms_key_id?optionaltyping.Union[str, IKeyRef]performanceInsightsKmsKeyId?optionalStringPerformanceInsightsKmsKeyId?optionalstringPerformanceInsightsKmsKeyId?optionalinterface{}#

The AWS KMS key identifier for encryption of Performance Insights data.

notes

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?optionalnumberperformance_insights_retention_period?optionalint | floatperformanceInsightsRetentionPeriod?optionalNumberPerformanceInsightsRetentionPeriod?optionaldoublePerformanceInsightsRetentionPeriod?optional*float64#

The number of days to retain Performance Insights data.

notes

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?optionalstringport?optionalstrport?optionalStringPort?optionalstringPort?optional*string#

The port number on which the database accepts connections.

notes

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?optionalstringpreferred_backup_window?optionalstrpreferredBackupWindow?optionalStringPreferredBackupWindow?optionalstringPreferredBackupWindow?optional*string#

The daily time range during which automated backups are created if automated backups are enabled, using the `BackupRetentionPeriod` parameter.

notes

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?optionalstringpreferred_maintenance_window?optionalstrpreferredMaintenanceWindow?optionalStringPreferredMaintenanceWindow?optionalstringPreferredMaintenanceWindow?optional*string#

The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

notes

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?optionalIResolvable | IResolvable | CfnDBInstance.ProcessorFeatureProperty[]processor_features?optionaltyping.Union[IResolvable, typing.List[typing.Union[IResolvable, ProcessorFeatureProperty]]]processorFeatures?optionalIResolvableProcessorFeatures?optionalIResolvableProcessorFeatures?optionalinterface{}#

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?optionalnumberpromotion_tier?optionalint | floatpromotionTier?optionalNumberPromotionTier?optionaldoublePromotionTier?optional*float64#

The order of priority in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance.

notes

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?optionalboolean | IResolvablepublicly_accessible?optionaltyping.Union[bool, IResolvable]publiclyAccessible?optionalBooleanPubliclyAccessible?optionalboolPubliclyAccessible?optionalinterface{}#

Indicates whether the DB instance is an internet-facing instance.

notes

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?optionalstringreplica_mode?optionalstrreplicaMode?optionalStringReplicaMode?optionalstringReplicaMode?optional*string#

The open mode of an Oracle read replica.

notes

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

restoreTime?optionalstringrestore_time?optionalstrrestoreTime?optionalStringRestoreTime?optionalstringRestoreTime?optional*string#

The date and time to restore from.

notes

This parameter applies to point-in-time recovery. For more information, see Restoring a DB instance to a specified time in the in the Amazon RDS User Guide .

Constraints:

• Must be a time in Universal Coordinated Time (UTC) format.
• Must be before the latest restorable time for the DB instance.
• Can't be specified if the UseLatestRestorableTime parameter is enabled.

Example: 2009-09-07T23:45:00Z

sourceDbClusterIdentifier?optionalstringsource_db_cluster_identifier?optionalstrsourceDbClusterIdentifier?optionalStringSourceDbClusterIdentifier?optionalstringSourceDbClusterIdentifier?optional*string#

The identifier of the Multi-AZ DB cluster that will act as the source for the read replica.

notes

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.

sourceDbInstanceAutomatedBackupsArn?optionalstringsource_db_instance_automated_backups_arn?optionalstrsourceDbInstanceAutomatedBackupsArn?optionalStringSourceDbInstanceAutomatedBackupsArn?optionalstringSourceDbInstanceAutomatedBackupsArn?optional*string#

The Amazon Resource Name (ARN) of the replicated automated backups from which to restore, for example, `arn:aws:rds:us-east-1:123456789012:auto-backup:ab-L2IJCEXJP7XQ7HOJ4SIEXAMPLE` .

This setting doesn't apply to RDS Custom.

sourceDbInstanceIdentifier?optionalstring | IDBInstanceRefsource_db_instance_identifier?optionaltyping.Union[str, IDBInstanceRef]sourceDbInstanceIdentifier?optionalStringSourceDbInstanceIdentifier?optionalstringSourceDbInstanceIdentifier?optionalinterface{}#

If you want to create a read replica DB instance, specify the ID of the source DB instance.

notes

Each DB instance can have a limited number of read replicas. For more information, see Working with Read Replicas in the Amazon RDS User Guide .

For information about constraints that apply to DB instance identifiers, see Naming constraints in Amazon RDS in the Amazon RDS User Guide .

The SourceDBInstanceIdentifier property determines whether a DB instance is a read replica. If you remove the SourceDBInstanceIdentifier property from your template and then update your stack, AWS CloudFormation promotes the read replica to a standalone DB instance.

If you specify the UseLatestRestorableTime or RestoreTime properties in conjunction with the SourceDBInstanceIdentifier property, RDS restores the DB instance to the requested point in time, thereby creating a new DB instance.

• If you specify a source DB instance that uses VPC security groups, we recommend that you specify the VPCSecurityGroups property. If you don't specify the property, the read replica inherits the value of the VPCSecurityGroups property from the source DB when you create the replica. However, if you update the stack, AWS CloudFormation reverts the replica's VPCSecurityGroups property to the default value because it's not defined in the stack's template. This change might cause unexpected issues.
• Read replicas don't support deletion policies. AWS CloudFormation ignores any deletion policy that's associated with a read replica.
• If you specify SourceDBInstanceIdentifier , don't specify the DBSnapshotIdentifier property. You can't create a read replica from a snapshot.
• Don't set the BackupRetentionPeriod , DBName , MasterUsername , MasterUserPassword , and PreferredBackupWindow properties. The database attributes are inherited from the source DB instance, and backups are disabled for read replicas.
• If the source DB instance is in a different region than the read replica, specify the source region in SourceRegion , and specify an ARN for a valid DB instance in SourceDBInstanceIdentifier . For more information, see Constructing a Amazon RDS Amazon Resource Name (ARN) in the Amazon RDS User Guide .
• For DB instances in Amazon Aurora clusters, don't specify this property. Amazon RDS automatically assigns writer and reader DB instances.

sourceDbiResourceId?optionalstringsource_dbi_resource_id?optionalstrsourceDbiResourceId?optionalStringSourceDbiResourceId?optionalstringSourceDbiResourceId?optional*string#

The resource ID of the source DB instance from which to restore.

sourceRegion?optionalstringsource_region?optionalstrsourceRegion?optionalStringSourceRegion?optionalstringSourceRegion?optional*string#

The ID of the region that contains the source DB instance for the read replica.

storageEncrypted?optionalboolean | IResolvablestorage_encrypted?optionaltyping.Union[bool, IResolvable]storageEncrypted?optionalBooleanStorageEncrypted?optionalboolStorageEncrypted?optionalinterface{}#

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

notes

If you specify the KmsKeyId property, then you must enable encryption.

If you specify the SourceDBInstanceIdentifier or SourceDbiResourceId property, don't specify this property. The value is inherited from the source DB instance, and if the DB instance is encrypted, the specified KmsKeyId property is used.

If you specify the SourceDBInstanceAutomatedBackupsArn property, don't specify this property. The value is inherited from the source DB instance automated backup.

If you specify DBSnapshotIdentifier property, don't specify this property. The value is inherited from the snapshot.

Amazon Aurora

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

storageThroughput?optionalnumberstorage_throughput?optionalint | floatstorageThroughput?optionalNumberStorageThroughput?optionaldoubleStorageThroughput?optional*float64#

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?optionalstringstorage_type?optionalstrstorageType?optionalStringStorageType?optionalstringStorageType?optional*string#

The storage type to associate with the DB instance.

notes

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?optionalCfnTag[]tags?optionaltyping.List[CfnTag]tags?optionalList<CfnTag>Tags?optionalCfnTag[]Tags?optional*[]CfnTag#

Tags to assign to the DB instance.

tdeCredentialArn?optionalstringtde_credential_arn?optionalstrtdeCredentialArn?optionalStringTdeCredentialArn?optionalstringTdeCredentialArn?optional*stringdeprecated#

this property has been deprecated

tdeCredentialPassword?optionalstringtde_credential_password?optionalstrtdeCredentialPassword?optionalStringTdeCredentialPassword?optionalstringTdeCredentialPassword?optional*stringdeprecated#

this property has been deprecated

timezone?optionalstringtimezone?optionalstrtimezone?optionalStringTimezone?optionalstringTimezone?optional*string#

The time zone of the DB instance.

notes

The time zone parameter is currently supported only by RDS for Db2 and RDS for SQL Server .

useDefaultProcessorFeatures?optionalboolean | IResolvableuse_default_processor_features?optionaltyping.Union[bool, IResolvable]useDefaultProcessorFeatures?optionalBooleanUseDefaultProcessorFeatures?optionalboolUseDefaultProcessorFeatures?optionalinterface{}#

Specifies whether the DB instance class of the DB instance uses its default processor features.

This setting doesn't apply to RDS Custom DB instances.

useLatestRestorableTime?optionalboolean | IResolvableuse_latest_restorable_time?optionaltyping.Union[bool, IResolvable]useLatestRestorableTime?optionalBooleanUseLatestRestorableTime?optionalboolUseLatestRestorableTime?optionalinterface{}#

Specifies whether the DB instance is restored from the latest backup time.

notes

By default, the DB instance isn't restored from the latest backup time. This parameter applies to point-in-time recovery. For more information, see Restoring a DB instance to a specified time in the in the Amazon RDS User Guide .

Constraints:

• Can't be specified if the RestoreTime parameter is provided.

vpcSecurityGroups?optionalstring | ISecurityGroupRef[]vpc_security_groups?optionaltyping.List[typing.Union[str, ISecurityGroupRef]]vpcSecurityGroups?optionalList<String>VpcSecurityGroups?optionalstring[]VpcSecurityGroups?optional*[]interface{}#

A list of the VPC security group IDs to assign to the DB instance.

notes

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.

Properties

additionalStorageVolumes?may be undefinedIResolvable | IResolvable | CfnDBInstance.AdditionalStorageVolumeProperty[]additional_storage_volumes?may be undefinedtyping.Union[IResolvable, typing.List[typing.Union[IResolvable, AdditionalStorageVolumeProperty]]]additionalStorageVolumes?may be undefinedIResolvableAdditionalStorageVolumes?may be undefinedIResolvableAdditionalStorageVolumes?may be undefinedinterface{}#

The additional storage volumes associated with the DB instance.

allocatedStorage?may be undefinedstringallocated_storage?may be undefinedstrallocatedStorage?may be undefinedStringAllocatedStorage?may be undefinedstringAllocatedStorage?may be undefined*string#

The amount of storage in gibibytes (GiB) to be initially allocated for the database instance.

allowMajorVersionUpgrade?may be undefinedboolean | IResolvableallow_major_version_upgrade?may be undefinedtyping.Union[bool, IResolvable]allowMajorVersionUpgrade?may be undefinedBooleanAllowMajorVersionUpgrade?may be undefinedboolAllowMajorVersionUpgrade?may be undefinedinterface{}#

A value that indicates whether major version upgrades are allowed.

applyImmediately?may be undefinedboolean | IResolvableapply_immediately?may be undefinedtyping.Union[bool, IResolvable]applyImmediately?may be undefinedBooleanApplyImmediately?may be undefinedboolApplyImmediately?may be undefinedinterface{}#

Specifies whether changes to the DB instance and any pending modifications are applied immediately, regardless of the `PreferredMaintenanceWindow` setting.

associatedRoles?may be undefinedIResolvable | IResolvable | CfnDBInstance.DBInstanceRoleProperty[]associated_roles?may be undefinedtyping.Union[IResolvable, typing.List[typing.Union[IResolvable, DBInstanceRoleProperty]]]associatedRoles?may be undefinedIResolvableAssociatedRoles?may be undefinedIResolvableAssociatedRoles?may be undefinedinterface{}#

The AWS Identity and Access Management (IAM) roles associated with the DB instance.

attrAutomaticRestartTimestringattr_automatic_restart_timestrattrAutomaticRestartTimeStringAttrAutomaticRestartTimestringAttrAutomaticRestartTime*string#

The time when a stopped DB instance is restarted automatically.

attrCertificateDetailsIResolvableattr_certificate_detailsIResolvableattrCertificateDetailsIResolvableAttrCertificateDetailsIResolvableAttrCertificateDetailsIResolvable#

The details of the DB instance’s server certificate.

notes

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.

attrCertificateDetailsCaIdentifierstringattr_certificate_details_ca_identifierstrattrCertificateDetailsCaIdentifierStringAttrCertificateDetailsCaIdentifierstringAttrCertificateDetailsCaIdentifier*string#

The CA identifier of the CA certificate used for the DB instance's server certificate.

attrCertificateDetailsValidTillstringattr_certificate_details_valid_tillstrattrCertificateDetailsValidTillStringAttrCertificateDetailsValidTillstringAttrCertificateDetailsValidTill*string#

The expiration date of the DB instance’s server certificate.

attrDbInstanceArnstringattr_db_instance_arnstrattrDbInstanceArnStringAttrDbInstanceArnstringAttrDbInstanceArn*string#

The Amazon Resource Name (ARN) for the DB instance.

attrDbInstanceStatusstringattr_db_instance_statusstrattrDbInstanceStatusStringAttrDbInstanceStatusstringAttrDbInstanceStatus*string#

The current state of this DB instance.

attrDbiResourceIdstringattr_dbi_resource_idstrattrDbiResourceIdStringAttrDbiResourceIdstringAttrDbiResourceId*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.

attrDbSystemIdstringattr_db_system_idstrattrDbSystemIdStringAttrDbSystemIdstringAttrDbSystemId*string#

The Oracle system ID (Oracle SID) for a container database (CDB).

The Oracle SID is also the name of the CDB.

This setting is valid for RDS Custom only.

attrEndpointIResolvableattr_endpointIResolvableattrEndpointIResolvableAttrEndpointIResolvableAttrEndpointIResolvable#

This data type represents the information you need to connect to an Amazon RDS DB instance.

notes

This data type is used as a response element in the following actions:

• CreateDBInstance
• DescribeDBInstances
• DeleteDBInstance

For the data structure that represents Amazon Aurora DB cluster endpoints, see DBClusterEndpoint.

attrEndpointAddressstringattr_endpoint_addressstrattrEndpointAddressStringAttrEndpointAddressstringAttrEndpointAddress*string#

The connection endpoint for the database. For example: `mystack-mydb-1apw1j4phylrk.cg034hpkmmjt.us-east-2.rds.amazonaws.com`.

For Aurora Serverless DB clusters, the connection endpoint only applies to the DB cluster.

attrEndpointHostedZoneIdstringattr_endpoint_hosted_zone_idstrattrEndpointHostedZoneIdStringAttrEndpointHostedZoneIdstringAttrEndpointHostedZoneId*string#

The ID that Amazon Route 53 assigns when you create a hosted zone.

attrEndpointPortstringattr_endpoint_portstrattrEndpointPortStringAttrEndpointPortstringAttrEndpointPort*string#

The port number on which the database accepts connections.

For example: 3306

attrInstanceCreateTimestringattr_instance_create_timestrattrInstanceCreateTimeStringAttrInstanceCreateTimestringAttrInstanceCreateTime*string#

The date and time when the DB instance was created.

attrIsStorageConfigUpgradeAvailableIResolvableattr_is_storage_config_upgrade_availableIResolvableattrIsStorageConfigUpgradeAvailableIResolvableAttrIsStorageConfigUpgradeAvailableIResolvableAttrIsStorageConfigUpgradeAvailableIResolvable#

Indicates whether an upgrade is recommended for the storage file system configuration on the DB instance.

attrLatestRestorableTimestringattr_latest_restorable_timestrattrLatestRestorableTimeStringAttrLatestRestorableTimestringAttrLatestRestorableTime*string#

The latest time to which a database in this DB instance can be restored with point-in-time restore.

attrListenerEndpointIResolvableattr_listener_endpointIResolvableattrListenerEndpointIResolvableAttrListenerEndpointIResolvableAttrListenerEndpointIResolvable#

This data type represents the information you need to connect to an Amazon RDS DB instance.

notes

This data type is used as a response element in the following actions:

• CreateDBInstance
• DescribeDBInstances
• DeleteDBInstance

For the data structure that represents Amazon Aurora DB cluster endpoints, see DBClusterEndpoint.

attrListenerEndpointAddressstringattr_listener_endpoint_addressstrattrListenerEndpointAddressStringAttrListenerEndpointAddressstringAttrListenerEndpointAddress*string#

Specifies the DNS address of the DB instance.

attrListenerEndpointHostedZoneIdstringattr_listener_endpoint_hosted_zone_idstrattrListenerEndpointHostedZoneIdStringAttrListenerEndpointHostedZoneIdstringAttrListenerEndpointHostedZoneId*string#

Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.

attrListenerEndpointPortstringattr_listener_endpoint_portstrattrListenerEndpointPortStringAttrListenerEndpointPortstringAttrListenerEndpointPort*string#

Specifies the port that the database engine is listening on.

attrMasterUserSecretSecretArnstringattr_master_user_secret_secret_arnstrattrMasterUserSecretSecretArnStringAttrMasterUserSecretSecretArnstringAttrMasterUserSecretSecretArn*string#

The Amazon Resource Name (ARN) of the secret.

notes

This parameter is a return value that you can retrieve using the Fn::GetAtt intrinsic function. For more information, see Return values .

attrPercentProgressstringattr_percent_progressstrattrPercentProgressStringAttrPercentProgressstringAttrPercentProgress*string#

The progress of the storage optimization operation as a percentage.

attrReadReplicaDbClusterIdentifiersstring[]attr_read_replica_db_cluster_identifierstyping.List[str]attrReadReplicaDbClusterIdentifiersList<String>AttrReadReplicaDbClusterIdentifiersstring[]AttrReadReplicaDbClusterIdentifiers*[]*string#

The identifiers of Aurora DB clusters to which the RDS DB instance is replicated as a read replica.

attrReadReplicaDbInstanceIdentifiersstring[]attr_read_replica_db_instance_identifierstyping.List[str]attrReadReplicaDbInstanceIdentifiersList<String>AttrReadReplicaDbInstanceIdentifiersstring[]AttrReadReplicaDbInstanceIdentifiers*[]*string#

The identifiers of the read replicas associated with this DB instance.

attrResumeFullAutomationModeTimestringattr_resume_full_automation_mode_timestrattrResumeFullAutomationModeTimeStringAttrResumeFullAutomationModeTimestringAttrResumeFullAutomationModeTime*string#

The number of minutes to pause the automation.

When the time period ends, RDS Custom resumes full automation. The minimum value is 60 (default). The maximum value is 1,440.

attrSecondaryAvailabilityZonestringattr_secondary_availability_zonestrattrSecondaryAvailabilityZoneStringAttrSecondaryAvailabilityZonestringAttrSecondaryAvailabilityZone*string#

If present, specifies the name of the secondary Availability Zone for a DB instance with multi-AZ support.

attrStatusInfosIResolvableattr_status_infosIResolvableattrStatusInfosIResolvableAttrStatusInfosIResolvableAttrStatusInfosIResolvable#

The status of a read replica.

If the DB instance isn't a read replica, the value is blank.

attrStorageOperationPercentProgressnumberattr_storage_operation_percent_progressint | floatattrStorageOperationPercentProgressNumberAttrStorageOperationPercentProgressdoubleAttrStorageOperationPercentProgress*float64#

attrStorageOperationStatusstringattr_storage_operation_statusstrattrStorageOperationStatusStringAttrStorageOperationStatusstringAttrStorageOperationStatus*string#

automaticBackupReplicationKmsKeyId?may be undefinedstringautomatic_backup_replication_kms_key_id?may be undefinedstrautomaticBackupReplicationKmsKeyId?may be undefinedStringAutomaticBackupReplicationKmsKeyId?may be undefinedstringAutomaticBackupReplicationKmsKeyId?may be undefined*string#

The AWS KMS key identifier for encryption of the replicated automated backups.

automaticBackupReplicationRegion?may be undefinedstringautomatic_backup_replication_region?may be undefinedstrautomaticBackupReplicationRegion?may be undefinedStringAutomaticBackupReplicationRegion?may be undefinedstringAutomaticBackupReplicationRegion?may be undefined*string#

The AWS Region associated with the automated backup.

automaticBackupReplicationRetentionPeriod?may be undefinednumberautomatic_backup_replication_retention_period?may be undefinedint | floatautomaticBackupReplicationRetentionPeriod?may be undefinedNumberAutomaticBackupReplicationRetentionPeriod?may be undefineddoubleAutomaticBackupReplicationRetentionPeriod?may be undefined*float64#

The retention period for automated backups in a different AWS Region.

autoMinorVersionUpgrade?may be undefinedboolean | IResolvableauto_minor_version_upgrade?may be undefinedtyping.Union[bool, IResolvable]autoMinorVersionUpgrade?may be undefinedBooleanAutoMinorVersionUpgrade?may be undefinedboolAutoMinorVersionUpgrade?may be undefinedinterface{}#

A value that indicates whether minor engine upgrades are applied automatically to the DB instance during the maintenance window.

availabilityZone?may be undefinedstringavailability_zone?may be undefinedstravailabilityZone?may be undefinedStringAvailabilityZone?may be undefinedstringAvailabilityZone?may be undefined*string#

The Availability Zone (AZ) where the database will be created.

backupRetentionPeriod?may be undefinednumberbackup_retention_period?may be undefinedint | floatbackupRetentionPeriod?may be undefinedNumberBackupRetentionPeriod?may be undefineddoubleBackupRetentionPeriod?may be undefined*float64#

The number of days for which automated backups are retained.

backupTarget?may be undefinedstringbackup_target?may be undefinedstrbackupTarget?may be undefinedStringBackupTarget?may be undefinedstringBackupTarget?may be undefined*string#

The location for storing automated backups and manual snapshots.

caCertificateIdentifier?may be undefinedstringca_certificate_identifier?may be undefinedstrcaCertificateIdentifier?may be undefinedStringCaCertificateIdentifier?may be undefinedstringCaCertificateIdentifier?may be undefined*string#

The identifier of the CA certificate for this DB instance.

certificateRotationRestart?may be undefinedboolean | IResolvablecertificate_rotation_restart?may be undefinedtyping.Union[bool, IResolvable]certificateRotationRestart?may be undefinedBooleanCertificateRotationRestart?may be undefinedboolCertificateRotationRestart?may be undefinedinterface{}#

Specifies whether the DB instance is restarted when you rotate your SSL/TLS certificate.

CFN_RESOURCE_TYPE_NAMEstringcfn_resource_type_namestrCFN_RESOURCE_TYPE_NAMEStringCFN_RESOURCE_TYPE_NAMEstringCFN_RESOURCE_TYPE_NAME*stringstatic#

The CloudFormation resource type name for this resource class.

cfnOptionsICfnResourceOptionscfn_optionsICfnResourceOptionscfnOptionsICfnResourceOptionsCfnOptionsICfnResourceOptionsCfnOptionsICfnResourceOptions#

Options for this resource, such as condition, update policy etc.

cfnResourceTypestringcfn_resource_typestrcfnResourceTypeStringCfnResourceTypestringCfnResourceType*string#

AWS resource type.

characterSetName?may be undefinedstringcharacter_set_name?may be undefinedstrcharacterSetName?may be undefinedStringCharacterSetName?may be undefinedstringCharacterSetName?may be undefined*string#

For supported engines, indicates that the DB instance should be associated with the specified character set.

copyTagsToSnapshot?may be undefinedboolean | IResolvablecopy_tags_to_snapshot?may be undefinedtyping.Union[bool, IResolvable]copyTagsToSnapshot?may be undefinedBooleanCopyTagsToSnapshot?may be undefinedboolCopyTagsToSnapshot?may be undefinedinterface{}#

Specifies whether to copy tags from the DB instance to snapshots of the DB instance.

creationStackstring[]creation_stacktyping.List[str]creationStackList<String>CreationStackstring[]CreationStack*[]*string#

customIamInstanceProfile?may be undefinedstringcustom_iam_instance_profile?may be undefinedstrcustomIamInstanceProfile?may be undefinedStringCustomIamInstanceProfile?may be undefinedstringCustomIamInstanceProfile?may be undefined*string#

The instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance.

databaseInsightsMode?may be undefinedstringdatabase_insights_mode?may be undefinedstrdatabaseInsightsMode?may be undefinedStringDatabaseInsightsMode?may be undefinedstringDatabaseInsightsMode?may be undefined*string#

The mode of Database Insights to enable for the DB instance.

dbClusterIdentifier?may be undefinedstringdb_cluster_identifier?may be undefinedstrdbClusterIdentifier?may be undefinedStringDbClusterIdentifier?may be undefinedstringDbClusterIdentifier?may be undefined*string#

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

dbClusterSnapshotIdentifier?may be undefinedstringdb_cluster_snapshot_identifier?may be undefinedstrdbClusterSnapshotIdentifier?may be undefinedStringDbClusterSnapshotIdentifier?may be undefinedstringDbClusterSnapshotIdentifier?may be undefined*string#

The identifier for the Multi-AZ DB cluster snapshot to restore from.

dbInstanceClass?may be undefinedstringdb_instance_class?may be undefinedstrdbInstanceClass?may be undefinedStringDbInstanceClass?may be undefinedstringDbInstanceClass?may be undefined*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](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html) in the *Amazon RDS User Guide* or [Aurora DB instance classes](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Concepts.DBInstanceClass.html) in the *Amazon Aurora User Guide* .

dbInstanceIdentifier?may be undefinedstringdb_instance_identifier?may be undefinedstrdbInstanceIdentifier?may be undefinedStringDbInstanceIdentifier?may be undefinedstringDbInstanceIdentifier?may be undefined*string#

A name for the DB instance.

dbInstanceRefDBInstanceReferencedb_instance_refDBInstanceReferencedbInstanceRefDBInstanceReferenceDbInstanceRefDBInstanceReferenceDbInstanceRefDBInstanceReference#

A reference to a DBInstance resource.

dbName?may be undefinedstringdb_name?may be undefinedstrdbName?may be undefinedStringDbName?may be undefinedstringDbName?may be undefined*string#

The meaning of this parameter differs according to the database engine you use.

dbParameterGroupName?may be undefinedstringdb_parameter_group_name?may be undefinedstrdbParameterGroupName?may be undefinedStringDbParameterGroupName?may be undefinedstringDbParameterGroupName?may be undefined*string#

The name of an existing DB parameter group or a reference to an [AWS::RDS::DBParameterGroup](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbparametergroup.html) resource created in the template.

dbSecurityGroups?may be undefinedstring[]db_security_groups?may be undefinedtyping.List[str]dbSecurityGroups?may be undefinedList<String>DbSecurityGroups?may be undefinedstring[]DbSecurityGroups?may be undefined*[]*string#

A list of the DB security groups to assign to the DB instance.

dbSnapshotIdentifier?may be undefinedstringdb_snapshot_identifier?may be undefinedstrdbSnapshotIdentifier?may be undefinedStringDbSnapshotIdentifier?may be undefinedstringDbSnapshotIdentifier?may be undefined*string#

The name or Amazon Resource Name (ARN) of the DB snapshot that's used to restore the DB instance.

dbSubnetGroupName?may be undefinedstringdb_subnet_group_name?may be undefinedstrdbSubnetGroupName?may be undefinedStringDbSubnetGroupName?may be undefinedstringDbSubnetGroupName?may be undefined*string#

A DB subnet group to associate with the DB instance.

dbSystemId?may be undefinedstringdb_system_id?may be undefinedstrdbSystemId?may be undefinedStringDbSystemId?may be undefinedstringDbSystemId?may be undefined*string#

The Oracle system identifier (SID), which is the name of the Oracle database instance that manages your database files.

dedicatedLogVolume?may be undefinedboolean | IResolvablededicated_log_volume?may be undefinedtyping.Union[bool, IResolvable]dedicatedLogVolume?may be undefinedBooleanDedicatedLogVolume?may be undefinedboolDedicatedLogVolume?may be undefinedinterface{}#

Indicates whether the DB instance has a dedicated log volume (DLV) enabled.

deleteAutomatedBackups?may be undefinedboolean | IResolvabledelete_automated_backups?may be undefinedtyping.Union[bool, IResolvable]deleteAutomatedBackups?may be undefinedBooleanDeleteAutomatedBackups?may be undefinedboolDeleteAutomatedBackups?may be undefinedinterface{}#

A value that indicates whether to remove automated backups immediately after the DB instance is deleted.

deletionProtection?may be undefinedboolean | IResolvabledeletion_protection?may be undefinedtyping.Union[bool, IResolvable]deletionProtection?may be undefinedBooleanDeletionProtection?may be undefinedboolDeletionProtection?may be undefinedinterface{}#

Specifies whether the DB instance has deletion protection enabled.

domain?may be undefinedstringdomain?may be undefinedstrdomain?may be undefinedStringDomain?may be undefinedstringDomain?may be undefined*string#

The Active Directory directory ID to create the DB instance in.

domainAuthSecretArn?may be undefinedstringdomain_auth_secret_arn?may be undefinedstrdomainAuthSecretArn?may be undefinedStringDomainAuthSecretArn?may be undefinedstringDomainAuthSecretArn?may be undefined*string#

The ARN for the Secrets Manager secret with the credentials for the user joining the domain.

domainDnsIps?may be undefinedstring[]domain_dns_ips?may be undefinedtyping.List[str]domainDnsIps?may be undefinedList<String>DomainDnsIps?may be undefinedstring[]DomainDnsIps?may be undefined*[]*string#

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

domainFqdn?may be undefinedstringdomain_fqdn?may be undefinedstrdomainFqdn?may be undefinedStringDomainFqdn?may be undefinedstringDomainFqdn?may be undefined*string#

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

domainIamRoleName?may be undefinedstringdomain_iam_role_name?may be undefinedstrdomainIamRoleName?may be undefinedStringDomainIamRoleName?may be undefinedstringDomainIamRoleName?may be undefined*string#

The name of the IAM role to use when making API calls to the Directory Service.

domainOu?may be undefinedstringdomain_ou?may be undefinedstrdomainOu?may be undefinedStringDomainOu?may be undefinedstringDomainOu?may be undefined*string#

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

enableCloudwatchLogsExports?may be undefinedstring[]enable_cloudwatch_logs_exports?may be undefinedtyping.List[str]enableCloudwatchLogsExports?may be undefinedList<String>EnableCloudwatchLogsExports?may be undefinedstring[]EnableCloudwatchLogsExports?may be undefined*[]*string#

The list of log types that need to be enabled for exporting to CloudWatch Logs.

enableIamDatabaseAuthentication?may be undefinedboolean | IResolvableenable_iam_database_authentication?may be undefinedtyping.Union[bool, IResolvable]enableIamDatabaseAuthentication?may be undefinedBooleanEnableIamDatabaseAuthentication?may be undefinedboolEnableIamDatabaseAuthentication?may be undefinedinterface{}#

A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts.

enablePerformanceInsights?may be undefinedboolean | IResolvableenable_performance_insights?may be undefinedtyping.Union[bool, IResolvable]enablePerformanceInsights?may be undefinedBooleanEnablePerformanceInsights?may be undefinedboolEnablePerformanceInsights?may be undefinedinterface{}#

Specifies whether to enable Performance Insights for the DB instance.

engine?may be undefinedstringengine?may be undefinedstrengine?may be undefinedStringEngine?may be undefinedstringEngine?may be undefined*string#

The name of the database engine to use for this DB instance.

engineLifecycleSupport?may be undefinedstringengine_lifecycle_support?may be undefinedstrengineLifecycleSupport?may be undefinedStringEngineLifecycleSupport?may be undefinedstringEngineLifecycleSupport?may be undefined*string#

The life cycle type for this DB instance.

engineVersion?may be undefinedstringengine_version?may be undefinedstrengineVersion?may be undefinedStringEngineVersion?may be undefinedstringEngineVersion?may be undefined*string#

The version number of the database engine to use.

envResourceEnvironmentenvResourceEnvironmentenvResourceEnvironmentEnvResourceEnvironmentEnvResourceEnvironment#

iops?may be undefinednumberiops?may be undefinedint | floatiops?may be undefinedNumberIops?may be undefineddoubleIops?may be undefined*float64#

The number of I/O operations per second (IOPS) that the database provisions.

kmsKeyId?may be undefinedstringkms_key_id?may be undefinedstrkmsKeyId?may be undefinedStringKmsKeyId?may be undefinedstringKmsKeyId?may be undefined*string#

The ARN of the AWS KMS key that's used to encrypt the DB instance, such as `arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef` .

licenseModel?may be undefinedstringlicense_model?may be undefinedstrlicenseModel?may be undefinedStringLicenseModel?may be undefinedstringLicenseModel?may be undefined*string#

License model information for this DB instance.

logicalIdstringlogical_idstrlogicalIdStringLogicalIdstringLogicalId*string#

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

manageMasterUserPassword?may be undefinedboolean | IResolvablemanage_master_user_password?may be undefinedtyping.Union[bool, IResolvable]manageMasterUserPassword?may be undefinedBooleanManageMasterUserPassword?may be undefinedboolManageMasterUserPassword?may be undefinedinterface{}#

Specifies whether to manage the master user password with AWS Secrets Manager.

masterUserAuthenticationType?may be undefinedstringmaster_user_authentication_type?may be undefinedstrmasterUserAuthenticationType?may be undefinedStringMasterUserAuthenticationType?may be undefinedstringMasterUserAuthenticationType?may be undefined*string#

Specifies the authentication type for the master user.

masterUsername?may be undefinedstringmaster_username?may be undefinedstrmasterUsername?may be undefinedStringMasterUsername?may be undefinedstringMasterUsername?may be undefined*string#

The master user name for the DB instance.

masterUserPassword?may be undefinedstringmaster_user_password?may be undefinedstrmasterUserPassword?may be undefinedStringMasterUserPassword?may be undefinedstringMasterUserPassword?may be undefined*string#

The password for the master user.

The password can include any printable ASCII character except "/", """, or "@".

masterUserSecret?may be undefinedIResolvable | CfnDBInstance.MasterUserSecretPropertymaster_user_secret?may be undefinedtyping.Union[IResolvable, MasterUserSecretProperty]masterUserSecret?may be undefinedIResolvableMasterUserSecret?may be undefinedIResolvableMasterUserSecret?may be undefinedinterface{}#

The secret managed by RDS in AWS Secrets Manager for the master user password.

maxAllocatedStorage?may be undefinednumbermax_allocated_storage?may be undefinedint | floatmaxAllocatedStorage?may be undefinedNumberMaxAllocatedStorage?may be undefineddoubleMaxAllocatedStorage?may be undefined*float64#

The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance.

monitoringInterval?may be undefinednumbermonitoring_interval?may be undefinedint | floatmonitoringInterval?may be undefinedNumberMonitoringInterval?may be undefineddoubleMonitoringInterval?may be undefined*float64#

The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance.

monitoringRoleArn?may be undefinedstringmonitoring_role_arn?may be undefinedstrmonitoringRoleArn?may be undefinedStringMonitoringRoleArn?may be undefinedstringMonitoringRoleArn?may be undefined*string#

The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs.

multiAz?may be undefinedboolean | IResolvablemulti_az?may be undefinedtyping.Union[bool, IResolvable]multiAz?may be undefinedBooleanMultiAz?may be undefinedboolMultiAz?may be undefinedinterface{}#

Specifies whether the DB instance is a Multi-AZ deployment.

ncharCharacterSetName?may be undefinedstringnchar_character_set_name?may be undefinedstrncharCharacterSetName?may be undefinedStringNcharCharacterSetName?may be undefinedstringNcharCharacterSetName?may be undefined*string#

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

networkType?may be undefinedstringnetwork_type?may be undefinedstrnetworkType?may be undefinedStringNetworkType?may be undefinedstringNetworkType?may be undefined*string#

The network type of the DB instance.

nodeNodenodeNodenodeNodeNodeNodeNodeNode#

The tree node.

optionGroupName?may be undefinedstringoption_group_name?may be undefinedstroptionGroupName?may be undefinedStringOptionGroupName?may be undefinedstringOptionGroupName?may be undefined*string#

Indicates that the DB instance should be associated with the specified option group.

performanceInsightsKmsKeyId?may be undefinedstringperformance_insights_kms_key_id?may be undefinedstrperformanceInsightsKmsKeyId?may be undefinedStringPerformanceInsightsKmsKeyId?may be undefinedstringPerformanceInsightsKmsKeyId?may be undefined*string#

The AWS KMS key identifier for encryption of Performance Insights data.

performanceInsightsRetentionPeriod?may be undefinednumberperformance_insights_retention_period?may be undefinedint | floatperformanceInsightsRetentionPeriod?may be undefinedNumberPerformanceInsightsRetentionPeriod?may be undefineddoublePerformanceInsightsRetentionPeriod?may be undefined*float64#

The number of days to retain Performance Insights data.

port?may be undefinedstringport?may be undefinedstrport?may be undefinedStringPort?may be undefinedstringPort?may be undefined*string#

The port number on which the database accepts connections.

preferredBackupWindow?may be undefinedstringpreferred_backup_window?may be undefinedstrpreferredBackupWindow?may be undefinedStringPreferredBackupWindow?may be undefinedstringPreferredBackupWindow?may be undefined*string#

The daily time range during which automated backups are created if automated backups are enabled, using the `BackupRetentionPeriod` parameter.

preferredMaintenanceWindow?may be undefinedstringpreferred_maintenance_window?may be undefinedstrpreferredMaintenanceWindow?may be undefinedStringPreferredMaintenanceWindow?may be undefinedstringPreferredMaintenanceWindow?may be undefined*string#

The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

processorFeatures?may be undefinedIResolvable | IResolvable | CfnDBInstance.ProcessorFeatureProperty[]processor_features?may be undefinedtyping.Union[IResolvable, typing.List[typing.Union[IResolvable, ProcessorFeatureProperty]]]processorFeatures?may be undefinedIResolvableProcessorFeatures?may be undefinedIResolvableProcessorFeatures?may be undefinedinterface{}#

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

promotionTier?may be undefinednumberpromotion_tier?may be undefinedint | floatpromotionTier?may be undefinedNumberPromotionTier?may be undefineddoublePromotionTier?may be undefined*float64#

The order of priority in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance.

publiclyAccessible?may be undefinedboolean | IResolvablepublicly_accessible?may be undefinedtyping.Union[bool, IResolvable]publiclyAccessible?may be undefinedBooleanPubliclyAccessible?may be undefinedboolPubliclyAccessible?may be undefinedinterface{}#

Indicates whether the DB instance is an internet-facing instance.

refstringrefstrrefStringRefstringRef*string#

Return a string that will be resolved to a CloudFormation `{ Ref }` for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

replicaMode?may be undefinedstringreplica_mode?may be undefinedstrreplicaMode?may be undefinedStringReplicaMode?may be undefinedstringReplicaMode?may be undefined*string#

The open mode of an Oracle read replica.

restoreTime?may be undefinedstringrestore_time?may be undefinedstrrestoreTime?may be undefinedStringRestoreTime?may be undefinedstringRestoreTime?may be undefined*string#

The date and time to restore from.

sourceDbClusterIdentifier?may be undefinedstringsource_db_cluster_identifier?may be undefinedstrsourceDbClusterIdentifier?may be undefinedStringSourceDbClusterIdentifier?may be undefinedstringSourceDbClusterIdentifier?may be undefined*string#

The identifier of the Multi-AZ DB cluster that will act as the source for the read replica.

sourceDbInstanceAutomatedBackupsArn?may be undefinedstringsource_db_instance_automated_backups_arn?may be undefinedstrsourceDbInstanceAutomatedBackupsArn?may be undefinedStringSourceDbInstanceAutomatedBackupsArn?may be undefinedstringSourceDbInstanceAutomatedBackupsArn?may be undefined*string#

The Amazon Resource Name (ARN) of the replicated automated backups from which to restore, for example, `arn:aws:rds:us-east-1:123456789012:auto-backup:ab-L2IJCEXJP7XQ7HOJ4SIEXAMPLE` .

sourceDbInstanceIdentifier?may be undefinedstringsource_db_instance_identifier?may be undefinedstrsourceDbInstanceIdentifier?may be undefinedStringSourceDbInstanceIdentifier?may be undefinedstringSourceDbInstanceIdentifier?may be undefined*string#

If you want to create a read replica DB instance, specify the ID of the source DB instance.

sourceDbiResourceId?may be undefinedstringsource_dbi_resource_id?may be undefinedstrsourceDbiResourceId?may be undefinedStringSourceDbiResourceId?may be undefinedstringSourceDbiResourceId?may be undefined*string#

The resource ID of the source DB instance from which to restore.

sourceRegion?may be undefinedstringsource_region?may be undefinedstrsourceRegion?may be undefinedStringSourceRegion?may be undefinedstringSourceRegion?may be undefined*string#

The ID of the region that contains the source DB instance for the read replica.

stackStackstackStackstackStackStackStackStackStack#

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

storageEncrypted?may be undefinedboolean | IResolvablestorage_encrypted?may be undefinedtyping.Union[bool, IResolvable]storageEncrypted?may be undefinedBooleanStorageEncrypted?may be undefinedboolStorageEncrypted?may be undefinedinterface{}#

A value that indicates whether the DB instance is encrypted.

By default, it isn't encrypted.

storageThroughput?may be undefinednumberstorage_throughput?may be undefinedint | floatstorageThroughput?may be undefinedNumberStorageThroughput?may be undefineddoubleStorageThroughput?may be undefined*float64#

Specifies the storage throughput value, in mebibyte per second (MiBps), for the DB instance.

storageType?may be undefinedstringstorage_type?may be undefinedstrstorageType?may be undefinedStringStorageType?may be undefinedstringStorageType?may be undefined*string#

The storage type to associate with the DB instance.

tagsTagManagertagsTagManagertagsTagManagerTagsTagManagerTagsTagManager#

Tag Manager which manages the tags for this resource.

tagsRaw?may be undefinedCfnTag[]tags_raw?may be undefinedtyping.List[CfnTag]tagsRaw?may be undefinedList<CfnTag>TagsRaw?may be undefinedCfnTag[]TagsRaw?may be undefined*[]CfnTag#

Tags to assign to the DB instance.

tdeCredentialArn?may be undefinedstringtde_credential_arn?may be undefinedstrtdeCredentialArn?may be undefinedStringTdeCredentialArn?may be undefinedstringTdeCredentialArn?may be undefined*stringdeprecated#

this property has been deprecated

tdeCredentialPassword?may be undefinedstringtde_credential_password?may be undefinedstrtdeCredentialPassword?may be undefinedStringTdeCredentialPassword?may be undefinedstringTdeCredentialPassword?may be undefined*stringdeprecated#

this property has been deprecated

timezone?may be undefinedstringtimezone?may be undefinedstrtimezone?may be undefinedStringTimezone?may be undefinedstringTimezone?may be undefined*string#

The time zone of the DB instance.

useDefaultProcessorFeatures?may be undefinedboolean | IResolvableuse_default_processor_features?may be undefinedtyping.Union[bool, IResolvable]useDefaultProcessorFeatures?may be undefinedBooleanUseDefaultProcessorFeatures?may be undefinedboolUseDefaultProcessorFeatures?may be undefinedinterface{}#

Specifies whether the DB instance class of the DB instance uses its default processor features.

useLatestRestorableTime?may be undefinedboolean | IResolvableuse_latest_restorable_time?may be undefinedtyping.Union[bool, IResolvable]useLatestRestorableTime?may be undefinedBooleanUseLatestRestorableTime?may be undefinedboolUseLatestRestorableTime?may be undefinedinterface{}#

Specifies whether the DB instance is restored from the latest backup time.

vpcSecurityGroups?may be undefinedstring[]vpc_security_groups?may be undefinedtyping.List[str]vpcSecurityGroups?may be undefinedList<String>VpcSecurityGroups?may be undefinedstring[]VpcSecurityGroups?may be undefined*[]*string#

A list of the VPC security group IDs to assign to the DB instance.

Methods

addDeletionOverride(path: string): voiddef add_deletion_override(self, path: str) -> Nonepublic void addDeletionOverride(String path)public void AddDeletionOverride(string path)func AddDeletionOverride(Path *string)#

Syntactic sugar for `addOverride(path, undefined)`.

1 parameter

Parameters

• pathpathpathpathPath — The path of the value to delete.

addDependency(target: CfnResource): voiddef add_dependency(self, target: CfnResource) -> Nonepublic void addDependency(CfnResource target)public void AddDependency(CfnResource target)func AddDependency(Target CfnResource)deprecated#

Use `addResourceDependency` instead.

This method has been renamed to addResourceDependency to more clearly set it apart from construct.node.addDependency. See the documentation of that function for more details.

addDependsOn(target: CfnResource): voiddef add_depends_on(self, target: CfnResource) -> Nonepublic void addDependsOn(CfnResource target)public void AddDependsOn(CfnResource target)func AddDependsOn(Target CfnResource)deprecated#

Use `addResourceDependency` instead.

notes

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

This method has been renamed to addResourceDependency, which makes it more clear that this method operates at a different level from the construct-level construct.node.addDependency() mechanism.

addMetadata(key: string, value: any): voiddef add_metadata(self, key: str, value: Any) -> Nonepublic void addMetadata(String key, Object value)public void AddMetadata(string key, object value)func AddMetadata(Key *string, Value interface{})#

Add a value to the CloudFormation Resource Metadata.

addOverride(path: string, value: any): voiddef add_override(self, path: str, value: Any) -> Nonepublic void addOverride(String path, Object value)public void AddOverride(string path, object value)func AddOverride(Path *string, Value interface{})#

Adds an override to the synthesized CloudFormation resource.

notes · 2 parameters

To add a property override, either use addPropertyOverride or prefix path with "Properties." (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example,

cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');

would add the overrides

"Properties": {
  "GlobalSecondaryIndexes": [
    {
      "Projection": {
        "NonKeyAttributes": [ "myattribute" ]
        ...
      }
      ...
    },
    {
      "ProjectionType": "INCLUDE"
      ...
    },
  ]
  ...
}

The value argument to addOverride will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

Parameters

• pathpathpathpathPath — - The path of the property, you can use dot notation to override values in complex types.
• valuevaluevaluevalueValue — - The value.

addPropertyDeletionOverride(propertyPath: string): voiddef add_property_deletion_override(self, property_path: str) -> Nonepublic void addPropertyDeletionOverride(String propertyPath)public void AddPropertyDeletionOverride(string propertyPath)func AddPropertyDeletionOverride(PropertyPath *string)#

Adds an override that deletes the value of a property from the resource definition.

1 parameter

Parameters

• propertyPathproperty_pathpropertyPathpropertyPathPropertyPath — The path to the property.

addPropertyOverride(propertyPath: string, value: any): voiddef add_property_override(self, property_path: str, value: Any) -> Nonepublic void addPropertyOverride(String propertyPath, Object value)public void AddPropertyOverride(string propertyPath, object value)func AddPropertyOverride(PropertyPath *string, Value interface{})#

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

2 parameters

Parameters

• propertyPathproperty_pathpropertyPathpropertyPathPropertyPath — The path of the property.
• valuevaluevaluevalueValue — The value.

addResourceDependency(target: CfnResource, reason?: string): voiddef add_resource_dependency(self, target: CfnResource, reason: typing.Optional[str] = None) -> Nonepublic void addResourceDependency(CfnResource target, String reason)public void AddResourceDependency(CfnResource target, string? reason = null)func AddResourceDependency(Target CfnResource, Reason *string)#

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

notes

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

This method only adds dependencies between L1 resources. If you are looking for a generic construct-to-construct dependency mechanism that works for all constructs including L2s, use construct.node.addDependency instead.

applyCrossStackReferenceStrength(strength: ReferenceStrength): voiddef apply_cross_stack_reference_strength(self, strength: ReferenceStrength) -> Nonepublic void applyCrossStackReferenceStrength(ReferenceStrength strength)public void ApplyCrossStackReferenceStrength(ReferenceStrength strength)func ApplyCrossStackReferenceStrength(Strength ReferenceStrength)#

Sets the cross-stack reference strength for this resource.

When set, any cross-stack reference to this resource will use the specified strength instead of the global default from the consuming stack's context.

1 parameter

Parameters

• strengthstrengthstrengthstrengthStrength — - The reference strength to use for this resource.

applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): voiddef apply_removal_policy(self, policy: typing.Optional[RemovalPolicy] = None, options: typing.Optional[RemovalPolicyOptions] = None) -> Nonepublic void applyRemovalPolicy(RemovalPolicy policy, RemovalPolicyOptions options)public void ApplyRemovalPolicy(RemovalPolicy? policy = null, RemovalPolicyOptions? options = null)func ApplyRemovalPolicy(Policy RemovalPolicy, Options RemovalPolicyOptions)#

Sets the deletion policy of the resource based on the removal policy specified.

notes

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:

arnForDBInstance(resource: IDBInstanceRef): string@staticmethod def arn_for_db_instance(resource: IDBInstanceRef) -> strpublic static String arnForDBInstance(IDBInstanceRef resource)public static string ArnForDBInstance(IDBInstanceRef resource)func ArnForDBInstance(Resource IDBInstanceRef) *stringstatic#

cfnPropertyName(cdkPropertyName: string): stringdef cfn_property_name(self, cdk_property_name: str) -> strpublic String cfnPropertyName(String cdkPropertyName)public string CfnPropertyName(string cdkPropertyName)func CfnPropertyName(CdkPropertyName *string) *string#

getAtt(attributeName: string, typeHint?: ResolutionTypeHint): Referencedef get_att(self, attribute_name: str, type_hint: typing.Optional[ResolutionTypeHint] = None) -> Referencepublic Reference getAtt(String attributeName, ResolutionTypeHint typeHint)public Reference GetAtt(string attributeName, ResolutionTypeHint? typeHint = null)func GetAtt(AttributeName *string, TypeHint ResolutionTypeHint) Reference#

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

1 parameter

Parameters

• attributeNameattribute_nameattributeNameattributeNameAttributeName — The name of the attribute.

getMetadata(key: string): anydef get_metadata(self, key: str) -> Anypublic Object getMetadata(String key)public object GetMetadata(string key)func GetMetadata(Key *string) interface{}#

Retrieve a value value from the CloudFormation Resource Metadata.

inspect(inspector: TreeInspector): voiddef inspect(self, inspector: TreeInspector) -> Nonepublic void inspect(TreeInspector inspector)public void Inspect(TreeInspector inspector)func Inspect(Inspector TreeInspector)#

Examines the CloudFormation resource and discloses attributes.

1 parameter

Parameters

• inspectorinspectorinspectorinspectorInspector — tree inspector to collect and process attributes.

isCfnDBInstance(x: any): boolean@staticmethod def is_cfn_db_instance(x: Any) -> boolpublic static Boolean isCfnDBInstance(Object x)public static bool IsCfnDBInstance(object x)func IsCfnDBInstance(X interface{}) *boolstatic#

Checks whether the given object is a CfnDBInstance.

isCfnElement(x: any): boolean@staticmethod def is_cfn_element(x: Any) -> boolpublic static Boolean isCfnElement(Object x)public static bool IsCfnElement(object x)func IsCfnElement(X interface{}) *boolstatic#

Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of instanceof to allow stack elements from different versions of this library to be included in the same stack.

returns

Returns: The construct as a stack element or undefined if it is not a stack element.

isCfnResource(x: any): boolean@staticmethod def is_cfn_resource(x: Any) -> boolpublic static Boolean isCfnResource(Object x)public static bool IsCfnResource(object x)func IsCfnResource(X interface{}) *boolstatic#

Check whether the given object is a CfnResource.

isConstruct(x: any): boolean@staticmethod def is_construct(x: Any) -> boolpublic static Boolean isConstruct(Object x)public static bool IsConstruct(object x)func IsConstruct(X interface{}) *boolstatic#

Checks if `x` is a construct.

notes · 1 parameter · returns

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

Parameters

• xxxxX — Any object.

Returns: true if x is an object created from a class which extends Construct.

obtainDependencies(): Stack | CfnResource[]def obtain_dependencies(self, ) -> typing.List[typing.Union[Stack, CfnResource]]public List<Stack> obtainDependencies()public Stack[] ObtainDependencies()func ObtainDependencies() *[]interface{}#

Retrieves an array of resources and stacks this resource depends on.

For resources depended on directly, returns the CfnResource object. For dependencies on other stacks, returns the Stack object. The order of the array is not guaranteed.

overrideLogicalId(newLogicalId: string): voiddef override_logical_id(self, new_logical_id: str) -> Nonepublic void overrideLogicalId(String newLogicalId)public void OverrideLogicalId(string newLogicalId)func OverrideLogicalId(NewLogicalId *string)#

Overrides the auto-generated logical ID with a specific ID.

1 parameter

Parameters

• newLogicalIdnew_logical_idnewLogicalIdnewLogicalIdNewLogicalId — The new logical ID to use for this stack element.

removeDependency(target: CfnResource): voiddef remove_dependency(self, target: CfnResource) -> Nonepublic void removeDependency(CfnResource target)public void RemoveDependency(CfnResource target)func RemoveDependency(Target CfnResource)deprecated#

Use `removeResourceDependency` instead

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

removeResourceDependency(target: CfnResource): voiddef remove_resource_dependency(self, target: CfnResource) -> Nonepublic void removeResourceDependency(CfnResource target)public void RemoveResourceDependency(CfnResource target)func RemoveResourceDependency(Target CfnResource)#

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

replaceDependency(target: CfnResource, newTarget: CfnResource): voiddef replace_dependency(self, target: CfnResource, new_target: CfnResource) -> Nonepublic void replaceDependency(CfnResource target, CfnResource newTarget)public void ReplaceDependency(CfnResource target, CfnResource newTarget)func ReplaceDependency(Target CfnResource, NewTarget CfnResource)#

Replaces one dependency with another.

2 parameters

Parameters

• targettargettargettargetTarget — The dependency to replace.
• newTargetnew_targetnewTargetnewTargetNewTarget — The new dependency to add.

toString(): stringdef to_string(self, ) -> strpublic String toString()public string ToString()func ToString() *string#

Returns a string representation of this construct.

returns

Returns: a string representation of this resource

with(...mixins: IMixin[]): IConstructdef with(self, mixins: IMixin) -> IConstructpublic IConstruct with(IMixin mixins)public IConstruct With(IMixin mixins)func With(Mixins IMixin) IConstruct#

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.