AWS::DocDBElastic::ClusterSnapshotResource Type definition for AWS::DocDBElastic::ClusterSnapshot. Creates a manual snapshot of an Amazon DocumentDB elastic cluster.
3 configurable properties. 2 required. Click a row to see details.
| Property | Type | Flags |
|---|---|---|
ClusterArn | string | RequiredCreate-only |
SnapshotName | string | RequiredCreate-only |
Tags | Array<Tag> |
Values returned after the resource is created. Access these with Fn::GetAtt.
| Attribute | Type | Description |
|---|---|---|
AdminUserName | string | The name of the elastic cluster administrator. |
ClusterCreationTime | string | The time when the source elastic cluster was created, in Universal Coordinated Time (UTC). |
KmsKeyId | string | The KMS key identifier used to encrypt the source elastic cluster. |
SnapshotArn | string | The Amazon Resource Name (ARN) of the elastic cluster snapshot. |
SnapshotCreationTime | string | The time when the elastic cluster snapshot was created, in Universal Coordinated Time (UTC). |
SnapshotType | string | The type of the elastic cluster snapshot (manual or automated). |
Status | string | The status of the elastic cluster snapshot. |
SubnetIds | Array<string> | The Amazon EC2 subnet IDs associated with the source elastic cluster. |
VpcSecurityGroupIds | Array<string> | The Amazon EC2 security group IDs associated with the source elastic cluster. |
A minimal template with required properties and common optional ones.
AWSTemplateFormatVersion: "2010-09-09"
Description: Sample template for AWS::DocDBElastic::ClusterSnapshot
Resources:
MyResource:
Type: AWS::DocDBElastic::ClusterSnapshot
Properties:
ClusterArn: "arn:aws:service:region:account:resource"
SnapshotName: "my-snapshotname"
Tags:
- Key: Environment
Value: ProductionPermissions CloudFormation needs in your IAM role to manage this resource.
docdb-elastic:CreateClusterSnapshotdocdb-elastic:GetClusterSnapshotdocdb-elastic:TagResourcedocdb-elastic:GetClusterSnapshotdocdb-elastic:ListTagsForResourcedocdb-elastic:GetClusterSnapshotdocdb-elastic:TagResourcedocdb-elastic:UntagResourcedocdb-elastic:ListTagsForResourcedocdb-elastic:DeleteClusterSnapshotdocdb-elastic:GetClusterSnapshotdocdb-elastic:ListClusterSnapshotsOur bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.
Subscribe to NewsletterSnapshotArnThese properties cannot be changed after the resource is created. Updating them triggers a replacement.
ClusterArnSnapshotName