AWS::RDS::DBCluster

RDS DBCluster

The AWS::RDS::DBCluster resource creates an Amazon Aurora DB cluster or Multi-AZ DB cluster. For more information about creating an Aurora DB cluster, see [Creating an Amazon Aurora DB cluster](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.CreateInstance.html) in the *Amazon Aurora User Guide*. For more information about creating a Multi-AZ DB cluster, see [Creating a Multi-AZ DB cluster](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/create-multi-az-db-clu...

Properties

61 configurable properties. Click a row to see details.

Filter:

Property	Type	Flags
`AllocatedStorage`	`integer`
`AssociatedRoles`	`Array<DBClusterRole>`
`AutoMinorVersionUpgrade`	`boolean`
`AvailabilityZones`	`Array<string>`	Create-only
`BacktrackWindow`	`integer`
`BackupRetentionPeriod`	`integer`
`ClusterScalabilityType`	`string`	Create-onlyWrite-only
`CopyTagsToSnapshot`	`boolean`
`DatabaseInsightsMode`	`string`
`DatabaseName`	`string`	Create-only
`DBClusterIdentifier`	`string`	Create-only
`DBClusterInstanceClass`	`string`
`DBClusterParameterGroupName`	`string`
`DBInstanceParameterGroupName`	`string`	Write-only
`DBSubnetGroupName`	`string`	Create-only
`DBSystemId`	`string`	Create-only
`DeleteAutomatedBackups`	`boolean`	Write-only
`DeletionProtection`	`boolean`
`Domain`	`string`
`DomainIAMRoleName`	`string`
`EnableCloudwatchLogsExports`	`Array<string>`
`EnableGlobalWriteForwarding`	`boolean`
`EnableHttpEndpoint`	`boolean`
`EnableIAMDatabaseAuthentication`	`boolean`
`EnableLocalWriteForwarding`	`boolean`
`Engine`	`string`
`EngineLifecycleSupport`	`string`
`EngineMode`	`string`	Create-only
`EngineVersion`	`string`
`GlobalClusterIdentifier`	`string`
`Iops`	`integer`
`KmsKeyId`	`string`	Create-only
`ManageMasterUserPassword`	`boolean`
`MasterUserAuthenticationType`	`string`	Write-only
`MasterUsername`	`string`
`MasterUserPassword`	`string`	Write-only
`MasterUserSecret`	`MasterUserSecret`
`MonitoringInterval`	`integer`
`MonitoringRoleArn`	`string`
`NetworkType`	`string`
`PerformanceInsightsEnabled`	`boolean`
`PerformanceInsightsKmsKeyId`	`string`
`PerformanceInsightsRetentionPeriod`	`integer`
`Port`	`integer`
`PreferredBackupWindow`	`string`
`PreferredMaintenanceWindow`	`string`
`PubliclyAccessible`	`boolean`	Create-only
`ReplicationSourceIdentifier`	`string`
`RestoreToTime`	`string`	Create-onlyWrite-only
`RestoreType`	`string`	Create-onlyWrite-only
`ScalingConfiguration`	`ScalingConfiguration`
`ServerlessV2ScalingConfiguration`	`ServerlessV2ScalingConfiguration`
`SnapshotIdentifier`	`string`	Create-onlyWrite-only
`SourceDBClusterIdentifier`	`string`	Create-onlyWrite-only
`SourceDbClusterResourceId`	`string`	Create-onlyWrite-only
`SourceRegion`	`string`	Create-onlyWrite-only
`StorageEncrypted`	`boolean`	Create-only
`StorageType`	`string`
`Tags`	`Array<Tag>`
`UseLatestRestorableTime`	`boolean`	Create-onlyWrite-only
`VpcSecurityGroupIds`	`Array<string>`

Return Values

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

Attribute	Type	Description
`DBClusterArn`	`string`	-
`DBClusterResourceId`	`string`	-
`Endpoint`	`Endpoint`	-
`ReadEndpoint`	`ReadEndpoint`	-
`StorageThroughput`	`integer`	-

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::DBCluster

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

Required IAM Permissions

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

create

iam:CreateServiceLinkedRoleiam:PassRolerds:AddRoleToDBClusterrds:AddTagsToResourcerds:CreateDBClusterrds:CreateDBInstancerds:DescribeDBClustersrds:DescribeDBClusterAutomatedBackups

read

rds:DescribeDBClusters

update

ec2:DescribeSecurityGroupsiam:PassRolerds:AddRoleToDBClusterrds:AddTagsToResourcerds:DescribeDBClustersrds:DescribeDBSubnetGroupsrds:DescribeEventsrds:DescribeGlobalClusters

delete

rds:AddTagsToResourcerds:CreateDBClusterSnapshotrds:DeleteDBClusterrds:DeleteDBInstancerds:DescribeDBClustersrds:DescribeGlobalClustersrds:RemoveFromGlobalCluster

list

rds:DescribeDBClusters

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

Properties66

Required0

TaggingSupported

Primary IDDBClusterIdentifier

Supported Operations

CreateReadUpdateDeleteList

Immutable After Creation

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

AvailabilityZonesClusterScalabilityTypeDBClusterIdentifierDBSubnetGroupNameDBSystemIdDatabaseNameEngineModeKmsKeyIdPubliclyAccessibleRestoreToTimeRestoreTypeSnapshotIdentifierSourceDBClusterIdentifierSourceDbClusterResourceIdSourceRegionStorageEncryptedUseLatestRestorableTime

Related Resources

External Links

AWS Documentation