AWS::RDS::DBInstance

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](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_CreateDBInstance.html) 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 cluste...

Properties

83 configurable properties. Click a row to see details.

Filter:

Property	Type	Flags
`AdditionalStorageVolumes`	`Array<AdditionalStorageVolume>`
`AllocatedStorage`	`string`
`AllowMajorVersionUpgrade`	`boolean`	Write-only
`ApplyImmediately`	`boolean`	Write-only
`AssociatedRoles`	`Array<DBInstanceRole>`
`AutomaticBackupReplicationKmsKeyId`	`string`	Write-only
`AutomaticBackupReplicationRegion`	`string`
`AutomaticBackupReplicationRetentionPeriod`	`integer`
`AutoMinorVersionUpgrade`	`boolean`
`AvailabilityZone`	`string`
`BackupRetentionPeriod`	`integer`
`BackupTarget`	`string`	Create-only
`CACertificateIdentifier`	`string`
`CertificateRotationRestart`	`boolean`	Write-only
`CharacterSetName`	`string`	Create-only
`CopyTagsToSnapshot`	`boolean`
`CustomIAMInstanceProfile`	`string`	Create-only
`DatabaseInsightsMode`	`string`
`DBClusterIdentifier`	`string`	Create-only
`DBClusterSnapshotIdentifier`	`string`
`DBInstanceClass`	`string`
`DBInstanceIdentifier`	`string`	Create-only
`DBName`	`string`	Create-only
`DBParameterGroupName`	`string`
`DBSecurityGroups`	`Array<string>`
`DBSnapshotIdentifier`	`string`	Write-only
`DBSubnetGroupName`	`string`	Create-only
`DBSystemId`	`string`	Create-only
`DedicatedLogVolume`	`boolean`
`DeleteAutomatedBackups`	`boolean`	Write-only
`DeletionProtection`	`boolean`
`Domain`	`string`
`DomainAuthSecretArn`	`string`
`DomainDnsIps`	`Array<string>`
`DomainFqdn`	`string`
`DomainIAMRoleName`	`string`
`DomainOu`	`string`
`EnableCloudwatchLogsExports`	`Array<string>`
`EnableIAMDatabaseAuthentication`	`boolean`
`EnablePerformanceInsights`	`boolean`
`Engine`	`string`
`EngineLifecycleSupport`	`string`
`EngineVersion`	`string`
`Iops`	`integer`
`KmsKeyId`	`string`	Create-only
`LicenseModel`	`string`
`ManageMasterUserPassword`	`boolean`
`MasterUserAuthenticationType`	`string`	Write-only
`MasterUsername`	`string`	Create-only
`MasterUserPassword`	`string`	Write-only
`MasterUserSecret`	`MasterUserSecret`
`MaxAllocatedStorage`	`integer`
`MonitoringInterval`	`integer`
`MonitoringRoleArn`	`string`
`MultiAZ`	`boolean`
`NcharCharacterSetName`	`string`	Create-only
`NetworkType`	`string`
`OptionGroupName`	`string`
`PerformanceInsightsKMSKeyId`	`string`
`PerformanceInsightsRetentionPeriod`	`integer`
`Port`	`string`
`PreferredBackupWindow`	`string`
`PreferredMaintenanceWindow`	`string`
`ProcessorFeatures`	`Array<ProcessorFeature>`
`PromotionTier`	`integer`
`PubliclyAccessible`	`boolean`
`ReplicaMode`	`string`
`RestoreTime`	`string`	Write-only
`SourceDBClusterIdentifier`	`string`
`SourceDBInstanceAutomatedBackupsArn`	`string`	Write-only
`SourceDBInstanceIdentifier`	`string`	Write-only
`SourceDbiResourceId`	`string`	Write-only
`SourceRegion`	`string`	Create-onlyWrite-only
`StorageEncrypted`	`boolean`	Create-only
`StorageThroughput`	`integer`
`StorageType`	`string`
`Tags`	`Array<Tag>`
`TdeCredentialArn`	`string`	Deprecated
`TdeCredentialPassword`	`string`	Write-onlyDeprecated
`Timezone`	`string`	Create-only
`UseDefaultProcessorFeatures`	`boolean`	Write-only
`UseLatestRestorableTime`	`boolean`	Write-only
`VPCSecurityGroups`	`Array<string>`

Return Values

Values returned after the resource is created. Access these with Fn::GetAtt.

Attribute	Type	Description
`AutomaticRestartTime`	`string`	-
`CertificateDetails`	`CertificateDetails`	-
`DBInstanceArn`	`string`	-
`DBInstanceStatus`	`string`	-
`DbiResourceId`	`string`	-
`Endpoint`	`Endpoint`	-
`InstanceCreateTime`	`string`	-
`IsStorageConfigUpgradeAvailable`	`boolean`	-
`LatestRestorableTime`	`string`	-
`ListenerEndpoint`	`Endpoint`	-
`PercentProgress`	`string`	-
`ReadReplicaDBClusterIdentifiers`	`Array<string>`	-
`ReadReplicaDBInstanceIdentifiers`	`Array<string>`	-
`ResumeFullAutomationModeTime`	`string`	-
`SecondaryAvailabilityZone`	`string`	-
`StatusInfos`	`Array<DBInstanceStatusInfo>`	-

Sample CloudFormation Template

A minimal template with required properties and common optional ones.

template.yaml

AWSTemplateFormatVersion: "2010-09-09"
Description: Sample template for AWS::RDS::DBInstance

Resources:
  MyResource:
    Type: AWS::RDS::DBInstance
    Properties:
      Tags:
        - Key: Environment
          Value: Production

Required IAM Permissions

Permissions CloudFormation needs in your IAM role to manage this resource.

create

ec2:DescribeAccountAttributesec2:DescribeAvailabilityZonesec2:DescribeInternetGatewaysec2:DescribeSecurityGroupsec2:DescribeSubnetsec2:DescribeVpcAttributeec2:DescribeVpcsiam:CreateServiceLinkedRole

read

ec2:DescribeAccountAttributesec2:DescribeAvailabilityZonesec2:DescribeInternetGatewaysec2:DescribeSecurityGroupsec2:DescribeSubnetsec2:DescribeVpcAttributeec2:DescribeVpcsrds:DescribeDBInstances

update

delete

rds:AddTagsToResourcerds:CreateDBSnapshotrds:DeleteDBInstancerds:DescribeDBInstances

list

rds:DescribeDBInstances

Get the RDS Cheat Sheet

Everything you need to know about RDS on one page. HD quality, print-friendly.

Download Free Infographic

Quick Facts

ServiceRDS

Properties99

Required0

TaggingSupported

Primary IDDBInstanceIdentifier

Supported Operations

CreateReadUpdateDeleteList

Immutable After Creation

These properties cannot be changed after the resource is created. Updating them triggers a replacement.

BackupTargetCharacterSetNameCustomIAMInstanceProfileDBClusterIdentifierDBInstanceIdentifierDBNameDBSubnetGroupNameDBSystemIdKmsKeyIdMasterUsernameNcharCharacterSetNameSourceRegionStorageEncryptedTimezone

Related Resources

External Links

AWS Documentation