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

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

Viewing docs for AWS Cloud Control v1.83.1
published on Thursday, Oct 22, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-aws-native

aws-native.elasticache.getSnapshot

aws-native logo aws-native logo AWS Cloud Control

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

Viewing docs for AWS Cloud Control v1.83.1
published on Thursday, Oct 22, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-aws-native

    Represents a copy of an entire cluster or replication group 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:elasticache:getSnapshot
  arguments:
    # arguments dictionary
    data "aws-native_elasticache_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.
    AutoMinorVersionUpgrade bool
    If true, opt-in to the next auto minor version upgrade campaign.
    AutomaticFailover Pulumi.AwsNative.ElastiCache.SnapshotAutomaticFailover
    Indicates the status of automatic failover for the source replication group.
    CacheClusterCreateTime string
    The date and time when the source cluster was created.
    CacheNodeType string
    The name of the compute and memory capacity node type for the source cluster.
    CacheParameterGroupName string
    The cache parameter group that is associated with the source cluster.
    CacheSubnetGroupName string
    The name of the cache subnet group associated with the source cluster.
    DataTiering Pulumi.AwsNative.ElastiCache.SnapshotDataTiering
    Enables data tiering. Data tiering is only supported for replication groups using the r6gd node type.
    Engine string
    The name of the cache engine used by the source cluster.
    EngineVersion string
    The version of the cache engine version used by the source cluster.
    NodeSnapshots List<Pulumi.AwsNative.ElastiCache.Outputs.SnapshotNodeSnapshot>
    A list of the cache nodes in the source cluster.
    NumCacheNodes int
    The number of cache nodes in the source cluster.
    NumNodeGroups int
    The number of node groups (shards) in this snapshot.
    Port int
    The port number used by each cache nodes in the source cluster.
    PreferredAvailabilityZone string
    The name of the Availability Zone in which the source cluster is located.
    PreferredMaintenanceWindow string
    Specifies the weekly time range during which maintenance on the cluster is performed.
    ReplicationGroupDescription string
    A description of the source replication group.
    SnapshotRetentionLimit int
    For an automatic snapshot, the number of days for which ElastiCache retains the snapshot before deleting it.
    SnapshotSource string
    Indicates whether the snapshot is from an automatic backup (automated) or was created manually (manual).
    SnapshotStatus Pulumi.AwsNative.ElastiCache.SnapshotStatus
    The status of the snapshot. Valid values: creating | available | restoring | copying | deleting | failed | deleted.
    SnapshotWindow string
    The daily time range during which ElastiCache takes daily snapshots of the source cluster.
    Tags List<Pulumi.AwsNative.Outputs.Tag>
    A list of tags to be added to this resource.
    TopicArn string
    The Amazon Resource Name (ARN) for the topic used by the source cluster for publishing notifications.
    VpcId string
    The Amazon Virtual Private Cloud identifier (VPC ID) of the cache subnet group for the source cluster.
    Arn string
    The ARN (Amazon Resource Name) of the snapshot.
    AutoMinorVersionUpgrade bool
    If true, opt-in to the next auto minor version upgrade campaign.
    AutomaticFailover SnapshotAutomaticFailover
    Indicates the status of automatic failover for the source replication group.
    CacheClusterCreateTime string
    The date and time when the source cluster was created.
    CacheNodeType string
    The name of the compute and memory capacity node type for the source cluster.
    CacheParameterGroupName string
    The cache parameter group that is associated with the source cluster.
    CacheSubnetGroupName string
    The name of the cache subnet group associated with the source cluster.
    DataTiering SnapshotDataTiering
    Enables data tiering. Data tiering is only supported for replication groups using the r6gd node type.
    Engine string
    The name of the cache engine used by the source cluster.
    EngineVersion string
    The version of the cache engine version used by the source cluster.
    NodeSnapshots []SnapshotNodeSnapshot
    A list of the cache nodes in the source cluster.
    NumCacheNodes int
    The number of cache nodes in the source cluster.
    NumNodeGroups int
    The number of node groups (shards) in this snapshot.
    Port int
    The port number used by each cache nodes in the source cluster.
    PreferredAvailabilityZone string
    The name of the Availability Zone in which the source cluster is located.
    PreferredMaintenanceWindow string
    Specifies the weekly time range during which maintenance on the cluster is performed.
    ReplicationGroupDescription string
    A description of the source replication group.
    SnapshotRetentionLimit int
    For an automatic snapshot, the number of days for which ElastiCache retains the snapshot before deleting it.
    SnapshotSource string
    Indicates whether the snapshot is from an automatic backup (automated) or was created manually (manual).
    SnapshotStatus SnapshotStatus
    The status of the snapshot. Valid values: creating | available | restoring | copying | deleting | failed | deleted.
    SnapshotWindow string
    The daily time range during which ElastiCache takes daily snapshots of the source cluster.
    Tags Tag
    A list of tags to be added to this resource.
    TopicArn string
    The Amazon Resource Name (ARN) for the topic used by the source cluster for publishing notifications.
    VpcId string
    The Amazon Virtual Private Cloud identifier (VPC ID) of the cache subnet group for the source cluster.
    arn string
    The ARN (Amazon Resource Name) of the snapshot.
    auto_minor_version_upgrade bool
    If true, opt-in to the next auto minor version upgrade campaign.
    automatic_failover "enabled" | "disabled" | "enabling" | "disabling"
    Indicates the status of automatic failover for the source replication group.
    cache_cluster_create_time string
    The date and time when the source cluster was created.
    cache_node_type string
    The name of the compute and memory capacity node type for the source cluster.
    cache_parameter_group_name string
    The cache parameter group that is associated with the source cluster.
    cache_subnet_group_name string
    The name of the cache subnet group associated with the source cluster.
    data_tiering "enabled" | "disabled"
    Enables data tiering. Data tiering is only supported for replication groups using the r6gd node type.
    engine string
    The name of the cache engine used by the source cluster.
    engine_version string
    The version of the cache engine version used by the source cluster.
    node_snapshots list(object)
    A list of the cache nodes in the source cluster.
    num_cache_nodes number
    The number of cache nodes in the source cluster.
    num_node_groups number
    The number of node groups (shards) in this snapshot.
    port number
    The port number used by each cache nodes in the source cluster.
    preferred_availability_zone string
    The name of the Availability Zone in which the source cluster is located.
    preferred_maintenance_window string
    Specifies the weekly time range during which maintenance on the cluster is performed.
    replication_group_description string
    A description of the source replication group.
    snapshot_retention_limit number
    For an automatic snapshot, the number of days for which ElastiCache retains the snapshot before deleting it.
    snapshot_source string
    Indicates whether the snapshot is from an automatic backup (automated) or was created manually (manual).
    snapshot_status "creating" | "available" | "restoring" | "copying" | "deleting" | "failed" | "deleted"
    The status of the snapshot. Valid values: creating | available | restoring | copying | deleting | failed | deleted.
    snapshot_window string
    The daily time range during which ElastiCache takes daily snapshots of the source cluster.
    tags list(object)
    A list of tags to be added to this resource.
    topic_arn string
    The Amazon Resource Name (ARN) for the topic used by the source cluster for publishing notifications.
    vpc_id string
    The Amazon Virtual Private Cloud identifier (VPC ID) of the cache subnet group for the source cluster.
    arn String
    The ARN (Amazon Resource Name) of the snapshot.
    autoMinorVersionUpgrade Boolean
    If true, opt-in to the next auto minor version upgrade campaign.
    automaticFailover SnapshotAutomaticFailover
    Indicates the status of automatic failover for the source replication group.
    cacheClusterCreateTime String
    The date and time when the source cluster was created.
    cacheNodeType String
    The name of the compute and memory capacity node type for the source cluster.
    cacheParameterGroupName String
    The cache parameter group that is associated with the source cluster.
    cacheSubnetGroupName String
    The name of the cache subnet group associated with the source cluster.
    dataTiering SnapshotDataTiering
    Enables data tiering. Data tiering is only supported for replication groups using the r6gd node type.
    engine String
    The name of the cache engine used by the source cluster.
    engineVersion String
    The version of the cache engine version used by the source cluster.
    nodeSnapshots List<SnapshotNodeSnapshot>
    A list of the cache nodes in the source cluster.
    numCacheNodes Integer
    The number of cache nodes in the source cluster.
    numNodeGroups Integer
    The number of node groups (shards) in this snapshot.
    port Integer
    The port number used by each cache nodes in the source cluster.
    preferredAvailabilityZone String
    The name of the Availability Zone in which the source cluster is located.
    preferredMaintenanceWindow String
    Specifies the weekly time range during which maintenance on the cluster is performed.
    replicationGroupDescription String
    A description of the source replication group.
    snapshotRetentionLimit Integer
    For an automatic snapshot, the number of days for which ElastiCache retains the snapshot before deleting it.
    snapshotSource String
    Indicates whether the snapshot is from an automatic backup (automated) or was created manually (manual).
    snapshotStatus SnapshotStatus
    The status of the snapshot. Valid values: creating | available | restoring | copying | deleting | failed | deleted.
    snapshotWindow String
    The daily time range during which ElastiCache takes daily snapshots of the source cluster.
    tags List<Tag>
    A list of tags to be added to this resource.
    topicArn String
    The Amazon Resource Name (ARN) for the topic used by the source cluster for publishing notifications.
    vpcId String
    The Amazon Virtual Private Cloud identifier (VPC ID) of the cache subnet group for the source cluster.
    arn string
    The ARN (Amazon Resource Name) of the snapshot.
    autoMinorVersionUpgrade boolean
    If true, opt-in to the next auto minor version upgrade campaign.
    automaticFailover SnapshotAutomaticFailover
    Indicates the status of automatic failover for the source replication group.
    cacheClusterCreateTime string
    The date and time when the source cluster was created.
    cacheNodeType string
    The name of the compute and memory capacity node type for the source cluster.
    cacheParameterGroupName string
    The cache parameter group that is associated with the source cluster.
    cacheSubnetGroupName string
    The name of the cache subnet group associated with the source cluster.
    dataTiering SnapshotDataTiering
    Enables data tiering. Data tiering is only supported for replication groups using the r6gd node type.
    engine string
    The name of the cache engine used by the source cluster.
    engineVersion string
    The version of the cache engine version used by the source cluster.
    nodeSnapshots SnapshotNodeSnapshot[]
    A list of the cache nodes in the source cluster.
    numCacheNodes number
    The number of cache nodes in the source cluster.
    numNodeGroups number
    The number of node groups (shards) in this snapshot.
    port number
    The port number used by each cache nodes in the source cluster.
    preferredAvailabilityZone string
    The name of the Availability Zone in which the source cluster is located.
    preferredMaintenanceWindow string
    Specifies the weekly time range during which maintenance on the cluster is performed.
    replicationGroupDescription string
    A description of the source replication group.
    snapshotRetentionLimit number
    For an automatic snapshot, the number of days for which ElastiCache retains the snapshot before deleting it.
    snapshotSource string
    Indicates whether the snapshot is from an automatic backup (automated) or was created manually (manual).
    snapshotStatus SnapshotStatus
    The status of the snapshot. Valid values: creating | available | restoring | copying | deleting | failed | deleted.
    snapshotWindow string
    The daily time range during which ElastiCache takes daily snapshots of the source cluster.
    tags Tag[]
    A list of tags to be added to this resource.
    topicArn string
    The Amazon Resource Name (ARN) for the topic used by the source cluster for publishing notifications.
    vpcId string
    The Amazon Virtual Private Cloud identifier (VPC ID) of the cache subnet group for the source cluster.
    arn str
    The ARN (Amazon Resource Name) of the snapshot.
    auto_minor_version_upgrade bool
    If true, opt-in to the next auto minor version upgrade campaign.
    automatic_failover SnapshotAutomaticFailover
    Indicates the status of automatic failover for the source replication group.
    cache_cluster_create_time str
    The date and time when the source cluster was created.
    cache_node_type str
    The name of the compute and memory capacity node type for the source cluster.
    cache_parameter_group_name str
    The cache parameter group that is associated with the source cluster.
    cache_subnet_group_name str
    The name of the cache subnet group associated with the source cluster.
    data_tiering SnapshotDataTiering
    Enables data tiering. Data tiering is only supported for replication groups using the r6gd node type.
    engine str
    The name of the cache engine used by the source cluster.
    engine_version str
    The version of the cache engine version used by the source cluster.
    node_snapshots Sequence[SnapshotNodeSnapshot]
    A list of the cache nodes in the source cluster.
    num_cache_nodes int
    The number of cache nodes in the source cluster.
    num_node_groups int
    The number of node groups (shards) in this snapshot.
    port int
    The port number used by each cache nodes in the source cluster.
    preferred_availability_zone str
    The name of the Availability Zone in which the source cluster is located.
    preferred_maintenance_window str
    Specifies the weekly time range during which maintenance on the cluster is performed.
    replication_group_description str
    A description of the source replication group.
    snapshot_retention_limit int
    For an automatic snapshot, the number of days for which ElastiCache retains the snapshot before deleting it.
    snapshot_source str
    Indicates whether the snapshot is from an automatic backup (automated) or was created manually (manual).
    snapshot_status SnapshotStatus
    The status of the snapshot. Valid values: creating | available | restoring | copying | deleting | failed | deleted.
    snapshot_window str
    The daily time range during which ElastiCache takes daily snapshots of the source cluster.
    tags Sequence[root_Tag]
    A list of tags to be added to this resource.
    topic_arn str
    The Amazon Resource Name (ARN) for the topic used by the source cluster for publishing notifications.
    vpc_id str
    The Amazon Virtual Private Cloud identifier (VPC ID) of the cache subnet group for the source cluster.
    arn String
    The ARN (Amazon Resource Name) of the snapshot.
    autoMinorVersionUpgrade Boolean
    If true, opt-in to the next auto minor version upgrade campaign.
    automaticFailover "enabled" | "disabled" | "enabling" | "disabling"
    Indicates the status of automatic failover for the source replication group.
    cacheClusterCreateTime String
    The date and time when the source cluster was created.
    cacheNodeType String
    The name of the compute and memory capacity node type for the source cluster.
    cacheParameterGroupName String
    The cache parameter group that is associated with the source cluster.
    cacheSubnetGroupName String
    The name of the cache subnet group associated with the source cluster.
    dataTiering "enabled" | "disabled"
    Enables data tiering. Data tiering is only supported for replication groups using the r6gd node type.
    engine String
    The name of the cache engine used by the source cluster.
    engineVersion String
    The version of the cache engine version used by the source cluster.
    nodeSnapshots List<Property Map>
    A list of the cache nodes in the source cluster.
    numCacheNodes Number
    The number of cache nodes in the source cluster.
    numNodeGroups Number
    The number of node groups (shards) in this snapshot.
    port Number
    The port number used by each cache nodes in the source cluster.
    preferredAvailabilityZone String
    The name of the Availability Zone in which the source cluster is located.
    preferredMaintenanceWindow String
    Specifies the weekly time range during which maintenance on the cluster is performed.
    replicationGroupDescription String
    A description of the source replication group.
    snapshotRetentionLimit Number
    For an automatic snapshot, the number of days for which ElastiCache retains the snapshot before deleting it.
    snapshotSource String
    Indicates whether the snapshot is from an automatic backup (automated) or was created manually (manual).
    snapshotStatus "creating" | "available" | "restoring" | "copying" | "deleting" | "failed" | "deleted"
    The status of the snapshot. Valid values: creating | available | restoring | copying | deleting | failed | deleted.
    snapshotWindow String
    The daily time range during which ElastiCache takes daily snapshots of the source cluster.
    tags List<Property Map>
    A list of tags to be added to this resource.
    topicArn String
    The Amazon Resource Name (ARN) for the topic used by the source cluster for publishing notifications.
    vpcId String
    The Amazon Virtual Private Cloud identifier (VPC ID) of the cache subnet group for the source cluster.

    Supporting Types

    SnapshotAutomaticFailover

    SnapshotDataTiering

    SnapshotNodeSnapshot

    CacheClusterId string
    A unique identifier for the source cluster.
    CacheNodeCreateTime string
    The date and time when the cache node was created in the source cluster.
    CacheNodeId string
    The cache node identifier for the node in the source cluster.
    CacheSize string
    The size of the cache on the source cache node.
    NodeGroupId string
    A unique identifier for the source node group (shard).
    SnapshotCreateTime string
    The date and time when the source node's metadata and cache data set was obtained for the snapshot.
    CacheClusterId string
    A unique identifier for the source cluster.
    CacheNodeCreateTime string
    The date and time when the cache node was created in the source cluster.
    CacheNodeId string
    The cache node identifier for the node in the source cluster.
    CacheSize string
    The size of the cache on the source cache node.
    NodeGroupId string
    A unique identifier for the source node group (shard).
    SnapshotCreateTime string
    The date and time when the source node's metadata and cache data set was obtained for the snapshot.
    cache_cluster_id string
    A unique identifier for the source cluster.
    cache_node_create_time string
    The date and time when the cache node was created in the source cluster.
    cache_node_id string
    The cache node identifier for the node in the source cluster.
    cache_size string
    The size of the cache on the source cache node.
    node_group_id string
    A unique identifier for the source node group (shard).
    snapshot_create_time string
    The date and time when the source node's metadata and cache data set was obtained for the snapshot.
    cacheClusterId String
    A unique identifier for the source cluster.
    cacheNodeCreateTime String
    The date and time when the cache node was created in the source cluster.
    cacheNodeId String
    The cache node identifier for the node in the source cluster.
    cacheSize String
    The size of the cache on the source cache node.
    nodeGroupId String
    A unique identifier for the source node group (shard).
    snapshotCreateTime String
    The date and time when the source node's metadata and cache data set was obtained for the snapshot.
    cacheClusterId string
    A unique identifier for the source cluster.
    cacheNodeCreateTime string
    The date and time when the cache node was created in the source cluster.
    cacheNodeId string
    The cache node identifier for the node in the source cluster.
    cacheSize string
    The size of the cache on the source cache node.
    nodeGroupId string
    A unique identifier for the source node group (shard).
    snapshotCreateTime string
    The date and time when the source node's metadata and cache data set was obtained for the snapshot.
    cache_cluster_id str
    A unique identifier for the source cluster.
    cache_node_create_time str
    The date and time when the cache node was created in the source cluster.
    cache_node_id str
    The cache node identifier for the node in the source cluster.
    cache_size str
    The size of the cache on the source cache node.
    node_group_id str
    A unique identifier for the source node group (shard).
    snapshot_create_time str
    The date and time when the source node's metadata and cache data set was obtained for the snapshot.
    cacheClusterId String
    A unique identifier for the source cluster.
    cacheNodeCreateTime String
    The date and time when the cache node was created in the source cluster.
    cacheNodeId String
    The cache node identifier for the node in the source cluster.
    cacheSize String
    The size of the cache on the source cache node.
    nodeGroupId String
    A unique identifier for the source node group (shard).
    snapshotCreateTime String
    The date and time when the source node's metadata and cache data set was obtained for the snapshot.

    SnapshotStatus

    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 AWS Cloud Control

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

    Viewing docs for AWS Cloud Control v1.83.1
    published on Thursday, Oct 22, 2026 by Pulumi
    Schema (JSON)
    pulumi/pulumi-aws-native

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial