We recommend new projects start with resources from the AWS provider.
published on Monday, Sep 21, 2026 by Pulumi
We recommend new projects start with resources from the AWS provider.
published on Monday, Sep 21, 2026 by Pulumi
Resource Type definition for AWS::DocDBElastic::ClusterSnapshot. Creates a manual snapshot of an Amazon DocumentDB elastic cluster.
Create ClusterSnapshot Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new ClusterSnapshot(name: string, args: ClusterSnapshotArgs, opts?: CustomResourceOptions);@overload
def ClusterSnapshot(resource_name: str,
args: ClusterSnapshotArgs,
opts: Optional[ResourceOptions] = None)
@overload
def ClusterSnapshot(resource_name: str,
opts: Optional[ResourceOptions] = None,
cluster_arn: Optional[str] = None,
snapshot_name: Optional[str] = None,
tags: Optional[Sequence[_root_inputs.TagArgs]] = None)func NewClusterSnapshot(ctx *Context, name string, args ClusterSnapshotArgs, opts ...ResourceOption) (*ClusterSnapshot, error)public ClusterSnapshot(string name, ClusterSnapshotArgs args, CustomResourceOptions? opts = null)
public ClusterSnapshot(String name, ClusterSnapshotArgs args)
public ClusterSnapshot(String name, ClusterSnapshotArgs args, CustomResourceOptions options)
type: aws-native:docdbelastic:ClusterSnapshot
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
resource "aws-native_docdbelastic_cluster_snapshot" "name" {
# resource properties
}Parameters
- name string
- The unique name of the resource.
- args ClusterSnapshotArgs
- 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 ClusterSnapshotArgs
- 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 ClusterSnapshotArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args ClusterSnapshotArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args ClusterSnapshotArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
ClusterSnapshot 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 ClusterSnapshot resource accepts the following input properties:
- Cluster
Arn string - The ARN of the elastic cluster of which to create a snapshot.
- Snapshot
Name string - The name of the elastic cluster snapshot.
-
List<Pulumi.
Aws Native. Inputs. Tag> - An array of key-value pairs to apply to the elastic cluster snapshot.
- Cluster
Arn string - The ARN of the elastic cluster of which to create a snapshot.
- Snapshot
Name string - The name of the elastic cluster snapshot.
-
Tag
Args - An array of key-value pairs to apply to the elastic cluster snapshot.
- cluster_
arn string - The ARN of the elastic cluster of which to create a snapshot.
- snapshot_
name string - The name of the elastic cluster snapshot.
- list(object)
- An array of key-value pairs to apply to the elastic cluster snapshot.
- cluster
Arn String - The ARN of the elastic cluster of which to create a snapshot.
- snapshot
Name String - The name of the elastic cluster snapshot.
- List<Tag>
- An array of key-value pairs to apply to the elastic cluster snapshot.
- cluster
Arn string - The ARN of the elastic cluster of which to create a snapshot.
- snapshot
Name string - The name of the elastic cluster snapshot.
- Tag[]
- An array of key-value pairs to apply to the elastic cluster snapshot.
- cluster_
arn str - The ARN of the elastic cluster of which to create a snapshot.
- snapshot_
name str - The name of the elastic cluster snapshot.
-
Sequence[Tag
Args] - An array of key-value pairs to apply to the elastic cluster snapshot.
- cluster
Arn String - The ARN of the elastic cluster of which to create a snapshot.
- snapshot
Name String - The name of the elastic cluster snapshot.
- List<Property Map>
- An array of key-value pairs to apply to the elastic cluster snapshot.
Outputs
All input properties are implicitly available as output properties. Additionally, the ClusterSnapshot resource produces the following output properties:
- Admin
User stringName - The name of the elastic cluster administrator.
- Cluster
Creation stringTime - The time when the source elastic cluster was created, in Universal Coordinated Time (UTC).
- Id string
- The provider-assigned unique ID for this managed resource.
- Kms
Key stringId - The KMS key identifier used to encrypt the source elastic cluster.
- Snapshot
Arn string - The Amazon Resource Name (ARN) of the elastic cluster snapshot.
- Snapshot
Creation stringTime - The time when the elastic cluster snapshot was created, in Universal Coordinated Time (UTC).
- Snapshot
Type Pulumi.Aws Native. Doc Db Elastic. Cluster Snapshot Snapshot Type - The type of the elastic cluster snapshot (manual or automated).
- Status string
- The status of the elastic cluster snapshot.
- Subnet
Ids List<string> - The Amazon EC2 subnet IDs associated with the source elastic cluster.
- Vpc
Security List<string>Group Ids - The Amazon EC2 security group IDs associated with the source elastic cluster.
- Admin
User stringName - The name of the elastic cluster administrator.
- Cluster
Creation stringTime - The time when the source elastic cluster was created, in Universal Coordinated Time (UTC).
- Id string
- The provider-assigned unique ID for this managed resource.
- Kms
Key stringId - The KMS key identifier used to encrypt the source elastic cluster.
- Snapshot
Arn string - The Amazon Resource Name (ARN) of the elastic cluster snapshot.
- Snapshot
Creation stringTime - The time when the elastic cluster snapshot was created, in Universal Coordinated Time (UTC).
- Snapshot
Type ClusterSnapshot Snapshot Type - The type of the elastic cluster snapshot (manual or automated).
- Status string
- The status of the elastic cluster snapshot.
- Subnet
Ids []string - The Amazon EC2 subnet IDs associated with the source elastic cluster.
- Vpc
Security []stringGroup Ids - The Amazon EC2 security group IDs associated with the source elastic cluster.
- admin_
user_ stringname - The name of the elastic cluster administrator.
- cluster_
creation_ stringtime - The time when the source elastic cluster was created, in Universal Coordinated Time (UTC).
- id string
- The provider-assigned unique ID for this managed resource.
- kms_
key_ stringid - The KMS key identifier used to encrypt the source elastic cluster.
- snapshot_
arn string - The Amazon Resource Name (ARN) of the elastic cluster snapshot.
- snapshot_
creation_ stringtime - The time when the elastic cluster snapshot was created, in Universal Coordinated Time (UTC).
- snapshot_
type "MANUAL" | "AUTOMATED" - The type of the elastic cluster snapshot (manual or automated).
- status string
- The status of the elastic cluster snapshot.
- subnet_
ids list(string) - The Amazon EC2 subnet IDs associated with the source elastic cluster.
- vpc_
security_ list(string)group_ ids - The Amazon EC2 security group IDs associated with the source elastic cluster.
- admin
User StringName - The name of the elastic cluster administrator.
- cluster
Creation StringTime - The time when the source elastic cluster was created, in Universal Coordinated Time (UTC).
- id String
- The provider-assigned unique ID for this managed resource.
- kms
Key StringId - The KMS key identifier used to encrypt the source elastic cluster.
- snapshot
Arn String - The Amazon Resource Name (ARN) of the elastic cluster snapshot.
- snapshot
Creation StringTime - The time when the elastic cluster snapshot was created, in Universal Coordinated Time (UTC).
- snapshot
Type ClusterSnapshot Snapshot Type - The type of the elastic cluster snapshot (manual or automated).
- status String
- The status of the elastic cluster snapshot.
- subnet
Ids List<String> - The Amazon EC2 subnet IDs associated with the source elastic cluster.
- vpc
Security List<String>Group Ids - The Amazon EC2 security group IDs associated with the source elastic cluster.
- admin
User stringName - The name of the elastic cluster administrator.
- cluster
Creation stringTime - The time when the source elastic cluster was created, in Universal Coordinated Time (UTC).
- id string
- The provider-assigned unique ID for this managed resource.
- kms
Key stringId - The KMS key identifier used to encrypt the source elastic cluster.
- snapshot
Arn string - The Amazon Resource Name (ARN) of the elastic cluster snapshot.
- snapshot
Creation stringTime - The time when the elastic cluster snapshot was created, in Universal Coordinated Time (UTC).
- snapshot
Type ClusterSnapshot Snapshot Type - The type of the elastic cluster snapshot (manual or automated).
- status string
- The status of the elastic cluster snapshot.
- subnet
Ids string[] - The Amazon EC2 subnet IDs associated with the source elastic cluster.
- vpc
Security string[]Group Ids - The Amazon EC2 security group IDs associated with the source elastic cluster.
- admin_
user_ strname - The name of the elastic cluster administrator.
- cluster_
creation_ strtime - The time when the source elastic cluster was created, in Universal Coordinated Time (UTC).
- id str
- The provider-assigned unique ID for this managed resource.
- kms_
key_ strid - The KMS key identifier used to encrypt the source elastic cluster.
- snapshot_
arn str - The Amazon Resource Name (ARN) of the elastic cluster snapshot.
- snapshot_
creation_ strtime - The time when the elastic cluster snapshot was created, in Universal Coordinated Time (UTC).
- snapshot_
type ClusterSnapshot Snapshot Type - The type of the elastic cluster snapshot (manual or automated).
- status str
- The status of the elastic cluster snapshot.
- subnet_
ids Sequence[str] - The Amazon EC2 subnet IDs associated with the source elastic cluster.
- vpc_
security_ Sequence[str]group_ ids - The Amazon EC2 security group IDs associated with the source elastic cluster.
- admin
User StringName - The name of the elastic cluster administrator.
- cluster
Creation StringTime - The time when the source elastic cluster was created, in Universal Coordinated Time (UTC).
- id String
- The provider-assigned unique ID for this managed resource.
- kms
Key StringId - The KMS key identifier used to encrypt the source elastic cluster.
- snapshot
Arn String - The Amazon Resource Name (ARN) of the elastic cluster snapshot.
- snapshot
Creation StringTime - The time when the elastic cluster snapshot was created, in Universal Coordinated Time (UTC).
- snapshot
Type "MANUAL" | "AUTOMATED" - The type of the elastic cluster snapshot (manual or automated).
- status String
- The status of the elastic cluster snapshot.
- subnet
Ids List<String> - The Amazon EC2 subnet IDs associated with the source elastic cluster.
- vpc
Security List<String>Group Ids - The Amazon EC2 security group IDs associated with the source elastic cluster.
Supporting Types
ClusterSnapshotSnapshotType, ClusterSnapshotSnapshotTypeArgs
- Manual
MANUAL- Automated
AUTOMATED
- Cluster
Snapshot Snapshot Type Manual MANUAL- Cluster
Snapshot Snapshot Type Automated AUTOMATED
- "MANUAL"
MANUAL- "AUTOMATED"
AUTOMATED
- Manual
MANUAL- Automated
AUTOMATED
- Manual
MANUAL- Automated
AUTOMATED
- MANUAL
MANUAL- AUTOMATED
AUTOMATED
- "MANUAL"
MANUAL- "AUTOMATED"
AUTOMATED
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 21, 2026 by Pulumi