1. Registry
  2. Packages
  3. AWS Cloud Control
  4. API Docs
  5. memorydb
  6. Snapshot

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
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

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

    Create Snapshot Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Snapshot(name: string, args: SnapshotArgs, opts?: CustomResourceOptions);
    @overload
    def Snapshot(resource_name: str,
                 args: SnapshotArgs,
                 opts: Optional[ResourceOptions] = None)
    
    @overload
    def Snapshot(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 cluster_name: Optional[str] = None,
                 kms_key_id: Optional[str] = None,
                 snapshot_name: Optional[str] = None,
                 tags: Optional[Sequence[_root_inputs.TagArgs]] = None)
    func NewSnapshot(ctx *Context, name string, args SnapshotArgs, opts ...ResourceOption) (*Snapshot, error)
    public Snapshot(string name, SnapshotArgs args, CustomResourceOptions? opts = null)
    public Snapshot(String name, SnapshotArgs args)
    public Snapshot(String name, SnapshotArgs args, CustomResourceOptions options)
    
    type: aws-native:memorydb:Snapshot
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    resource "aws-native_memorydb_snapshot" "name" {
        # resource properties
    }

    Parameters

    name string
    The unique name of the resource.
    args SnapshotArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args SnapshotArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args SnapshotArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args SnapshotArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args SnapshotArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Snapshot Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The Snapshot resource accepts the following input properties:

    ClusterName string
    The name of the cluster from which the snapshot was taken.
    KmsKeyId string
    The ID of the KMS key used to encrypt the snapshot.
    SnapshotName string
    The name of the snapshot.
    Tags List<Pulumi.AwsNative.Inputs.Tag>
    A list of tags to be added to this resource.
    ClusterName string
    The name of the cluster from which the snapshot was taken.
    KmsKeyId string
    The ID of the KMS key used to encrypt the snapshot.
    SnapshotName string
    The name of the snapshot.
    Tags TagArgs
    A list of tags to be added to this resource.
    cluster_name string
    The name of the cluster from which the snapshot was taken.
    kms_key_id string
    The ID of the KMS key used to encrypt the snapshot.
    snapshot_name string
    The name of the snapshot.
    tags list(object)
    A list of tags to be added to this resource.
    clusterName String
    The name of the cluster from which the snapshot was taken.
    kmsKeyId String
    The ID of the KMS key used to encrypt the snapshot.
    snapshotName String
    The name of the snapshot.
    tags List<Tag>
    A list of tags to be added to this resource.
    clusterName string
    The name of the cluster from which the snapshot was taken.
    kmsKeyId string
    The ID of the KMS key used to encrypt the snapshot.
    snapshotName string
    The name of the snapshot.
    tags Tag[]
    A list of tags to be added to this resource.
    cluster_name str
    The name of the cluster from which the snapshot was taken.
    kms_key_id str
    The ID of the KMS key used to encrypt the snapshot.
    snapshot_name str
    The name of the snapshot.
    tags Sequence[TagArgs]
    A list of tags to be added to this resource.
    clusterName String
    The name of the cluster from which the snapshot was taken.
    kmsKeyId String
    The ID of the KMS key used to encrypt the snapshot.
    snapshotName String
    The name of the snapshot.
    tags List<Property Map>
    A list of tags to be added to this resource.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Snapshot resource produces the following output properties:

    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.
    Id string
    The provider-assigned unique ID for this managed resource.
    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.
    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.
    Id string
    The provider-assigned unique ID for this managed resource.
    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.
    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.
    id string
    The provider-assigned unique ID for this managed resource.
    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.
    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.
    id String
    The provider-assigned unique ID for this managed resource.
    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.
    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.
    id string
    The provider-assigned unique ID for this managed resource.
    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.
    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.
    id str
    The provider-assigned unique ID for this managed resource.
    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.
    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.
    id String
    The provider-assigned unique ID for this managed resource.
    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.

    Supporting Types

    SnapshotClusterConfiguration, SnapshotClusterConfigurationArgs

    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, SnapshotDataTieringArgs

    True
    true
    False
    false
    SnapshotDataTieringTrue
    true
    SnapshotDataTieringFalse
    false
    "true"
    true
    "false"
    false
    True
    true
    False
    false
    True
    true
    False
    false
    TRUE
    true
    FALSE
    false
    "true"
    true
    "false"
    false

    Tag, TagArgs

    A set of tags to apply to the resource.
    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

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial