Sign in Dashboard Get started
  1. Registry
  2. Packages
  3. AWS Cloud Control
  4. API Docs
  5. docdbelastic
  6. getClusterSnapshot

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
Schema (JSON)
pulumi/pulumi-aws-native

aws-native.docdbelastic.getClusterSnapshot

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
Schema (JSON)
pulumi/pulumi-aws-native

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

    Using getClusterSnapshot

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getClusterSnapshot(args: GetClusterSnapshotArgs, opts?: InvokeOptions): Promise<GetClusterSnapshotResult>
function getClusterSnapshotOutput(args: GetClusterSnapshotOutputArgs, opts?: InvokeOutputOptions): Output<GetClusterSnapshotResult>
    def get_cluster_snapshot(snapshot_arn: Optional[str] = None,
                         opts: Optional[InvokeOptions] = None) -> GetClusterSnapshotResult
def get_cluster_snapshot_output(snapshot_arn: pulumi.Input[Optional[str]] = None,
                         opts: Optional[InvokeOutputOptions] = None) -> Output[GetClusterSnapshotResult]
    func LookupClusterSnapshot(ctx *Context, args *LookupClusterSnapshotArgs, opts ...InvokeOption) (*LookupClusterSnapshotResult, error)
func LookupClusterSnapshotOutput(ctx *Context, args *LookupClusterSnapshotOutputArgs, opts ...InvokeOption) LookupClusterSnapshotResultOutput

    > Note: This function is named LookupClusterSnapshot in the Go SDK.

    public static class GetClusterSnapshot 
{
    public static Task<GetClusterSnapshotResult> InvokeAsync(GetClusterSnapshotArgs args, InvokeOptions? opts = null)
    public static Output<GetClusterSnapshotResult> Invoke(GetClusterSnapshotInvokeArgs args, InvokeOptions? opts = null)
    public static Output<GetClusterSnapshotResult> Invoke(GetClusterSnapshotInvokeArgs args, InvokeOutputOptions opts)
}
    public static CompletableFuture<GetClusterSnapshotResult> getClusterSnapshot(GetClusterSnapshotArgs args, InvokeOptions options)
public static Output<GetClusterSnapshotResult> getClusterSnapshot(GetClusterSnapshotArgs args, InvokeOptions options)
public static Output<GetClusterSnapshotResult> getClusterSnapshot(GetClusterSnapshotArgs args, InvokeOutputOptions options)

    fn::invoke:
  function: aws-native:docdbelastic:getClusterSnapshot
  arguments:
    # arguments dictionary
    data "aws-native_docdbelastic_get_cluster_snapshot" "name" {
    # arguments
}

    The following arguments are supported:

    SnapshotArn string
    The Amazon Resource Name (ARN) of the elastic cluster snapshot.
    SnapshotArn string
    The Amazon Resource Name (ARN) of the elastic cluster snapshot.
    snapshot_arn string
    The Amazon Resource Name (ARN) of the elastic cluster snapshot.
    snapshotArn String
    The Amazon Resource Name (ARN) of the elastic cluster snapshot.
    snapshotArn string
    The Amazon Resource Name (ARN) of the elastic cluster snapshot.
    snapshot_arn str
    The Amazon Resource Name (ARN) of the elastic cluster snapshot.
    snapshotArn String
    The Amazon Resource Name (ARN) of the elastic cluster snapshot.

    getClusterSnapshot Result

    The following output properties are available:

    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 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.
    Tags List<Pulumi.AwsNative.Outputs.Tag>
    An array of key-value pairs to apply to the elastic cluster snapshot.
    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).
    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.
    Tags Tag
    An array of key-value pairs to apply to the elastic cluster snapshot.
    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).
    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.
    tags list(object)
    An array of key-value pairs to apply to the elastic cluster snapshot.
    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).
    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.
    tags List<Tag>
    An array of key-value pairs to apply to the elastic cluster snapshot.
    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).
    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.
    tags Tag[]
    An array of key-value pairs to apply to the elastic cluster snapshot.
    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).
    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.
    tags Sequence[root_Tag]
    An array of key-value pairs to apply to the elastic cluster snapshot.
    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).
    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.
    tags List<Property Map>
    An array of key-value pairs to apply to the elastic cluster snapshot.
    vpcSecurityGroupIds List<String>
    The Amazon EC2 security group IDs associated with the source elastic cluster.

    Supporting Types

    ClusterSnapshotSnapshotType

    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 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
    Schema (JSON)
    pulumi/pulumi-aws-native

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial