AWS Fundamentals Logo
AWS Fundamentals
AWS::DocDB::DBCluster

DocDB DBCluster

Resource Type definition for AWS::DocDB::DBCluster

Properties

30 configurable properties. Click a row to see details.

Filter:
PropertyTypeFlags
AvailabilityZones
Array<string>
Create-only
BackupRetentionPeriod
integer
CopyTagsToSnapshot
boolean
DBClusterIdentifier
string
Create-only
DBClusterParameterGroupName
string
DBSubnetGroupName
string
Create-only
DeletionProtection
boolean
EnableCloudwatchLogsExports
Array<string>
EngineVersion
string
GlobalClusterIdentifier
string
KmsKeyId
string
Create-only
ManageMasterUserPassword
boolean
MasterUsername
string
Create-only
MasterUserPassword
string
MasterUserSecretKmsKeyId
string
NetworkType
string
Port
integer
PreferredBackupWindow
string
PreferredMaintenanceWindow
string
RestoreToTime
string
RestoreType
string
RotateMasterUserPassword
boolean
ServerlessV2ScalingConfiguration
ServerlessV2ScalingConfiguration
SnapshotIdentifier
string
Create-only
SourceDBClusterIdentifier
string
Create-only
StorageEncrypted
boolean
Create-only
StorageType
string
Tags
Array<Tag>
UseLatestRestorableTime
boolean
VpcSecurityGroupIds
Array<string>

Return Values

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

AttributeTypeDescription
ClusterResourceIdstring-
Endpointstring-
Idstring-
ReadEndpointstring-

Sample CloudFormation Template

A minimal template with required properties and common optional ones.

template.yaml
AWSTemplateFormatVersion: "2010-09-09"
Description: Sample template for AWS::DocDB::DBCluster

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

Learn AWS the Practical Way

Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.

Subscribe to Newsletter

Quick Facts

ServiceDocDB
Properties34
Required0
TaggingNot supported
Primary IDId

Immutable After Creation

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

SnapshotIdentifierKmsKeyIdMasterUsernameSourceDBClusterIdentifierDBClusterIdentifierAvailabilityZonesDBSubnetGroupNameStorageEncrypted

Related Resources

External Links