We recommend new projects start with resources from the AWS provider.
published on Monday, Sep 28, 2026 by Pulumi
We recommend new projects start with resources from the AWS provider.
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:
- Cluster
Name string - The name of the cluster from which the snapshot was taken.
- Kms
Key stringId - The ID of the KMS key used to encrypt the snapshot.
- Snapshot
Name string - The name of the snapshot.
-
List<Pulumi.
Aws Native. Inputs. Tag> - 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 stringId - The ID of the KMS key used to encrypt the snapshot.
- Snapshot
Name string - The name of the snapshot.
-
Tag
Args - 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_ stringid - The ID of the KMS key used to encrypt the snapshot.
- snapshot_
name string - The name of the snapshot.
- list(object)
- 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 StringId - The ID of the KMS key used to encrypt the snapshot.
- snapshot
Name String - The name of the snapshot.
- List<Tag>
- 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 stringId - The ID of the KMS key used to encrypt the snapshot.
- snapshot
Name string - The name of the snapshot.
- 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_ strid - The ID of the KMS key used to encrypt the snapshot.
- snapshot_
name str - The name of the snapshot.
-
Sequence[Tag
Args] - 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 StringId - The ID of the KMS key used to encrypt the snapshot.
- snapshot
Name String - The name of the snapshot.
- 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.
- Cluster
Configuration Pulumi.Aws Native. Memory Db. Outputs. Snapshot Cluster Configuration - The configuration of the cluster from which the snapshot was taken.
- Data
Tiering Pulumi.Aws Native. Memory Db. Snapshot Data Tiering - 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 SnapshotCluster Configuration - The configuration of the cluster from which the snapshot was taken.
- Data
Tiering SnapshotData Tiering - 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.
- cluster
Configuration SnapshotCluster Configuration - The configuration of the cluster from which the snapshot was taken.
- data
Tiering SnapshotData Tiering - 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 SnapshotCluster Configuration - The configuration of the cluster from which the snapshot was taken.
- data
Tiering SnapshotData Tiering - 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 SnapshotCluster Configuration - The configuration of the cluster from which the snapshot was taken.
- data_
tiering SnapshotData Tiering - 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.
- cluster
Configuration Property Map - 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.
Supporting Types
SnapshotClusterConfiguration, SnapshotClusterConfigurationArgs
- 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 int - The number of shards in the cluster.
- Parameter
Group stringName - The name of parameter group used by the cluster.
- Port int
- The port used by the cluster.
- Snapshot
Retention intLimit - The snapshot retention limit set by the cluster.
- Snapshot
Window string - The snapshot window set by the cluster.
- Subnet
Group stringName - 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.
- 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 int - The number of shards in the cluster.
- Parameter
Group stringName - The name of parameter group used by the cluster.
- Port int
- The port used by the cluster.
- Snapshot
Retention intLimit - The snapshot retention limit set by the cluster.
- Snapshot
Window string - The snapshot window set by the cluster.
- Subnet
Group stringName - 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.
- 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_ stringname - The name of parameter group used by the cluster.
- port number
- The port used by the cluster.
- snapshot_
retention_ numberlimit - The snapshot retention limit set by the cluster.
- snapshot_
window string - The snapshot window set by the cluster.
- subnet_
group_ stringname - 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.
- 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 Integer - The number of shards in the cluster.
- parameter
Group StringName - The name of parameter group used by the cluster.
- port Integer
- The port used by the cluster.
- snapshot
Retention IntegerLimit - The snapshot retention limit set by the cluster.
- snapshot
Window String - The snapshot window set by the cluster.
- subnet
Group StringName - 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.
- 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 stringName - The name of parameter group used by the cluster.
- port number
- The port used by the cluster.
- snapshot
Retention numberLimit - The snapshot retention limit set by the cluster.
- snapshot
Window string - The snapshot window set by the cluster.
- subnet
Group stringName - 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 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_ strname - The name of parameter group used by the cluster.
- port int
- The port used by the cluster.
- snapshot_
retention_ intlimit - The snapshot retention limit set by the cluster.
- snapshot_
window str - The snapshot window set by the cluster.
- subnet_
group_ strname - 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.
- 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 StringName - The name of parameter group used by the cluster.
- port Number
- The port used by the cluster.
- snapshot
Retention NumberLimit - The snapshot retention limit set by the cluster.
- snapshot
Window String - The snapshot window set by the cluster.
- subnet
Group StringName - 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.
SnapshotDataTiering, SnapshotDataTieringArgs
- True
true- False
false
- Snapshot
Data Tiering True true- Snapshot
Data Tiering False 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.Package Details
- Repository
- AWS Native pulumi/pulumi-aws-native
- License
- Apache-2.0
We recommend new projects start with resources from the AWS provider.
published on Monday, Sep 28, 2026 by Pulumi