1. Packages
  2. AWS Classic
  3. API Docs
  4. memorydb
  5. getSnapshot

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.45.0 published on Tuesday, Jul 16, 2024 by Pulumi

aws.memorydb.getSnapshot

Explore with Pulumi AI

aws logo

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.45.0 published on Tuesday, Jul 16, 2024 by Pulumi

    Provides information about a MemoryDB Snapshot.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as aws from "@pulumi/aws";
    
    const example = aws.memorydb.getSnapshot({
        name: "my-snapshot",
    });
    
    import pulumi
    import pulumi_aws as aws
    
    example = aws.memorydb.get_snapshot(name="my-snapshot")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/memorydb"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := memorydb.LookupSnapshot(ctx, &memorydb.LookupSnapshotArgs{
    			Name: "my-snapshot",
    		}, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Aws = Pulumi.Aws;
    
    return await Deployment.RunAsync(() => 
    {
        var example = Aws.MemoryDb.GetSnapshot.Invoke(new()
        {
            Name = "my-snapshot",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.aws.memorydb.MemorydbFunctions;
    import com.pulumi.aws.memorydb.inputs.GetSnapshotArgs;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            final var example = MemorydbFunctions.getSnapshot(GetSnapshotArgs.builder()
                .name("my-snapshot")
                .build());
    
        }
    }
    
    variables:
      example:
        fn::invoke:
          Function: aws:memorydb:getSnapshot
          Arguments:
            name: my-snapshot
    

    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?: InvokeOptions): Output<GetSnapshotResult>
    def get_snapshot(name: Optional[str] = None,
                     tags: Optional[Mapping[str, str]] = None,
                     opts: Optional[InvokeOptions] = None) -> GetSnapshotResult
    def get_snapshot_output(name: Optional[pulumi.Input[str]] = None,
                     tags: Optional[pulumi.Input[Mapping[str, pulumi.Input[str]]]] = None,
                     opts: Optional[InvokeOptions] = 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 CompletableFuture<GetSnapshotResult> getSnapshot(GetSnapshotArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: aws:memorydb/getSnapshot:getSnapshot
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Name string
    Name of the snapshot.
    Tags Dictionary<string, string>
    Map of tags assigned to the snapshot.
    Name string
    Name of the snapshot.
    Tags map[string]string
    Map of tags assigned to the snapshot.
    name String
    Name of the snapshot.
    tags Map<String,String>
    Map of tags assigned to the snapshot.
    name string
    Name of the snapshot.
    tags {[key: string]: string}
    Map of tags assigned to the snapshot.
    name str
    Name of the snapshot.
    tags Mapping[str, str]
    Map of tags assigned to the snapshot.
    name String
    Name of the snapshot.
    tags Map<String>
    Map of tags assigned to the snapshot.

    getSnapshot Result

    The following output properties are available:

    Arn string
    ARN of the snapshot.
    ClusterConfigurations List<GetSnapshotClusterConfiguration>
    The configuration of the cluster from which the snapshot was taken.
    ClusterName string
    Name of the MemoryDB cluster that this snapshot was taken from.
    Id string
    The provider-assigned unique ID for this managed resource.
    KmsKeyArn string
    ARN of the KMS key used to encrypt the snapshot at rest.
    Name string
    Name of the cluster.
    Source string
    Whether the snapshot is from an automatic backup (automated) or was created manually (manual).
    Tags Dictionary<string, string>
    Map of tags assigned to the snapshot.
    Arn string
    ARN of the snapshot.
    ClusterConfigurations []GetSnapshotClusterConfiguration
    The configuration of the cluster from which the snapshot was taken.
    ClusterName string
    Name of the MemoryDB cluster that this snapshot was taken from.
    Id string
    The provider-assigned unique ID for this managed resource.
    KmsKeyArn string
    ARN of the KMS key used to encrypt the snapshot at rest.
    Name string
    Name of the cluster.
    Source string
    Whether the snapshot is from an automatic backup (automated) or was created manually (manual).
    Tags map[string]string
    Map of tags assigned to the snapshot.
    arn String
    ARN of the snapshot.
    clusterConfigurations List<GetSnapshotClusterConfiguration>
    The configuration of the cluster from which the snapshot was taken.
    clusterName String
    Name of the MemoryDB cluster that this snapshot was taken from.
    id String
    The provider-assigned unique ID for this managed resource.
    kmsKeyArn String
    ARN of the KMS key used to encrypt the snapshot at rest.
    name String
    Name of the cluster.
    source String
    Whether the snapshot is from an automatic backup (automated) or was created manually (manual).
    tags Map<String,String>
    Map of tags assigned to the snapshot.
    arn string
    ARN of the snapshot.
    clusterConfigurations GetSnapshotClusterConfiguration[]
    The configuration of the cluster from which the snapshot was taken.
    clusterName string
    Name of the MemoryDB cluster that this snapshot was taken from.
    id string
    The provider-assigned unique ID for this managed resource.
    kmsKeyArn string
    ARN of the KMS key used to encrypt the snapshot at rest.
    name string
    Name of the cluster.
    source string
    Whether the snapshot is from an automatic backup (automated) or was created manually (manual).
    tags {[key: string]: string}
    Map of tags assigned to the snapshot.
    arn str
    ARN of the snapshot.
    cluster_configurations Sequence[GetSnapshotClusterConfiguration]
    The configuration of the cluster from which the snapshot was taken.
    cluster_name str
    Name of the MemoryDB cluster that this snapshot was taken from.
    id str
    The provider-assigned unique ID for this managed resource.
    kms_key_arn str
    ARN of the KMS key used to encrypt the snapshot at rest.
    name str
    Name of the cluster.
    source str
    Whether the snapshot is from an automatic backup (automated) or was created manually (manual).
    tags Mapping[str, str]
    Map of tags assigned to the snapshot.
    arn String
    ARN of the snapshot.
    clusterConfigurations List<Property Map>
    The configuration of the cluster from which the snapshot was taken.
    clusterName String
    Name of the MemoryDB cluster that this snapshot was taken from.
    id String
    The provider-assigned unique ID for this managed resource.
    kmsKeyArn String
    ARN of the KMS key used to encrypt the snapshot at rest.
    name String
    Name of the cluster.
    source String
    Whether the snapshot is from an automatic backup (automated) or was created manually (manual).
    tags Map<String>
    Map of tags assigned to the snapshot.

    Supporting Types

    GetSnapshotClusterConfiguration

    Description string
    Description for the cluster.
    EngineVersion string
    Version number of the Redis engine used by the cluster.
    MaintenanceWindow string
    The weekly time range during which maintenance on the cluster is performed.
    Name string
    Name of the snapshot.
    NodeType string
    Compute and memory capacity of the nodes in the cluster.
    NumShards int
    Number of shards in the cluster.
    ParameterGroupName string
    Name of the parameter group associated with the cluster.
    Port int
    Port number on which the cluster accepts connections.
    SnapshotRetentionLimit int
    Number of days for which MemoryDB retains automatic snapshots before deleting them.
    SnapshotWindow string
    The daily time range (in UTC) during which MemoryDB begins taking a daily snapshot of the shard.
    SubnetGroupName string
    Name of the subnet group used by the cluster.
    TopicArn string
    ARN of the SNS topic to which cluster notifications are sent.
    VpcId string
    The VPC in which the cluster exists.
    Description string
    Description for the cluster.
    EngineVersion string
    Version number of the Redis engine used by the cluster.
    MaintenanceWindow string
    The weekly time range during which maintenance on the cluster is performed.
    Name string
    Name of the snapshot.
    NodeType string
    Compute and memory capacity of the nodes in the cluster.
    NumShards int
    Number of shards in the cluster.
    ParameterGroupName string
    Name of the parameter group associated with the cluster.
    Port int
    Port number on which the cluster accepts connections.
    SnapshotRetentionLimit int
    Number of days for which MemoryDB retains automatic snapshots before deleting them.
    SnapshotWindow string
    The daily time range (in UTC) during which MemoryDB begins taking a daily snapshot of the shard.
    SubnetGroupName string
    Name of the subnet group used by the cluster.
    TopicArn string
    ARN of the SNS topic to which cluster notifications are sent.
    VpcId string
    The VPC in which the cluster exists.
    description String
    Description for the cluster.
    engineVersion String
    Version number of the Redis engine used by the cluster.
    maintenanceWindow String
    The weekly time range during which maintenance on the cluster is performed.
    name String
    Name of the snapshot.
    nodeType String
    Compute and memory capacity of the nodes in the cluster.
    numShards Integer
    Number of shards in the cluster.
    parameterGroupName String
    Name of the parameter group associated with the cluster.
    port Integer
    Port number on which the cluster accepts connections.
    snapshotRetentionLimit Integer
    Number of days for which MemoryDB retains automatic snapshots before deleting them.
    snapshotWindow String
    The daily time range (in UTC) during which MemoryDB begins taking a daily snapshot of the shard.
    subnetGroupName String
    Name of the subnet group used by the cluster.
    topicArn String
    ARN of the SNS topic to which cluster notifications are sent.
    vpcId String
    The VPC in which the cluster exists.
    description string
    Description for the cluster.
    engineVersion string
    Version number of the Redis engine used by the cluster.
    maintenanceWindow string
    The weekly time range during which maintenance on the cluster is performed.
    name string
    Name of the snapshot.
    nodeType string
    Compute and memory capacity of the nodes in the cluster.
    numShards number
    Number of shards in the cluster.
    parameterGroupName string
    Name of the parameter group associated with the cluster.
    port number
    Port number on which the cluster accepts connections.
    snapshotRetentionLimit number
    Number of days for which MemoryDB retains automatic snapshots before deleting them.
    snapshotWindow string
    The daily time range (in UTC) during which MemoryDB begins taking a daily snapshot of the shard.
    subnetGroupName string
    Name of the subnet group used by the cluster.
    topicArn string
    ARN of the SNS topic to which cluster notifications are sent.
    vpcId string
    The VPC in which the cluster exists.
    description str
    Description for the cluster.
    engine_version str
    Version number of the Redis engine used by the cluster.
    maintenance_window str
    The weekly time range during which maintenance on the cluster is performed.
    name str
    Name of the snapshot.
    node_type str
    Compute and memory capacity of the nodes in the cluster.
    num_shards int
    Number of shards in the cluster.
    parameter_group_name str
    Name of the parameter group associated with the cluster.
    port int
    Port number on which the cluster accepts connections.
    snapshot_retention_limit int
    Number of days for which MemoryDB retains automatic snapshots before deleting them.
    snapshot_window str
    The daily time range (in UTC) during which MemoryDB begins taking a daily snapshot of the shard.
    subnet_group_name str
    Name of the subnet group used by the cluster.
    topic_arn str
    ARN of the SNS topic to which cluster notifications are sent.
    vpc_id str
    The VPC in which the cluster exists.
    description String
    Description for the cluster.
    engineVersion String
    Version number of the Redis engine used by the cluster.
    maintenanceWindow String
    The weekly time range during which maintenance on the cluster is performed.
    name String
    Name of the snapshot.
    nodeType String
    Compute and memory capacity of the nodes in the cluster.
    numShards Number
    Number of shards in the cluster.
    parameterGroupName String
    Name of the parameter group associated with the cluster.
    port Number
    Port number on which the cluster accepts connections.
    snapshotRetentionLimit Number
    Number of days for which MemoryDB retains automatic snapshots before deleting them.
    snapshotWindow String
    The daily time range (in UTC) during which MemoryDB begins taking a daily snapshot of the shard.
    subnetGroupName String
    Name of the subnet group used by the cluster.
    topicArn String
    ARN of the SNS topic to which cluster notifications are sent.
    vpcId String
    The VPC in which the cluster exists.

    Package Details

    Repository
    AWS Classic pulumi/pulumi-aws
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the aws Terraform Provider.
    aws logo

    Try AWS Native preview for resources not in the classic version.

    AWS Classic v6.45.0 published on Tuesday, Jul 16, 2024 by Pulumi