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

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

Viewing docs for AWS Cloud Control v1.78.0
published on Monday, Sep 7, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-aws-native

aws-native.rds.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.78.0
published on Monday, Sep 7, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-aws-native

    Creates a snapshot of a DB 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(db_cluster_snapshot_arn: Optional[str] = None,
                         opts: Optional[InvokeOptions] = None) -> GetClusterSnapshotResult
def get_cluster_snapshot_output(db_cluster_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:rds:getClusterSnapshot
  arguments:
    # arguments dictionary
    data "aws-native_rds_get_cluster_snapshot" "name" {
    # arguments
}

    The following arguments are supported:

    DbClusterSnapshotArn string
    The Amazon Resource Name (ARN) for the DB cluster snapshot.
    DbClusterSnapshotArn string
    The Amazon Resource Name (ARN) for the DB cluster snapshot.
    db_cluster_snapshot_arn string
    The Amazon Resource Name (ARN) for the DB cluster snapshot.
    dbClusterSnapshotArn String
    The Amazon Resource Name (ARN) for the DB cluster snapshot.
    dbClusterSnapshotArn string
    The Amazon Resource Name (ARN) for the DB cluster snapshot.
    db_cluster_snapshot_arn str
    The Amazon Resource Name (ARN) for the DB cluster snapshot.
    dbClusterSnapshotArn String
    The Amazon Resource Name (ARN) for the DB cluster snapshot.

    getClusterSnapshot Result

    The following output properties are available:

    AllocatedStorage int
    The allocated storage size of the DB cluster snapshot in gibibytes (GiB).
    AvailabilityZones List<string>
    The list of Availability Zones where instances in the DB cluster snapshot can be restored.
    ClusterCreateTime string
    The time when the DB cluster was created, in Universal Coordinated Time (UTC).
    DbClusterResourceId string
    The resource ID of the DB cluster that this DB cluster snapshot was created from.
    DbClusterSnapshotArn string
    The Amazon Resource Name (ARN) for the DB cluster snapshot.
    Engine string
    The name of the database engine for this DB cluster snapshot.
    EngineMode string
    The engine mode of the database engine for this DB cluster snapshot.
    EngineVersion string
    The version of the database engine for this DB cluster snapshot.
    IamDatabaseAuthenticationEnabled bool
    Indicates whether mapping of AWS IAM accounts to database accounts is enabled.
    KmsKeyId string
    If StorageEncrypted is true, the AWS KMS key identifier for the encrypted DB cluster snapshot.
    LicenseModel string
    The license model information for this DB cluster snapshot.
    MasterUsername string
    The master username for this DB cluster snapshot.
    Port int
    The port that the DB cluster was listening on at the time of the snapshot.
    SnapshotCreateTime string
    The time when the snapshot was taken, in Universal Coordinated Time (UTC).
    SnapshotType string
    The type of the DB cluster snapshot.
    Status string
    The status of this DB cluster snapshot.
    StorageEncrypted bool
    Indicates whether the DB cluster snapshot is encrypted.
    Tags List<Pulumi.AwsNative.Outputs.Tag>
    The tags to be assigned to the DB cluster snapshot.
    VpcId string
    The VPC ID associated with the DB cluster snapshot.
    AllocatedStorage int
    The allocated storage size of the DB cluster snapshot in gibibytes (GiB).
    AvailabilityZones []string
    The list of Availability Zones where instances in the DB cluster snapshot can be restored.
    ClusterCreateTime string
    The time when the DB cluster was created, in Universal Coordinated Time (UTC).
    DbClusterResourceId string
    The resource ID of the DB cluster that this DB cluster snapshot was created from.
    DbClusterSnapshotArn string
    The Amazon Resource Name (ARN) for the DB cluster snapshot.
    Engine string
    The name of the database engine for this DB cluster snapshot.
    EngineMode string
    The engine mode of the database engine for this DB cluster snapshot.
    EngineVersion string
    The version of the database engine for this DB cluster snapshot.
    IamDatabaseAuthenticationEnabled bool
    Indicates whether mapping of AWS IAM accounts to database accounts is enabled.
    KmsKeyId string
    If StorageEncrypted is true, the AWS KMS key identifier for the encrypted DB cluster snapshot.
    LicenseModel string
    The license model information for this DB cluster snapshot.
    MasterUsername string
    The master username for this DB cluster snapshot.
    Port int
    The port that the DB cluster was listening on at the time of the snapshot.
    SnapshotCreateTime string
    The time when the snapshot was taken, in Universal Coordinated Time (UTC).
    SnapshotType string
    The type of the DB cluster snapshot.
    Status string
    The status of this DB cluster snapshot.
    StorageEncrypted bool
    Indicates whether the DB cluster snapshot is encrypted.
    Tags Tag
    The tags to be assigned to the DB cluster snapshot.
    VpcId string
    The VPC ID associated with the DB cluster snapshot.
    allocated_storage number
    The allocated storage size of the DB cluster snapshot in gibibytes (GiB).
    availability_zones list(string)
    The list of Availability Zones where instances in the DB cluster snapshot can be restored.
    cluster_create_time string
    The time when the DB cluster was created, in Universal Coordinated Time (UTC).
    db_cluster_resource_id string
    The resource ID of the DB cluster that this DB cluster snapshot was created from.
    db_cluster_snapshot_arn string
    The Amazon Resource Name (ARN) for the DB cluster snapshot.
    engine string
    The name of the database engine for this DB cluster snapshot.
    engine_mode string
    The engine mode of the database engine for this DB cluster snapshot.
    engine_version string
    The version of the database engine for this DB cluster snapshot.
    iam_database_authentication_enabled bool
    Indicates whether mapping of AWS IAM accounts to database accounts is enabled.
    kms_key_id string
    If StorageEncrypted is true, the AWS KMS key identifier for the encrypted DB cluster snapshot.
    license_model string
    The license model information for this DB cluster snapshot.
    master_username string
    The master username for this DB cluster snapshot.
    port number
    The port that the DB cluster was listening on at the time of the snapshot.
    snapshot_create_time string
    The time when the snapshot was taken, in Universal Coordinated Time (UTC).
    snapshot_type string
    The type of the DB cluster snapshot.
    status string
    The status of this DB cluster snapshot.
    storage_encrypted bool
    Indicates whether the DB cluster snapshot is encrypted.
    tags list(object)
    The tags to be assigned to the DB cluster snapshot.
    vpc_id string
    The VPC ID associated with the DB cluster snapshot.
    allocatedStorage Integer
    The allocated storage size of the DB cluster snapshot in gibibytes (GiB).
    availabilityZones List<String>
    The list of Availability Zones where instances in the DB cluster snapshot can be restored.
    clusterCreateTime String
    The time when the DB cluster was created, in Universal Coordinated Time (UTC).
    dbClusterResourceId String
    The resource ID of the DB cluster that this DB cluster snapshot was created from.
    dbClusterSnapshotArn String
    The Amazon Resource Name (ARN) for the DB cluster snapshot.
    engine String
    The name of the database engine for this DB cluster snapshot.
    engineMode String
    The engine mode of the database engine for this DB cluster snapshot.
    engineVersion String
    The version of the database engine for this DB cluster snapshot.
    iamDatabaseAuthenticationEnabled Boolean
    Indicates whether mapping of AWS IAM accounts to database accounts is enabled.
    kmsKeyId String
    If StorageEncrypted is true, the AWS KMS key identifier for the encrypted DB cluster snapshot.
    licenseModel String
    The license model information for this DB cluster snapshot.
    masterUsername String
    The master username for this DB cluster snapshot.
    port Integer
    The port that the DB cluster was listening on at the time of the snapshot.
    snapshotCreateTime String
    The time when the snapshot was taken, in Universal Coordinated Time (UTC).
    snapshotType String
    The type of the DB cluster snapshot.
    status String
    The status of this DB cluster snapshot.
    storageEncrypted Boolean
    Indicates whether the DB cluster snapshot is encrypted.
    tags List<Tag>
    The tags to be assigned to the DB cluster snapshot.
    vpcId String
    The VPC ID associated with the DB cluster snapshot.
    allocatedStorage number
    The allocated storage size of the DB cluster snapshot in gibibytes (GiB).
    availabilityZones string[]
    The list of Availability Zones where instances in the DB cluster snapshot can be restored.
    clusterCreateTime string
    The time when the DB cluster was created, in Universal Coordinated Time (UTC).
    dbClusterResourceId string
    The resource ID of the DB cluster that this DB cluster snapshot was created from.
    dbClusterSnapshotArn string
    The Amazon Resource Name (ARN) for the DB cluster snapshot.
    engine string
    The name of the database engine for this DB cluster snapshot.
    engineMode string
    The engine mode of the database engine for this DB cluster snapshot.
    engineVersion string
    The version of the database engine for this DB cluster snapshot.
    iamDatabaseAuthenticationEnabled boolean
    Indicates whether mapping of AWS IAM accounts to database accounts is enabled.
    kmsKeyId string
    If StorageEncrypted is true, the AWS KMS key identifier for the encrypted DB cluster snapshot.
    licenseModel string
    The license model information for this DB cluster snapshot.
    masterUsername string
    The master username for this DB cluster snapshot.
    port number
    The port that the DB cluster was listening on at the time of the snapshot.
    snapshotCreateTime string
    The time when the snapshot was taken, in Universal Coordinated Time (UTC).
    snapshotType string
    The type of the DB cluster snapshot.
    status string
    The status of this DB cluster snapshot.
    storageEncrypted boolean
    Indicates whether the DB cluster snapshot is encrypted.
    tags Tag[]
    The tags to be assigned to the DB cluster snapshot.
    vpcId string
    The VPC ID associated with the DB cluster snapshot.
    allocated_storage int
    The allocated storage size of the DB cluster snapshot in gibibytes (GiB).
    availability_zones Sequence[str]
    The list of Availability Zones where instances in the DB cluster snapshot can be restored.
    cluster_create_time str
    The time when the DB cluster was created, in Universal Coordinated Time (UTC).
    db_cluster_resource_id str
    The resource ID of the DB cluster that this DB cluster snapshot was created from.
    db_cluster_snapshot_arn str
    The Amazon Resource Name (ARN) for the DB cluster snapshot.
    engine str
    The name of the database engine for this DB cluster snapshot.
    engine_mode str
    The engine mode of the database engine for this DB cluster snapshot.
    engine_version str
    The version of the database engine for this DB cluster snapshot.
    iam_database_authentication_enabled bool
    Indicates whether mapping of AWS IAM accounts to database accounts is enabled.
    kms_key_id str
    If StorageEncrypted is true, the AWS KMS key identifier for the encrypted DB cluster snapshot.
    license_model str
    The license model information for this DB cluster snapshot.
    master_username str
    The master username for this DB cluster snapshot.
    port int
    The port that the DB cluster was listening on at the time of the snapshot.
    snapshot_create_time str
    The time when the snapshot was taken, in Universal Coordinated Time (UTC).
    snapshot_type str
    The type of the DB cluster snapshot.
    status str
    The status of this DB cluster snapshot.
    storage_encrypted bool
    Indicates whether the DB cluster snapshot is encrypted.
    tags Sequence[root_Tag]
    The tags to be assigned to the DB cluster snapshot.
    vpc_id str
    The VPC ID associated with the DB cluster snapshot.
    allocatedStorage Number
    The allocated storage size of the DB cluster snapshot in gibibytes (GiB).
    availabilityZones List<String>
    The list of Availability Zones where instances in the DB cluster snapshot can be restored.
    clusterCreateTime String
    The time when the DB cluster was created, in Universal Coordinated Time (UTC).
    dbClusterResourceId String
    The resource ID of the DB cluster that this DB cluster snapshot was created from.
    dbClusterSnapshotArn String
    The Amazon Resource Name (ARN) for the DB cluster snapshot.
    engine String
    The name of the database engine for this DB cluster snapshot.
    engineMode String
    The engine mode of the database engine for this DB cluster snapshot.
    engineVersion String
    The version of the database engine for this DB cluster snapshot.
    iamDatabaseAuthenticationEnabled Boolean
    Indicates whether mapping of AWS IAM accounts to database accounts is enabled.
    kmsKeyId String
    If StorageEncrypted is true, the AWS KMS key identifier for the encrypted DB cluster snapshot.
    licenseModel String
    The license model information for this DB cluster snapshot.
    masterUsername String
    The master username for this DB cluster snapshot.
    port Number
    The port that the DB cluster was listening on at the time of the snapshot.
    snapshotCreateTime String
    The time when the snapshot was taken, in Universal Coordinated Time (UTC).
    snapshotType String
    The type of the DB cluster snapshot.
    status String
    The status of this DB cluster snapshot.
    storageEncrypted Boolean
    Indicates whether the DB cluster snapshot is encrypted.
    tags List<Property Map>
    The tags to be assigned to the DB cluster snapshot.
    vpcId String
    The VPC ID associated with the DB cluster snapshot.

    Supporting Types

    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.78.0
    published on Monday, Sep 7, 2026 by Pulumi
    Schema (JSON)
    pulumi/pulumi-aws-native

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial