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

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

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

aws-native.memorydb.getSnapshot

aws-native logo aws-native logo

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

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

    Resource Type definition for AWS::MemoryDB::Snapshot. Represents a copy of an entire cluster as of the time when the snapshot was taken.

    Using getSnapshot

    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 getSnapshot(args: GetSnapshotArgs, opts?: InvokeOptions): Promise<GetSnapshotResult>
function getSnapshotOutput(args: GetSnapshotOutputArgs, opts?: InvokeOutputOptions): Output<GetSnapshotResult>
    def get_snapshot(arn: Optional[str] = None,
                 opts: Optional[InvokeOptions] = None) -> GetSnapshotResult
def get_snapshot_output(arn: pulumi.Input[Optional[str]] = None,
                 opts: Optional[InvokeOutputOptions] = None) -> Output[GetSnapshotResult]
    func LookupSnapshot(ctx *Context, args *LookupSnapshotArgs, opts ...InvokeOption) (*LookupSnapshotResult, error)
func LookupSnapshotOutput(ctx *Context, args *LookupSnapshotOutputArgs, opts ...InvokeOption) LookupSnapshotResultOutput

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

    public static class GetSnapshot 
{
    public static Task<GetSnapshotResult> InvokeAsync(GetSnapshotArgs args, InvokeOptions? opts = null)
    public static Output<GetSnapshotResult> Invoke(GetSnapshotInvokeArgs args, InvokeOptions? opts = null)
    public static Output<GetSnapshotResult> Invoke(GetSnapshotInvokeArgs args, InvokeOutputOptions opts)
}
    public static CompletableFuture<GetSnapshotResult> getSnapshot(GetSnapshotArgs args, InvokeOptions options)
public static Output<GetSnapshotResult> getSnapshot(GetSnapshotArgs args, InvokeOptions options)
public static Output<GetSnapshotResult> getSnapshot(GetSnapshotArgs args, InvokeOutputOptions options)

    fn::invoke:
  function: aws-native:memorydb:getSnapshot
  arguments:
    # arguments dictionary
    data "aws-native_memorydb_get_snapshot" "name" {
    # arguments
}

    The following arguments are supported:

    Arn string
    The ARN (Amazon Resource Name) of the snapshot.
    Arn string
    The ARN (Amazon Resource Name) of the snapshot.
    arn string
    The ARN (Amazon Resource Name) of the snapshot.
    arn String
    The ARN (Amazon Resource Name) of the snapshot.
    arn string
    The ARN (Amazon Resource Name) of the snapshot.
    arn str
    The ARN (Amazon Resource Name) of the snapshot.
    arn String
    The ARN (Amazon Resource Name) of the snapshot.

    getSnapshot Result

    The following output properties are available:

    Arn string
    The ARN (Amazon Resource Name) of the snapshot.
    ClusterConfiguration Pulumi.AwsNative.MemoryDb.Outputs.SnapshotClusterConfiguration
    The configuration of the cluster from which the snapshot was taken.
    DataTiering Pulumi.AwsNative.MemoryDb.SnapshotDataTiering
    Enables data tiering. Data tiering is only supported for clusters using the r6gd node type.
    Source string
    Indicates whether the snapshot is from an automatic backup (automated) or was created manually (manual).
    Status string
    The status of the snapshot. Valid values: creating | available | restoring | copying | deleting.
    Tags List<Pulumi.AwsNative.Outputs.Tag>
    A list of tags to be added to this resource.
    Arn string
    The ARN (Amazon Resource Name) of the snapshot.
    ClusterConfiguration SnapshotClusterConfiguration
    The configuration of the cluster from which the snapshot was taken.
    DataTiering SnapshotDataTiering
    Enables data tiering. Data tiering is only supported for clusters using the r6gd node type.
    Source string
    Indicates whether the snapshot is from an automatic backup (automated) or was created manually (manual).
    Status string
    The status of the snapshot. Valid values: creating | available | restoring | copying | deleting.
    Tags Tag
    A list of tags to be added to this resource.
    arn string
    The ARN (Amazon Resource Name) of the snapshot.
    cluster_configuration object
    The configuration of the cluster from which the snapshot was taken.
    data_tiering "true" | "false"
    Enables data tiering. Data tiering is only supported for clusters using the r6gd node type.
    source string
    Indicates whether the snapshot is from an automatic backup (automated) or was created manually (manual).
    status string
    The status of the snapshot. Valid values: creating | available | restoring | copying | deleting.
    tags list(object)
    A list of tags to be added to this resource.
    arn String
    The ARN (Amazon Resource Name) of the snapshot.
    clusterConfiguration SnapshotClusterConfiguration
    The configuration of the cluster from which the snapshot was taken.
    dataTiering SnapshotDataTiering
    Enables data tiering. Data tiering is only supported for clusters using the r6gd node type.
    source String
    Indicates whether the snapshot is from an automatic backup (automated) or was created manually (manual).
    status String
    The status of the snapshot. Valid values: creating | available | restoring | copying | deleting.
    tags List<Tag>
    A list of tags to be added to this resource.
    arn string
    The ARN (Amazon Resource Name) of the snapshot.
    clusterConfiguration SnapshotClusterConfiguration
    The configuration of the cluster from which the snapshot was taken.
    dataTiering SnapshotDataTiering
    Enables data tiering. Data tiering is only supported for clusters using the r6gd node type.
    source string
    Indicates whether the snapshot is from an automatic backup (automated) or was created manually (manual).
    status string
    The status of the snapshot. Valid values: creating | available | restoring | copying | deleting.
    tags Tag[]
    A list of tags to be added to this resource.
    arn str
    The ARN (Amazon Resource Name) of the snapshot.
    cluster_configuration SnapshotClusterConfiguration
    The configuration of the cluster from which the snapshot was taken.
    data_tiering SnapshotDataTiering
    Enables data tiering. Data tiering is only supported for clusters using the r6gd node type.
    source str
    Indicates whether the snapshot is from an automatic backup (automated) or was created manually (manual).
    status str
    The status of the snapshot. Valid values: creating | available | restoring | copying | deleting.
    tags Sequence[root_Tag]
    A list of tags to be added to this resource.
    arn String
    The ARN (Amazon Resource Name) of the snapshot.
    clusterConfiguration Property Map
    The configuration of the cluster from which the snapshot was taken.
    dataTiering "true" | "false"
    Enables data tiering. Data tiering is only supported for clusters using the r6gd node type.
    source String
    Indicates whether the snapshot is from an automatic backup (automated) or was created manually (manual).
    status String
    The status of the snapshot. Valid values: creating | available | restoring | copying | deleting.
    tags List<Property Map>
    A list of tags to be added to this resource.

    Supporting Types

    SnapshotClusterConfiguration

    Description string
    The description of the cluster configuration.
    Engine string
    The name of the engine used by the cluster configuration.
    EngineVersion string
    The Redis OSS engine version used by the cluster.
    MaintenanceWindow string
    The specified maintenance window for the cluster.
    Name string
    The name of the cluster.
    NodeType string
    The node type used for the cluster.
    NumShards int
    The number of shards in the cluster.
    ParameterGroupName string
    The name of parameter group used by the cluster.
    Port int
    The port used by the cluster.
    SnapshotRetentionLimit int
    The snapshot retention limit set by the cluster.
    SnapshotWindow string
    The snapshot window set by the cluster.
    SubnetGroupName string
    The name of the subnet group used by the cluster.
    TopicArn string
    The Amazon Resource Name (ARN) of the SNS notification topic for the cluster.
    VpcId string
    The ID of the VPC the cluster belongs to.
    Description string
    The description of the cluster configuration.
    Engine string
    The name of the engine used by the cluster configuration.
    EngineVersion string
    The Redis OSS engine version used by the cluster.
    MaintenanceWindow string
    The specified maintenance window for the cluster.
    Name string
    The name of the cluster.
    NodeType string
    The node type used for the cluster.
    NumShards int
    The number of shards in the cluster.
    ParameterGroupName string
    The name of parameter group used by the cluster.
    Port int
    The port used by the cluster.
    SnapshotRetentionLimit int
    The snapshot retention limit set by the cluster.
    SnapshotWindow string
    The snapshot window set by the cluster.
    SubnetGroupName string
    The name of the subnet group used by the cluster.
    TopicArn string
    The Amazon Resource Name (ARN) of the SNS notification topic for the cluster.
    VpcId string
    The ID of the VPC the cluster belongs to.
    description string
    The description of the cluster configuration.
    engine string
    The name of the engine used by the cluster configuration.
    engine_version string
    The Redis OSS engine version used by the cluster.
    maintenance_window string
    The specified maintenance window for the cluster.
    name string
    The name of the cluster.
    node_type string
    The node type used for the cluster.
    num_shards number
    The number of shards in the cluster.
    parameter_group_name string
    The name of parameter group used by the cluster.
    port number
    The port used by the cluster.
    snapshot_retention_limit number
    The snapshot retention limit set by the cluster.
    snapshot_window string
    The snapshot window set by the cluster.
    subnet_group_name string
    The name of the subnet group used by the cluster.
    topic_arn string
    The Amazon Resource Name (ARN) of the SNS notification topic for the cluster.
    vpc_id string
    The ID of the VPC the cluster belongs to.
    description String
    The description of the cluster configuration.
    engine String
    The name of the engine used by the cluster configuration.
    engineVersion String
    The Redis OSS engine version used by the cluster.
    maintenanceWindow String
    The specified maintenance window for the cluster.
    name String
    The name of the cluster.
    nodeType String
    The node type used for the cluster.
    numShards Integer
    The number of shards in the cluster.
    parameterGroupName String
    The name of parameter group used by the cluster.
    port Integer
    The port used by the cluster.
    snapshotRetentionLimit Integer
    The snapshot retention limit set by the cluster.
    snapshotWindow String
    The snapshot window set by the cluster.
    subnetGroupName String
    The name of the subnet group used by the cluster.
    topicArn String
    The Amazon Resource Name (ARN) of the SNS notification topic for the cluster.
    vpcId String
    The ID of the VPC the cluster belongs to.
    description string
    The description of the cluster configuration.
    engine string
    The name of the engine used by the cluster configuration.
    engineVersion string
    The Redis OSS engine version used by the cluster.
    maintenanceWindow string
    The specified maintenance window for the cluster.
    name string
    The name of the cluster.
    nodeType string
    The node type used for the cluster.
    numShards number
    The number of shards in the cluster.
    parameterGroupName string
    The name of parameter group used by the cluster.
    port number
    The port used by the cluster.
    snapshotRetentionLimit number
    The snapshot retention limit set by the cluster.
    snapshotWindow string
    The snapshot window set by the cluster.
    subnetGroupName string
    The name of the subnet group used by the cluster.
    topicArn string
    The Amazon Resource Name (ARN) of the SNS notification topic for the cluster.
    vpcId string
    The ID of the VPC the cluster belongs to.
    description str
    The description of the cluster configuration.
    engine str
    The name of the engine used by the cluster configuration.
    engine_version str
    The Redis OSS engine version used by the cluster.
    maintenance_window str
    The specified maintenance window for the cluster.
    name str
    The name of the cluster.
    node_type str
    The node type used for the cluster.
    num_shards int
    The number of shards in the cluster.
    parameter_group_name str
    The name of parameter group used by the cluster.
    port int
    The port used by the cluster.
    snapshot_retention_limit int
    The snapshot retention limit set by the cluster.
    snapshot_window str
    The snapshot window set by the cluster.
    subnet_group_name str
    The name of the subnet group used by the cluster.
    topic_arn str
    The Amazon Resource Name (ARN) of the SNS notification topic for the cluster.
    vpc_id str
    The ID of the VPC the cluster belongs to.
    description String
    The description of the cluster configuration.
    engine String
    The name of the engine used by the cluster configuration.
    engineVersion String
    The Redis OSS engine version used by the cluster.
    maintenanceWindow String
    The specified maintenance window for the cluster.
    name String
    The name of the cluster.
    nodeType String
    The node type used for the cluster.
    numShards Number
    The number of shards in the cluster.
    parameterGroupName String
    The name of parameter group used by the cluster.
    port Number
    The port used by the cluster.
    snapshotRetentionLimit Number
    The snapshot retention limit set by the cluster.
    snapshotWindow String
    The snapshot window set by the cluster.
    subnetGroupName String
    The name of the subnet group used by the cluster.
    topicArn String
    The Amazon Resource Name (ARN) of the SNS notification topic for the cluster.
    vpcId String
    The ID of the VPC the cluster belongs to.

    SnapshotDataTiering

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

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial