AWS::RDS::DBInstance
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.
Important
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.
Important
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 theDBSnapshotIdentifier
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 theDBSnapshotIdentifier
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 specifiedDBSnapshotIdentifier
property, and the original DB instance is deleted. -
Update the stack.
For more information about updating other properties of this resource, see
ModifyDBInstance
. 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 theDBClusterIdentifier
property, AWS CloudFormation saves a snapshot of the DB instance. -
For
AWS::RDS::DBInstance
resources that do specify theDBClusterIdentifier
property, AWS CloudFormation deletes the DB instance.
For more information, see DeletionPolicy Attribute.
Syntax
To declare this entity in your AWS CloudFormation template, use the following syntax:
JSON
{ "Type" : "AWS::RDS::DBInstance", "Properties" : { "AllocatedStorage" :
String
, "AllowMajorVersionUpgrade" :Boolean
, "AssociatedRoles" :[ DBInstanceRole, ... ]
, "AutomaticBackupReplicationKmsKeyId" :String
, "AutomaticBackupReplicationRegion" :String
, "AutoMinorVersionUpgrade" :Boolean
, "AvailabilityZone" :String
, "BackupRetentionPeriod" :Integer
, "CACertificateIdentifier" :String
, "CertificateDetails" :CertificateDetails
, "CertificateRotationRestart" :Boolean
, "CharacterSetName" :String
, "CopyTagsToSnapshot" :Boolean
, "CustomIAMInstanceProfile" :String
, "DBClusterIdentifier" :String
, "DBClusterSnapshotIdentifier" :String
, "DBInstanceClass" :String
, "DBInstanceIdentifier" :String
, "DBName" :String
, "DBParameterGroupName" :String
, "DBSecurityGroups" :[ String, ... ]
, "DBSnapshotIdentifier" :String
, "DBSubnetGroupName" :String
, "DBSystemId" :String
, "DedicatedLogVolume" :Boolean
, "DeleteAutomatedBackups" :Boolean
, "DeletionProtection" :Boolean
, "Domain" :String
, "DomainAuthSecretArn" :String
, "DomainDnsIps" :[ String, ... ]
, "DomainFqdn" :String
, "DomainIAMRoleName" :String
, "DomainOu" :String
, "EnableCloudwatchLogsExports" :[ String, ... ]
, "EnableIAMDatabaseAuthentication" :Boolean
, "EnablePerformanceInsights" :Boolean
, "Endpoint" :Endpoint
, "Engine" :String
, "EngineLifecycleSupport" :String
, "EngineVersion" :String
, "Iops" :Integer
, "KmsKeyId" :String
, "LicenseModel" :String
, "ManageMasterUserPassword" :Boolean
, "MasterUsername" :String
, "MasterUserPassword" :String
, "MasterUserSecret" :MasterUserSecret
, "MaxAllocatedStorage" :Integer
, "MonitoringInterval" :Integer
, "MonitoringRoleArn" :String
, "MultiAZ" :Boolean
, "NcharCharacterSetName" :String
, "NetworkType" :String
, "OptionGroupName" :String
, "PerformanceInsightsKMSKeyId" :String
, "PerformanceInsightsRetentionPeriod" :Integer
, "Port" :String
, "PreferredBackupWindow" :String
, "PreferredMaintenanceWindow" :String
, "ProcessorFeatures" :[ ProcessorFeature, ... ]
, "PromotionTier" :Integer
, "PubliclyAccessible" :Boolean
, "ReplicaMode" :String
, "RestoreTime" :String
, "SourceDBClusterIdentifier" :String
, "SourceDBInstanceAutomatedBackupsArn" :String
, "SourceDBInstanceIdentifier" :String
, "SourceDbiResourceId" :String
, "SourceRegion" :String
, "StorageEncrypted" :Boolean
, "StorageThroughput" :Integer
, "StorageType" :String
, "Tags" :[ Tag, ... ]
, "Timezone" :String
, "UseDefaultProcessorFeatures" :Boolean
, "UseLatestRestorableTime" :Boolean
, "VPCSecurityGroups" :[ String, ... ]
} }
YAML
Type: AWS::RDS::DBInstance Properties: AllocatedStorage:
String
AllowMajorVersionUpgrade:Boolean
AssociatedRoles:- DBInstanceRole
AutomaticBackupReplicationKmsKeyId:String
AutomaticBackupReplicationRegion:String
AutoMinorVersionUpgrade:Boolean
AvailabilityZone:String
BackupRetentionPeriod:Integer
CACertificateIdentifier:String
CertificateDetails:CertificateDetails
CertificateRotationRestart:Boolean
CharacterSetName:String
CopyTagsToSnapshot:Boolean
CustomIAMInstanceProfile:String
DBClusterIdentifier:String
DBClusterSnapshotIdentifier:String
DBInstanceClass:String
DBInstanceIdentifier:String
DBName:String
DBParameterGroupName:String
DBSecurityGroups:- String
DBSnapshotIdentifier:String
DBSubnetGroupName:String
DBSystemId:String
DedicatedLogVolume:Boolean
DeleteAutomatedBackups:Boolean
DeletionProtection:Boolean
Domain:String
DomainAuthSecretArn:String
DomainDnsIps:- String
DomainFqdn:String
DomainIAMRoleName:String
DomainOu:String
EnableCloudwatchLogsExports:- String
EnableIAMDatabaseAuthentication:Boolean
EnablePerformanceInsights:Boolean
Endpoint:Endpoint
Engine:String
EngineLifecycleSupport:String
EngineVersion:String
Iops:Integer
KmsKeyId:String
LicenseModel:String
ManageMasterUserPassword:Boolean
MasterUsername:String
MasterUserPassword:String
MasterUserSecret:MasterUserSecret
MaxAllocatedStorage:Integer
MonitoringInterval:Integer
MonitoringRoleArn:String
MultiAZ:Boolean
NcharCharacterSetName:String
NetworkType:String
OptionGroupName:String
PerformanceInsightsKMSKeyId:String
PerformanceInsightsRetentionPeriod:Integer
Port:String
PreferredBackupWindow:String
PreferredMaintenanceWindow:String
ProcessorFeatures:- ProcessorFeature
PromotionTier:Integer
PubliclyAccessible:Boolean
ReplicaMode:String
RestoreTime:String
SourceDBClusterIdentifier:String
SourceDBInstanceAutomatedBackupsArn:String
SourceDBInstanceIdentifier:String
SourceDbiResourceId:String
SourceRegion:String
StorageEncrypted:Boolean
StorageThroughput:Integer
StorageType:String
Tags:- Tag
Timezone:String
UseDefaultProcessorFeatures:Boolean
UseLatestRestorableTime:Boolean
VPCSecurityGroups:- String
Properties
AllocatedStorage
-
The amount of storage in gibibytes (GiB) to be initially allocated for the database instance.
Note
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 theIops
value (in 1,000 IOPS increments), then you must also increase theAllocatedStorage
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.
-
Required: Conditional
Type: String
Pattern:
^[0-9]*$
Update requires: No interruption
-
AllowMajorVersionUpgrade
-
A value that indicates whether major version upgrades are allowed. 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.Required: No
Type: Boolean
Update requires: No interruption
AssociatedRoles
-
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.
Required: No
Type: Array of DBInstanceRole
Update requires: No interruption
AutomaticBackupReplicationKmsKeyId
-
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
.Required: No
Type: String
Update requires: No interruption
AutomaticBackupReplicationRegion
-
The AWS Region associated with the automated backup.
Required: No
Type: String
Update requires: No interruption
AutoMinorVersionUpgrade
-
A value that indicates whether minor engine upgrades are applied automatically to the DB instance during the maintenance window. By default, minor engine upgrades are applied automatically.
Required: No
Type: Boolean
Update requires: Some interruptions
AvailabilityZone
-
The Availability Zone (AZ) where the database will be created. For information on AWS Regions and Availability Zones, see Regions and Availability Zones.
For Amazon Aurora, each Aurora DB cluster hosts copies of its storage in three separate Availability Zones. Specify one of these Availability Zones. Aurora automatically chooses an appropriate Availability Zone if you don't specify one.
Default: A random, system-chosen Availability Zone in the endpoint's AWS Region.
Constraints:
-
The
AvailabilityZone
parameter can't be specified if the DB instance is a Multi-AZ deployment. -
The specified Availability Zone must be in the same AWS Region as the current endpoint.
Example:
us-east-1d
Required: No
Type: String
Update requires: Some interruptions
-
BackupRetentionPeriod
-
The number of days for which automated backups are retained. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups.
Amazon Aurora
Not applicable. The retention period for automated backups is managed by the DB cluster.
Default: 1
Constraints:
-
Must be a value from 0 to 35
-
Can't be set to 0 if the DB instance is a source to read replicas
Required: No
Type: Integer
Minimum:
0
Update requires: Some interruptions
-
CACertificateIdentifier
-
The identifier of the CA certificate for this DB instance.
For more information, see Using SSL/TLS to encrypt a connection to a DB instance in the Amazon RDS User Guide and Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora User Guide.
Required: No
Type: String
Update requires: No interruption
CertificateDetails
-
The details of the DB instance's server certificate.
Required: No
Type: CertificateDetails
Update requires: No interruption
CertificateRotationRestart
-
Specifies whether the DB instance is restarted when you rotate your SSL/TLS certificate.
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.
Important
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.
Required: No
Type: Boolean
Update requires: No interruption
-
CharacterSetName
-
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.
Required: No
Type: String
Update requires: Replacement
-
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.
Required: No
Type: Boolean
Update requires: No interruption
CustomIAMInstanceProfile
-
The instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance.
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.
Required: No
Type: String
Update requires: Replacement
-
DBClusterIdentifier
-
The identifier of the DB cluster that this DB instance will belong to.
This setting doesn't apply to RDS Custom DB instances.
Required: No
Type: String
Update requires: Replacement
DBClusterSnapshotIdentifier
-
The identifier for the Multi-AZ DB cluster snapshot to restore from.
For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.
Constraints:
-
Must match the identifier of an existing Multi-AZ DB cluster snapshot.
-
Can't be specified when
DBSnapshotIdentifier
is specified. -
Must be specified when
DBSnapshotIdentifier
isn't specified. -
If you are restoring from a shared manual Multi-AZ DB cluster snapshot, the
DBClusterSnapshotIdentifier
must be the ARN of the shared snapshot. -
Can't be the identifier of an Aurora DB cluster snapshot.
Required: No
Type: String
Update requires: Some interruptions
-
DBInstanceClass
-
The compute and memory capacity of the DB instance, for example
db.m5.large
. Not all DB instance classes are available in all AWS Regions, or for all database engines. For the full list of DB instance classes, and availability for your engine, see DB instance classes in the Amazon RDS User Guide or Aurora DB instance classes in the Amazon Aurora User Guide.Required: No
Type: String
Update requires: Some interruptions
DBInstanceIdentifier
-
A name for the DB instance. If you specify a name, AWS CloudFormation converts it to lowercase. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the DB instance. For more information, see Name Type.
For information about constraints that apply to DB instance identifiers, see Naming constraints in Amazon RDS in the Amazon RDS User Guide.
Important
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.
Required: No
Type: String
Pattern:
^$|^[a-zA-Z]{1}(?:-?[a-zA-Z0-9]){0,62}$
Minimum:
1
Maximum:
63
Update requires: Replacement
DBName
-
The meaning of this parameter differs according to the database engine you use.
Important
If you specify the
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 valueORCL
is used. You can't specify the string NULL, or any other reserved word, forDBName
.Default:
ORCL
Constraints:
-
Can't be longer than 8 characters
SQL Server
Not applicable. Must be null.
Required: No
Type: String
Update requires: Replacement
-
DBParameterGroupName
-
The name of an existing DB parameter group or a reference to an AWS::RDS::DBParameterGroup resource created in the template.
To list all of the available DB parameter group names, use the following command:
aws rds describe-db-parameter-groups --query "DBParameterGroups[].DBParameterGroupName" --output text
Note
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.Required: No
Type: String
Update requires: Some interruptions
DBSecurityGroups
-
A list of the DB security groups to assign to the DB instance. The list can include both the name of existing DB security groups or references to AWS::RDS::DBSecurityGroup resources created in the template.
If you set DBSecurityGroups, you must not set VPCSecurityGroups, and vice versa. Also, note that the DBSecurityGroups property exists only for backwards compatibility with older regions and is no longer recommended for providing security information to an RDS DB instance. Instead, use VPCSecurityGroups.
Important
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
, orKmsKeyId
. If you're already using theDBSecurityGroups
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.Required: No
Type: Array of String
Update requires: No interruption
-
DBSnapshotIdentifier
-
The name or Amazon Resource Name (ARN) of the DB snapshot that's used to restore the DB instance. 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 theAWS::RDS::DBInstance
declaration has noDBSnapshotIdentifier
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
andMasterUserPassword
properties. For information about the properties that you can specify, see theRestoreDBInstanceFromDBSnapshot
action in the Amazon RDS API Reference.After you restore a DB instance with a
DBSnapshotIdentifier
property, you must specify the sameDBSnapshotIdentifier
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 theDBSnapshotIdentifier
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 specifiedDBSnapshotIdentifier
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.
Required: No
Type: String
Update requires: Some interruptions
-
DBSubnetGroupName
-
A DB subnet group to associate with the DB instance. If you update this value, the new subnet group must be a subnet group in a new VPC.
If there's no DB subnet group, then the DB instance isn't a VPC DB instance.
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.
Required: No
Type: String
Update requires: Replacement
DBSystemId
-
The Oracle system identifier (SID), which is the name of the Oracle database instance that manages your database files. 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.Required: No
Type: String
Update requires: No interruption
DedicatedLogVolume
-
Indicates whether the DB instance has a dedicated log volume (DLV) enabled.
Required: No
Type: Boolean
Update requires: No interruption
DeleteAutomatedBackups
-
A value that indicates whether to remove automated backups immediately after the DB instance is deleted. 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.
Required: No
Type: Boolean
Update requires: No interruption
DeletionProtection
-
Specifies whether the DB instance has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection isn't enabled. For more information, see Deleting a DB Instance.
This setting doesn't apply to Amazon Aurora DB instances. You can enable or disable deletion protection for the DB cluster. For more information, see
CreateDBCluster
. DB instances in a DB cluster can be deleted even when deletion protection is enabled for the DB cluster.Required: No
Type: Boolean
Update requires: No interruption
Domain
-
The Active Directory directory ID to create the DB instance in. Currently, only Db2, MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB instances can be created in an Active Directory Domain.
For more information, see Kerberos Authentication in the Amazon RDS User Guide.
Required: No
Type: String
Update requires: No interruption
DomainAuthSecretArn
-
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
Required: No
Type: String
Update requires: Some interruptions
DomainDnsIps
-
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
Required: No
Type: Array of String
Update requires: Some interruptions
-
DomainFqdn
-
The fully qualified domain name (FQDN) of an Active Directory domain.
Constraints:
-
Can't be longer than 64 characters.
Example:
mymanagedADtest.mymanagedAD.mydomain
Required: No
Type: String
Update requires: Some interruptions
-
DomainIAMRoleName
-
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
Required: No
Type: String
Update requires: No interruption
-
DomainOu
-
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
Required: No
Type: String
Update requires: Some interruptions
-
EnableCloudwatchLogsExports
-
The list of log types that need to be enabled for exporting to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Relational Database Service User Guide.
Amazon Aurora
Not applicable. CloudWatch Logs exports are managed by the DB cluster.
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
Required: No
Type: Array of String
Update requires: No interruption
EnableIAMDatabaseAuthentication
-
A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled.
This 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.
Required: No
Type: Boolean
Update requires: No interruption
EnablePerformanceInsights
-
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.
Required: No
Type: Boolean
Update requires: No interruption
Endpoint
-
The connection endpoint for the DB instance.
Note
The endpoint might not be shown for instances with the status of
creating
.Required: No
Type: Endpoint
Update requires: No interruption
Engine
-
The name of the database engine to use for this DB instance. Not every database engine is available in every AWS Region.
This property is required when creating a DB instance.
Note
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 fromoracle-ee
tooracle-ee-cdb
or fromoracle-se2
tooracle-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
Required: Conditional
Type: String
Update requires: Some interruptions
-
EngineLifecycleSupport
-
The life cycle type for this DB instance.
Note
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 toopen-source-rds-extended-support-disabled
. In this case, creating the DB instance will fail if the DB major version is past its end of standard support date.This setting applies only to RDS for MySQL and RDS for PostgreSQL. For Amazon Aurora DB instances, the life cycle type is managed by the DB cluster.
You can use this setting to enroll your DB instance into Amazon RDS Extended Support. With RDS Extended Support, you can run the selected major engine version on your DB instance past the end of standard support for that engine version. For more information, see Using Amazon RDS Extended Support in the Amazon RDS User Guide.
Valid Values:
open-source-rds-extended-support | open-source-rds-extended-support-disabled
Default:
open-source-rds-extended-support
Required: No
Type: String
Update requires: Some interruptions
EngineVersion
-
The version number of the database engine to use.
For a list of valid engine versions, use the
DescribeDBEngineVersions
action.The following are the database engines and links to information about the major and minor versions that are available with Amazon RDS. Not every database engine is available for every AWS Region.
Amazon Aurora
Not applicable. The version number of the database engine to be used by the DB instance is managed by the DB cluster.
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.
Required: No
Type: String
Update requires: Some interruptions
Iops
-
The number of I/O operations per second (IOPS) that the database provisions. The value must be equal to or greater than 1000.
If you specify this property, you must follow the range of allowed ratios of your requested IOPS rate to the amount of storage that you allocate (IOPS to allocated storage). For example, you can provision an Oracle database instance with 1000 IOPS and 200 GiB of storage (a ratio of 5:1), or specify 2000 IOPS with 200 GiB of storage (a ratio of 10:1). For more information, see Amazon RDS Provisioned IOPS Storage to Improve Performance in the Amazon RDS User Guide.
Note
If you specify
io1
for theStorageType
property, then you must also specify theIops
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.
Required: No
Type: Integer
Update requires: No interruption
-
KmsKeyId
-
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
. 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
orSourceDbiResourceId
property, don't specify this property. The value is inherited from the source DB instance, and if the DB instance is encrypted, the specifiedKmsKeyId
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 specifiedKmsKeyId
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. TheStorageEncrypted
property value is inherited from the snapshot. If the DB instance is encrypted, the specifiedKmsKeyId
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.
Required: No
Type: String
Update requires: Replacement
LicenseModel
-
License model information for this DB instance.
Valid Values:
-
Aurora MySQL -
general-public-license
-
Aurora PostgreSQL -
postgresql-license
-
RDS for Db2 -
bring-your-own-license
. For more information about RDS for Db2 licensing, see https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/db2-licensing.html 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
orlicense-included
-
RDS for PostgreSQL -
postgresql-license
Note
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.Required: No
Type: String
Update requires: No interruption
-
ManageMasterUserPassword
-
Specifies whether to manage the master user password with AWS Secrets Manager.
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.
Required: No
Type: Boolean
Update requires: No interruption
-
MasterUsername
-
The master user name for the DB instance.
Note
If you specify the
SourceDBInstanceIdentifier
orDBSnapshotIdentifier
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.
Required: Conditional
Type: String
Pattern:
^[a-zA-Z][a-zA-Z0-9_]{0,127}$
Minimum:
1
Maximum:
128
Update requires: Replacement
-
MasterUserPassword
-
The password for the master user. The password can include any printable ASCII character except "/", """, or "@".
Amazon Aurora
Not applicable. The password for the master user is managed by the DB cluster.
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.
Required: Conditional
Type: String
Update requires: No interruption
MasterUserSecret
-
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.
Required: No
Type: MasterUserSecret
Update requires: No interruption
MaxAllocatedStorage
-
The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance.
For more information about this setting, including limitations that apply to it, see Managing capacity automatically with Amazon RDS storage autoscaling in the Amazon RDS User Guide.
This setting doesn't apply to the following DB instances:
-
Amazon Aurora (Storage is managed by the DB cluster.)
-
RDS Custom
Required: No
Type: Integer
Update requires: No interruption
-
MonitoringInterval
-
The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collection of Enhanced Monitoring metrics, specify
0
.If
MonitoringRoleArn
is specified, then you must setMonitoringInterval
to a value other than0
.This setting doesn't apply to RDS Custom DB instances.
Valid Values:
0 | 1 | 5 | 10 | 15 | 30 | 60
Default:
0
Required: No
Type: Integer
Update requires: No interruption
MonitoringRoleArn
-
The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs. For example,
arn:aws:iam:123456789012:role/emaccess
. For information on creating a monitoring role, see Setting Up and Enabling Enhanced Monitoring in the Amazon RDS User Guide.If
MonitoringInterval
is set to a value other than0
, then you must supply aMonitoringRoleArn
value.This setting doesn't apply to RDS Custom DB instances.
Required: No
Type: String
Update requires: No interruption
MultiAZ
-
Specifies whether the DB instance is a Multi-AZ deployment. You can't set the
AvailabilityZone
parameter if the DB instance is a Multi-AZ deployment.This setting doesn't apply to the following DB instances:
-
Amazon Aurora (DB instance Availability Zones (AZs) are managed by the DB cluster.)
-
RDS Custom
Required: No
Type: Boolean
Update requires: Some interruptions
-
NcharCharacterSetName
-
The name of the NCHAR character set for the Oracle DB instance.
This setting doesn't apply to RDS Custom DB instances.
Required: No
Type: String
Update requires: Replacement
NetworkType
-
The network type of the DB instance.
Valid values:
-
IPV4
-
DUAL
The network type is determined by the
DBSubnetGroup
specified for the DB instance. ADBSubnetGroup
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.
Required: No
Type: String
Update requires: No interruption
-
OptionGroupName
-
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.
Required: No
Type: String
Update requires: No interruption
PerformanceInsightsKMSKeyId
-
The AWS KMS key identifier for encryption of Performance Insights data.
The KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
If you do not specify a value for
PerformanceInsightsKMSKeyId
, then Amazon RDS uses your default KMS key. There is a default KMS key for your AWS account. Your AWS account has a different default KMS key for each AWS Region.For information about enabling Performance Insights, see EnablePerformanceInsights.
Required: No
Type: String
Update requires: Replacement
PerformanceInsightsRetentionPeriod
-
The number of days to retain Performance Insights data.
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
daysIf you specify a retention period that isn't valid, such as
94
, Amazon RDS returns an error.Required: No
Type: Integer
Update requires: No interruption
-
Port
-
The port number on which the database accepts connections.
This setting doesn't apply to Aurora DB instances. The port number is managed by the cluster.
Valid Values:
1150-65535
Default:
-
RDS for Db2 -
50000
-
RDS for MariaDB -
3306
-
RDS for Microsoft SQL Server -
1433
-
RDS for MySQL -
3306
-
RDS for Oracle -
1521
-
RDS for PostgreSQL -
5432
Constraints:
-
For RDS for Microsoft SQL Server, the value can't be
1234
,1434
,3260
,3343
,3389
,47001
, or49152-49156
.
Required: No
Type: String
Pattern:
^\d*$
Update requires: Some interruptions
-
PreferredBackupWindow
-
The daily time range during which automated backups are created if automated backups are enabled, using the
BackupRetentionPeriod
parameter. For more information, see Backup Window in the Amazon RDS User Guide.Constraints:
-
Must be in the format
hh24:mi-hh24:mi
. -
Must be in Universal Coordinated Time (UTC).
-
Must not conflict with the preferred maintenance window.
-
Must be at least 30 minutes.
Amazon Aurora
Not applicable. The daily time range for creating automated backups is managed by the DB cluster.
Required: No
Type: String
Update requires: No interruption
-
PreferredMaintenanceWindow
-
The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
Format:
ddd:hh24:mi-ddd:hh24:mi
The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region, occurring on a random day of the week. To see the time blocks available, see Adjusting the Preferred DB Instance Maintenance Window in the Amazon RDS User Guide.
Note
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.
Required: No
Type: String
Update requires: Some interruptions
ProcessorFeatures
-
The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
This setting doesn't apply to Amazon Aurora or RDS Custom DB instances.
Required: No
Type: Array of ProcessorFeature
Update requires: No interruption
PromotionTier
-
The order of priority in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance. For more information, see Fault Tolerance for an Aurora DB Cluster in the Amazon Aurora User Guide.
This setting doesn't apply to RDS Custom DB instances.
Default:
1
Valid Values:
0 - 15
Required: No
Type: Integer
Minimum:
0
Update requires: No interruption
PubliclyAccessible
-
Indicates whether the DB instance is an internet-facing instance. If you specify true, AWS CloudFormation creates an instance with a publicly resolvable DNS name, which resolves to a public IP address. If you specify false, AWS CloudFormation creates an internal instance with a DNS name that resolves to a private IP address.
The default behavior value depends on your VPC setup and the database subnet group. For more information, see the
PubliclyAccessible
parameter in the CreateDBInstance in the Amazon RDS API Reference.Required: No
Type: Boolean
Update requires: No interruption
ReplicaMode
-
The open mode of an Oracle read replica. For more information, see Working with Oracle Read Replicas for Amazon RDS in the Amazon RDS User Guide.
This setting is only supported in RDS for Oracle.
Default:
open-read-only
Valid Values:
open-read-only
ormounted
Required: No
Type: String
Update requires: No interruption
RestoreTime
-
The date and time to restore from. 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
Required: No
Type: String
Update requires: Some interruptions
-
SourceDBClusterIdentifier
-
The identifier of the Multi-AZ DB cluster that will act as the source for the read replica. Each DB cluster can have up to 15 read replicas.
Constraints:
-
Must be the identifier of an existing Multi-AZ DB cluster.
-
Can't be specified if the
SourceDBInstanceIdentifier
parameter is also specified. -
The specified DB cluster must have automatic backups enabled, that is, its backup retention period must be greater than 0.
-
The source DB cluster must be in the same AWS Region as the read replica. Cross-Region replication isn't supported.
Required: No
Type: String
Update requires: Some interruptions
-
SourceDBInstanceAutomatedBackupsArn
-
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.
Required: No
Type: String
Update requires: Some interruptions
SourceDBInstanceIdentifier
-
If you want to create a read replica DB instance, specify the ID of the source DB instance. 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 theSourceDBInstanceIdentifier
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
orRestoreTime
properties in conjunction with theSourceDBInstanceIdentifier
property, RDS restores the DB instance to the requested point in time, thereby creating a new DB instance.Important
-
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 theVPCSecurityGroups
property from the source DB when you create the replica. However, if you update the stack, AWS CloudFormation reverts the replica'sVPCSecurityGroups
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 theDBSnapshotIdentifier
property. You can't create a read replica from a snapshot. -
Don't set the
BackupRetentionPeriod
,DBName
,MasterUsername
,MasterUserPassword
, andPreferredBackupWindow
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 inSourceDBInstanceIdentifier
. 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.
Required: No
Type: String
Update requires: Some interruptions
-
SourceDbiResourceId
-
The resource ID of the source DB instance from which to restore.
Required: No
Type: String
Update requires: Some interruptions
SourceRegion
-
The ID of the region that contains the source DB instance for the read replica.
Required: No
Type: String
Update requires: Replacement
StorageEncrypted
-
A value that indicates whether the DB instance is encrypted. By default, it isn't encrypted.
If you specify the
KmsKeyId
property, then you must enable encryption.If you specify the
SourceDBInstanceIdentifier
orSourceDbiResourceId
property, don't specify this property. The value is inherited from the source DB instance, and if the DB instance is encrypted, the specifiedKmsKeyId
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.
Required: No
Type: Boolean
Update requires: Replacement
StorageThroughput
-
Specifies the storage throughput value for the DB instance. This setting applies only to the
gp3
storage type.This setting doesn't apply to RDS Custom or Amazon Aurora.
Required: No
Type: Integer
Update requires: No interruption
StorageType
-
The storage type to associate with the DB instance.
If you specify
io1
,io2
, orgp3
, you must also include a value for theIops
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 theIops
parameter is specified. Otherwise,gp2
.Required: No
Type: String
Update requires: Some interruptions
-
Tags to assign to the DB instance.
Required: No
Type: Array of Tag
Update requires: No interruption
Timezone
-
The time zone of the DB instance. The time zone parameter is currently supported only by RDS for Db2 and RDS for SQL Server.
Required: No
Type: String
Update requires: Replacement
UseDefaultProcessorFeatures
-
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.
Required: No
Type: Boolean
Update requires: No interruption
UseLatestRestorableTime
-
Specifies whether the DB instance is restored from the latest backup time. 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.
Required: No
Type: Boolean
Update requires: Some interruptions
-
VPCSecurityGroups
-
A list of the VPC security group IDs to assign to the DB instance. The list can include both the physical IDs of existing VPC security groups and references to AWS::EC2::SecurityGroup resources created in the template.
If you plan to update the resource, don't specify VPC security groups in a shared VPC.
If you set
VPCSecurityGroups
, you must not setDBSecurityGroups
, and vice versa.Important
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.
Required: No
Type: Array of String
Update requires: No interruption
-
Return values
Ref
When you pass the logical ID of this resource to the intrinsic Ref
function, Ref
returns the DB instance name.
For more information about using the Ref
function, see Ref
.
Fn::GetAtt
The Fn::GetAtt
intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.
For more information about using the Fn::GetAtt
intrinsic function, see Fn::GetAtt
.
CertificateDetails.CAIdentifier
-
The CA identifier of the CA certificate used for the DB instance's server certificate.
CertificateDetails.ValidTill
-
The expiration date of the DB instance’s server certificate.
DBInstanceArn
-
The Amazon Resource Name (ARN) for the DB instance.
DbiResourceId
-
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.
DBSystemId
-
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.
Endpoint.Address
-
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.
Endpoint.HostedZoneId
-
The ID that Amazon Route 53 assigns when you create a hosted zone.
Endpoint.Port
-
The port number on which the database accepts connections. For example:
3306
MasterUserSecret.SecretArn
-
The Amazon Resource Name (ARN) of the secret. This parameter is a return value that you can retrieve using the
Fn::GetAtt
intrinsic function. For more information, see Return values.
Examples
- Creating a DB instance with Enhanced Monitoring enabled
- Creating a cross-region encrypted read replica
- Setting a AWS region for the backup replication of a DB instance
- Creating an Amazon RDS Custom DB instance
- Creating a Secrets Manager secret for a master password
- Creating a DB instance with self-managed Active Directory domain
Creating a DB instance with Enhanced Monitoring enabled
The following example creates an Amazon RDS MySQL DB instance with Enhanced
Monitoring enabled. The IAM role for Enhanced Monitoring specified in
MonitoringRoleArn
must exist before you run this example. For
more information, see Enhanced
Monitoring in the Amazon RDS User Guide.
JSON
{ "AWSTemplateFormatVersion": "2010-09-09", "Description": "AWS CloudFormation Sample Template for creating an Amazon RDS DB instance: Sample template showing how to create a DB instance with Enhanced Monitoring enabled. **WARNING** This template creates an RDS DB instance. You will be billed for the AWS resources used if you create a stack from this template.", "Parameters": { "DBInstanceID": { "Default": "mydbinstance", "Description": "My database instance", "Type": "String", "MinLength": "1", "MaxLength": "63", "AllowedPattern": "[a-zA-Z][a-zA-Z0-9]*", "ConstraintDescription": "Must begin with a letter and must not end with a hyphen or contain two consecutive hyphens." }, "DBName": { "Default": "mydb", "Description": "My database", "Type": "String", "MinLength": "1", "MaxLength": "64", "AllowedPattern": "[a-zA-Z][a-zA-Z0-9]*", "ConstraintDescription": "Must begin with a letter and contain only alphanumeric characters." }, "DBInstanceClass": { "Default": "db.m5.large", "Description": "DB instance class", "Type": "String", "ConstraintDescription": "Must select a valid DB instance type." }, "DBAllocatedStorage": { "Default": "50", "Description": "The size of the database (GiB)", "Type": "Number", "MinValue": "20", "MaxValue": "65536", "ConstraintDescription": "must be between 20 and 65536 GiB." }, "DBUsername": { "NoEcho": "true", "Description": "Username for MySQL database access", "Type": "String", "MinLength": "1", "MaxLength": "16", "AllowedPattern": "[a-zA-Z][a-zA-Z0-9]*", "ConstraintDescription": "must begin with a letter and contain only alphanumeric characters." }, "DBPassword": { "NoEcho": "true", "Description": "Password MySQL database access", "Type": "String", "MinLength": "8", "MaxLength": "41", "AllowedPattern": "[a-zA-Z0-9]*", "ConstraintDescription": "must contain only alphanumeric characters." } }, "Resources": { "MyDB": { "Type": "AWS::RDS::DBInstance", "Properties": { "DBInstanceIdentifier": { "Ref": "DBInstanceID" }, "DBName": { "Ref": "DBName" }, "DBInstanceClass": { "Ref": "DBInstanceClass" }, "AllocatedStorage": { "Ref": "DBAllocatedStorage" }, "Engine": "MySQL", "EngineVersion": "8.0.33", "MasterUsername": { "Ref": "DBUsername" }, "MasterUserPassword": { "Ref": "DBPassword" }, "MonitoringInterval": 60, "MonitoringRoleArn": "arn:aws:iam::1233456789012:role/rds-monitoring-role" } } } }
YAML
AWSTemplateFormatVersion: 2010-09-09 Description: >- Description": "AWS CloudFormation Sample Template for creating an Amazon RDS DB instance: Sample template showing how to create a DB instance with Enhanced Monitoring enabled. **WARNING** This template creates an RDS DB instance. You will be billed for the AWS resources used if you create a stack from this template. Parameters: DBInstanceID: Default: mydbinstance Description: My database instance Type: String MinLength: '1' MaxLength: '63' AllowedPattern: '[a-zA-Z][a-zA-Z0-9]*' ConstraintDescription: >- Must begin with a letter and must not end with a hyphen or contain two consecutive hyphens. DBName: Default: mydb Description: My database Type: String MinLength: '1' MaxLength: '64' AllowedPattern: '[a-zA-Z][a-zA-Z0-9]*' ConstraintDescription: Must begin with a letter and contain only alphanumeric characters. DBInstanceClass: Default: db.m5.large Description: DB instance class Type: String ConstraintDescription: Must select a valid DB instance type. DBAllocatedStorage: Default: '50' Description: The size of the database (GiB) Type: Number MinValue: '20' MaxValue: '65536' ConstraintDescription: must be between 20 and 65536 GiB. DBUsername: NoEcho: 'true' Description: Username for MySQL database access Type: String MinLength: '1' MaxLength: '16' AllowedPattern: '[a-zA-Z][a-zA-Z0-9]*' ConstraintDescription: must begin with a letter and contain only alphanumeric characters. DBPassword: NoEcho: 'true' Description: Password MySQL database access Type: String MinLength: '8' MaxLength: '41' AllowedPattern: '[a-zA-Z0-9]*' ConstraintDescription: must contain only alphanumeric characters. Resources: MyDB: Type: 'AWS::RDS::DBInstance' Properties: DBInstanceIdentifier: !Ref DBInstanceID DBName: !Ref DBName DBInstanceClass: !Ref DBInstanceClass AllocatedStorage: !Ref DBAllocatedStorage Engine: MySQL EngineVersion: "8.0.33" MasterUsername: !Ref DBUsername MasterUserPassword: !Ref DBPassword MonitoringInterval: 60 MonitoringRoleArn: 'arn:aws:iam::123456789012:role/rds-monitoring-role'
Creating a cross-region encrypted read replica
The following example creates an encrypted read replica from a cross-region source DB instance.
JSON
{ "AWSTemplateFormatVersion": "2010-09-09", "Description": "RDS Storage Encrypted", "Parameters": { "SourceDBInstanceIdentifier": { "Type": "String" }, "DBInstanceType": { "Type": "String" }, "SourceRegion": { "Type": "String" } }, "Resources": { "MyKey": { "Type": "AWS::KMS::Key", "Properties": { "KeyPolicy": { "Version": "2012-10-17", "Id": "key-default-1", "Statement": [ { "Sid": "Enable IAM User Permissions", "Effect": "Allow", "Principal": { "AWS": { "Fn::Join": [ "", [ "arn:aws:iam::", { "Ref": "AWS::AccountId" }, ":root" ] ] } }, "Action": "kms:*", "Resource": "*" } ] } } }, "MyDBSmall": { "Type": "AWS::RDS::DBInstance", "Properties": { "DBInstanceClass": { "Ref": "DBInstanceType" }, "SourceDBInstanceIdentifier": { "Ref": "SourceDBInstanceIdentifier" }, "SourceRegion": { "Ref": "SourceRegion" }, "KmsKeyId": { "Ref": "MyKey" } } } }, "Outputs": { "InstanceId": { "Description": "InstanceId of the newly created RDS Instance", "Value": { "Ref": "MyDBSmall" } } } }
YAML
--- AWSTemplateFormatVersion: 2010-09-09 Description: RDS Storage Encrypted Parameters: SourceDBInstanceIdentifier: Type: String DBInstanceType: Type: String SourceRegion: Type: String Resources: MyKey: Type: AWS::KMS::Key Properties: KeyPolicy: Version: 2012-10-17 Id: key-default-1 Statement: - Sid: Enable IAM User Permissions Effect: Allow Principal: AWS: !Join - "" - - "arn:aws:iam::" - !Ref "AWS::AccountId" - ":root" Action: "kms:*" Resource: "*" MyDBSmall: Type: AWS::RDS::DBInstance Properties: DBInstanceClass: !Ref DBInstanceType SourceDBInstanceIdentifier: !Ref SourceDBInstanceIdentifier SourceRegion: !Ref SourceRegion KmsKeyId: !Ref MyKey Outputs: InstanceId: Description: InstanceId of the newly created RDS Instance Value: !Ref MyDBSmall
Setting a AWS region for the backup replication of a DB instance
The following example defines the destination region for automated backup replication of a DB instance. In this example
the DB instance backup will be replicated to ap-northeast-1
region.
JSON
{ "Resources": { "RDSDBInstance": { "Type": "AWS::RDS::DBInstance", "Properties": { "AllocatedStorage": "100", "AutomaticBackupReplicationRegion": "ap-northeast-1", "BackupRetentionPeriod": 1, "DBInstanceClass": "db.t3.micro", "Engine": "postgres", "Iops": 1000, "MasterUserPassword": "masterpassword", "MasterUsername": "masteruser", "StorageType": "IO1" } } } }
YAML
Resources: RDSDBInstance: Type: 'AWS::RDS::DBInstance' Properties: AllocatedStorage: '100' AutomaticBackupReplicationRegion: ap-northeast-1 BackupRetentionPeriod: 1 DBInstanceClass: db.t3.micro Engine: postgres Iops: 1000 MasterUserPassword: masterpassword MasterUsername: masteruser StorageType: IO1
Creating an Amazon RDS Custom DB instance
This example creates an Amazon RDS Custom DB instance. Amazon RDS Custom allows you as a database administrator to access and customize your database environment and operating system. With this access, you can configure settings, install patches, and enable native features to meet the dependent application's requirements. With RDS Custom, you can run your database workload using the AWS Management Console or AWS CLI. For more information, see Working with Amazon RDS Custom in the Amazon RDS User Guide.
JSON
{ "AWSTemplateFormatVersion": "2010-09-09", "Parameters": { "AllocatedStorage": { "Type": "String" }, "CustomIAMInstanceProfile": { "Type": "String" }, "DBInstanceIdentifier": { "Type": "String" }, "DBInstanceClass": { "Type": "String" }, "DBName": { "Type": "String" }, "DBSubnetGroupName": { "Type": "String" }, "Engine": { "Type": "String" }, "EngineVersion": { "Type": "String" }, "KMSKeyId": { "Type": "String" }, "LicenseModel": { "Type": "String" }, "MasterUsername": { "Type": "String" }, "MasterUserPassword": { "Type": "String", "NoEcho": true } }, "Resources": { "RDSDBInstance": { "Properties": { "AllocatedStorage": { "Ref": "AllocatedStorage" }, "AutoMinorVersionUpgrade": false, "CustomIAMInstanceProfile": { "Ref": "CustomIAMInstanceProfile" }, "DBInstanceClass": { "Ref": "DBInstanceClass" }, "DBSubnetGroupName": { "Ref": "DBSubnetGroupName" }, "Engine": { "Ref": "Engine" }, "EngineVersion": { "Ref": "EngineVersion" }, "LicenseModel": { "Ref": "LicenseModel" }, "KmsKeyId": { "Ref": "KMSKeyId" }, "MasterUsername": { "Ref": "MasterUsername" }, "MasterUserPassword": { "Ref": "MasterUserPassword" } }, "Type": "AWS::RDS::DBInstance" } } }
YAML
AWSTemplateFormatVersion: 2010-09-09 Parameters: AllocatedStorage: Type: String CustomIAMInstanceProfile: Type: String DBInstanceIdentifier: Type: String DBInstanceClass: Type: String DBName: Type: String DBSubnetGroupName: Type: String Engine: Type: String EngineVersion: Type: String KMSKeyId: Type: String LicenseModel: Type: String MasterUsername: Type: String MasterUserPassword: Type: String NoEcho: true Resources: RDSDBInstance: Properties: AllocatedStorage: !Ref AllocatedStorage AutoMinorVersionUpgrade: false CustomIAMInstanceProfile: !Ref CustomIAMInstanceProfile DBInstanceClass: !Ref DBInstanceClass DBSubnetGroupName: !Ref DBSubnetGroupName Engine: !Ref Engine EngineVersion: !Ref EngineVersion LicenseModel: !Ref LicenseModel KmsKeyId: !Ref KMSKeyId MasterUsername: !Ref MasterUsername MasterUserPassword: !Ref MasterUserPassword Type: 'AWS::RDS::DBInstance'
Creating a Secrets Manager secret for a master password
The following example creates an AWS::RDS::DBInstance resource with a managed master user and password.
The secret used to authenticate the DB instance is shown in the Secret
stack output.
You can remove this output if you don't need to pass the value to another CloudFormation stack.
For more information about managing passwords with Secrets Manager, see Password management with AWS Secrets Manager in the Amazon RDS User Guide and Password management with AWS Secrets Manager in the Amazon Aurora User Guide.
JSON
{ "AWSTemplateFormatVersion": "2010-09-09", "Description": "A sample template", "Resources": { "MyInstance": { "Properties": { "MasterUsername": "masteruser", "DBInstanceClass": "db.t3.micro", "Engine": "mysql", "AllocatedStorage": 5, "AutoMinorVersionUpgrade": false, "ManageMasterUserPassword": true, "MasterUserSecret": { "KmsKeyId": { "Ref": "KMSKey" } } }, "Type": "AWS::RDS::DBInstance" }, "KMSKey": { "Type": "AWS::KMS::Key", "Properties": { "Description": "Manual test KMS key", "EnableKeyRotation": true, "KeyPolicy": { "Version": "2012-10-17", "Id": { "Ref": "AWS::StackName" }, "Statement": [ { "Sid": "Allow administration of the key", "Effect": "Allow", "Principal": { "AWS": { "Fn::Sub": "arn:${AWS::Partition}:iam::${AWS::AccountId}:root" } }, "Action": [ "kms:*" ], "Resource": "*" } ] } } } }, "Outputs": { "Secret": { "Value": { "Fn::GetAtt": "MyInstance.MasterUserSecret.SecretArn" } } } }
YAML
AWSTemplateFormatVersion: "2010-09-09" Description: A sample template Resources: MyInstance: Properties: MasterUsername: "masteruser" DBInstanceClass: "db.t3.micro" Engine: "mysql" AllocatedStorage: 5 AutoMinorVersionUpgrade: false ManageMasterUserPassword: true MasterUserSecret: KmsKeyId: !Ref KMSKey Type: "AWS::RDS::DBInstance" KMSKey: Type: 'AWS::KMS::Key' Properties: Description: Manual test KMS key EnableKeyRotation: True KeyPolicy: Version: "2012-10-17" Id: !Ref "AWS::StackName" Statement: - Sid: "Allow administration of the key" Effect: "Allow" Principal: AWS: Fn::Sub: 'arn:${AWS::Partition}:iam::${AWS::AccountId}:root' Action: - "kms:*" Resource: "*" Outputs: Secret: Value: Fn::GetAtt: MyInstance.MasterUserSecret.SecretArn
Creating a DB instance with self-managed Active Directory domain
The following example creates a AWS CloudFormation stack with the AWS::RDS::DBInstance resource with Active Directory domain.
JSON
{ "Resources": { "RDSDBInstance": { "Type": "AWS::RDS::DBInstance", "Properties": { "AllocatedStorage": { "Ref" : "DBAllocatedStorage" }, "DBInstanceClass": { "Ref" : "DBClass" }, "DBSubnetGroupName": { "Ref" : "MyDBSubnetGroup" }, "Engine": "sqlserver-ee", "LicenseModel": "license-included", "MasterUsername" : { "Ref" : "DBUsername" }, "MasterUserPassword": { "Ref" : "DBPassword" }, "DomainAuthSecretArn": { "Ref" : "DomainSecretArn" }, "DomainDnsIps": [ "10.0.0.1", "10.0.0.2" ], "DomainFqdn": { "Ref" : "MyDomainFqdn" }, "DomainOu": { "Ref" : "MyDomainOu" } }, "UpdateReplacePolicy": "Delete", "DeletionPolicy": "Delete" } } }
YAML
Resources: RDSDBInstance: Type: 'AWS::RDS::DBInstance' Properties: AllocatedStorage: !Ref DBAllocatedStorage DBInstanceClass: !Ref DBClass DBSubnetGroupName: !Ref MyDBSubnetGroup Engine: sqlserver-ee LicenseModel: license-included MasterUsername: !Ref DBUsername MasterUserPassword: !Ref DBPassword DomainAuthSecretArn: !Ref DomainSecretArn DomainDnsIps: - 10.0.0.1 - 10.0.0.2 DomainFqdn: !Ref MyDomainFqdn DomainOu: !Ref MyDomainOu UpdateReplacePolicy: Delete DeletionPolicy: Delete