1. Registry
  2. Packages
  3. AWS Cloud Control
  4. API Docs
  5. docdbelastic
  6. ClusterSnapshot

We recommend new projects start with resources from the AWS provider.

Viewing docs for AWS Cloud Control v1.80.0
published on Monday, Sep 21, 2026 by Pulumi
aws-native logo aws-native logo

We recommend new projects start with resources from the AWS provider.

Viewing docs for AWS Cloud Control v1.80.0
published on Monday, Sep 21, 2026 by Pulumi

    Resource Type definition for AWS::DocDBElastic::ClusterSnapshot. Creates a manual snapshot of an Amazon DocumentDB elastic cluster.

    Create ClusterSnapshot Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new ClusterSnapshot(name: string, args: ClusterSnapshotArgs, opts?: CustomResourceOptions);
    @overload
    def ClusterSnapshot(resource_name: str,
                        args: ClusterSnapshotArgs,
                        opts: Optional[ResourceOptions] = None)
    
    @overload
    def ClusterSnapshot(resource_name: str,
                        opts: Optional[ResourceOptions] = None,
                        cluster_arn: Optional[str] = None,
                        snapshot_name: Optional[str] = None,
                        tags: Optional[Sequence[_root_inputs.TagArgs]] = None)
    func NewClusterSnapshot(ctx *Context, name string, args ClusterSnapshotArgs, opts ...ResourceOption) (*ClusterSnapshot, error)
    public ClusterSnapshot(string name, ClusterSnapshotArgs args, CustomResourceOptions? opts = null)
    public ClusterSnapshot(String name, ClusterSnapshotArgs args)
    public ClusterSnapshot(String name, ClusterSnapshotArgs args, CustomResourceOptions options)
    
    type: aws-native:docdbelastic:ClusterSnapshot
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    resource "aws-native_docdbelastic_cluster_snapshot" "name" {
        # resource properties
    }

    Parameters

    name string
    The unique name of the resource.
    args ClusterSnapshotArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args ClusterSnapshotArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args ClusterSnapshotArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ClusterSnapshotArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ClusterSnapshotArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    ClusterSnapshot Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The ClusterSnapshot resource accepts the following input properties:

    ClusterArn string
    The ARN of the elastic cluster of which to create a snapshot.
    SnapshotName string
    The name of the elastic cluster snapshot.
    Tags List<Pulumi.AwsNative.Inputs.Tag>
    An array of key-value pairs to apply to the elastic cluster snapshot.
    ClusterArn string
    The ARN of the elastic cluster of which to create a snapshot.
    SnapshotName string
    The name of the elastic cluster snapshot.
    Tags TagArgs
    An array of key-value pairs to apply to the elastic cluster snapshot.
    cluster_arn string
    The ARN of the elastic cluster of which to create a snapshot.
    snapshot_name string
    The name of the elastic cluster snapshot.
    tags list(object)
    An array of key-value pairs to apply to the elastic cluster snapshot.
    clusterArn String
    The ARN of the elastic cluster of which to create a snapshot.
    snapshotName String
    The name of the elastic cluster snapshot.
    tags List<Tag>
    An array of key-value pairs to apply to the elastic cluster snapshot.
    clusterArn string
    The ARN of the elastic cluster of which to create a snapshot.
    snapshotName string
    The name of the elastic cluster snapshot.
    tags Tag[]
    An array of key-value pairs to apply to the elastic cluster snapshot.
    cluster_arn str
    The ARN of the elastic cluster of which to create a snapshot.
    snapshot_name str
    The name of the elastic cluster snapshot.
    tags Sequence[TagArgs]
    An array of key-value pairs to apply to the elastic cluster snapshot.
    clusterArn String
    The ARN of the elastic cluster of which to create a snapshot.
    snapshotName String
    The name of the elastic cluster snapshot.
    tags List<Property Map>
    An array of key-value pairs to apply to the elastic cluster snapshot.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the ClusterSnapshot resource produces the following output properties:

    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).
    Id string
    The provider-assigned unique ID for this managed resource.
    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 Pulumi.AwsNative.DocDbElastic.ClusterSnapshotSnapshotType
    The type of the elastic cluster snapshot (manual or automated).
    Status string
    The status of the elastic cluster snapshot.
    SubnetIds List<string>
    The Amazon EC2 subnet IDs associated with the source elastic cluster.
    VpcSecurityGroupIds List<string>
    The Amazon EC2 security group IDs associated with the source elastic cluster.
    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).
    Id string
    The provider-assigned unique ID for this managed resource.
    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 ClusterSnapshotSnapshotType
    The type of the elastic cluster snapshot (manual or automated).
    Status string
    The status of the elastic cluster snapshot.
    SubnetIds []string
    The Amazon EC2 subnet IDs associated with the source elastic cluster.
    VpcSecurityGroupIds []string
    The Amazon EC2 security group IDs associated with the source elastic cluster.
    admin_user_name string
    The name of the elastic cluster administrator.
    cluster_creation_time string
    The time when the source elastic cluster was created, in Universal Coordinated Time (UTC).
    id string
    The provider-assigned unique ID for this managed resource.
    kms_key_id string
    The KMS key identifier used to encrypt the source elastic cluster.
    snapshot_arn string
    The Amazon Resource Name (ARN) of the elastic cluster snapshot.
    snapshot_creation_time string
    The time when the elastic cluster snapshot was created, in Universal Coordinated Time (UTC).
    snapshot_type "MANUAL" | "AUTOMATED"
    The type of the elastic cluster snapshot (manual or automated).
    status string
    The status of the elastic cluster snapshot.
    subnet_ids list(string)
    The Amazon EC2 subnet IDs associated with the source elastic cluster.
    vpc_security_group_ids list(string)
    The Amazon EC2 security group IDs associated with the source elastic cluster.
    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).
    id String
    The provider-assigned unique ID for this managed resource.
    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 ClusterSnapshotSnapshotType
    The type of the elastic cluster snapshot (manual or automated).
    status String
    The status of the elastic cluster snapshot.
    subnetIds List<String>
    The Amazon EC2 subnet IDs associated with the source elastic cluster.
    vpcSecurityGroupIds List<String>
    The Amazon EC2 security group IDs associated with the source elastic cluster.
    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).
    id string
    The provider-assigned unique ID for this managed resource.
    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 ClusterSnapshotSnapshotType
    The type of the elastic cluster snapshot (manual or automated).
    status string
    The status of the elastic cluster snapshot.
    subnetIds string[]
    The Amazon EC2 subnet IDs associated with the source elastic cluster.
    vpcSecurityGroupIds string[]
    The Amazon EC2 security group IDs associated with the source elastic cluster.
    admin_user_name str
    The name of the elastic cluster administrator.
    cluster_creation_time str
    The time when the source elastic cluster was created, in Universal Coordinated Time (UTC).
    id str
    The provider-assigned unique ID for this managed resource.
    kms_key_id str
    The KMS key identifier used to encrypt the source elastic cluster.
    snapshot_arn str
    The Amazon Resource Name (ARN) of the elastic cluster snapshot.
    snapshot_creation_time str
    The time when the elastic cluster snapshot was created, in Universal Coordinated Time (UTC).
    snapshot_type ClusterSnapshotSnapshotType
    The type of the elastic cluster snapshot (manual or automated).
    status str
    The status of the elastic cluster snapshot.
    subnet_ids Sequence[str]
    The Amazon EC2 subnet IDs associated with the source elastic cluster.
    vpc_security_group_ids Sequence[str]
    The Amazon EC2 security group IDs associated with the source elastic cluster.
    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).
    id String
    The provider-assigned unique ID for this managed resource.
    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 "MANUAL" | "AUTOMATED"
    The type of the elastic cluster snapshot (manual or automated).
    status String
    The status of the elastic cluster snapshot.
    subnetIds List<String>
    The Amazon EC2 subnet IDs associated with the source elastic cluster.
    vpcSecurityGroupIds List<String>
    The Amazon EC2 security group IDs associated with the source elastic cluster.

    Supporting Types

    ClusterSnapshotSnapshotType, ClusterSnapshotSnapshotTypeArgs

    Manual
    MANUAL
    Automated
    AUTOMATED
    ClusterSnapshotSnapshotTypeManual
    MANUAL
    ClusterSnapshotSnapshotTypeAutomated
    AUTOMATED
    "MANUAL"
    MANUAL
    "AUTOMATED"
    AUTOMATED
    Manual
    MANUAL
    Automated
    AUTOMATED
    Manual
    MANUAL
    Automated
    AUTOMATED
    MANUAL
    MANUAL
    AUTOMATED
    AUTOMATED
    "MANUAL"
    MANUAL
    "AUTOMATED"
    AUTOMATED

    Tag, TagArgs

    A set of tags to apply to the resource.
    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo aws-native logo

    We recommend new projects start with resources from the AWS provider.

    Viewing docs for AWS Cloud Control v1.80.0
    published on Monday, Sep 21, 2026 by Pulumi

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial