AWS Fundamentals Logo
AWS Fundamentals
AWS::DocDBElastic::Cluster

DocDBElastic Cluster

The AWS::DocDBElastic::Cluster Amazon DocumentDB (with MongoDB compatibility) Elastic Scale resource describes a Cluster

Properties

14 configurable properties. 5 required. Click a row to see details.

Filter:
PropertyTypeFlags
AdminUserName
string
RequiredCreate-only
AuthType
string
RequiredCreate-only
ClusterName
string
RequiredCreate-only
ShardCapacity
integer
Required
ShardCount
integer
Required
AdminUserPassword
string
Write-only
BackupRetentionPeriod
integer
KmsKeyId
string
Create-only
PreferredBackupWindow
string
PreferredMaintenanceWindow
string
ShardInstanceCount
integer
SubnetIds
Array<string>
Tags
Array<Tag>
VpcSecurityGroupIds
Array<string>

Return Values

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

AttributeTypeDescription
ClusterArnstring-
ClusterEndpointstring-

Sample CloudFormation Template

A minimal template with required properties and common optional ones.

template.yaml
AWSTemplateFormatVersion: "2010-09-09"
Description: Sample template for AWS::DocDBElastic::Cluster

Resources:
  MyResource:
    Type: AWS::DocDBElastic::Cluster
    Properties:
      ClusterName: "my-clustername"
      AdminUserName: "my-adminusername"
      ShardCapacity: 1
      ShardCount: 1
      AuthType: "value"
      Tags:
        - Key: Environment
          Value: Production

Required IAM Permissions

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

create

docdb-elastic:CreateClusterdocdb-elastic:TagResourcedocdb-elastic:GetClusterdocdb-elastic:ListTagsForResourceec2:CreateVpcEndpointec2:DescribeVpcEndpointsec2:DeleteVpcEndpointsec2:ModifyVpcEndpoint

read

docdb-elastic:GetClusterdocdb-elastic:ListTagsForResource

update

docdb-elastic:UpdateClusterdocdb-elastic:TagResourcedocdb-elastic:UntagResourcedocdb-elastic:GetClusterdocdb-elastic:ListTagsForResourceec2:CreateVpcEndpointec2:DescribeVpcEndpointsec2:DeleteVpcEndpoints

delete

docdb-elastic:DeleteClusterdocdb-elastic:GetClusterec2:DescribeVpcEndpointsec2:DeleteVpcEndpointsec2:ModifyVpcEndpointec2:DescribeSecurityGroupsec2:DescribeSubnetsec2:DescribeVpcAttribute

list

docdb-elastic:ListClusters

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

ServiceDocDBElastic
Properties16
Required5
TaggingSupported
Primary IDClusterArn

Supported Operations

CreateReadUpdateDeleteList

Immutable After Creation

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

AdminUserNameAuthTypeClusterNameKmsKeyId

External Links