Package software.amazon.awscdk.services.docdbelastic

Interface CfnClusterSnapshotProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnClusterSnapshotProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.140.0 (build 79fd58c)",
           date="2026-09-30T11:04:49.580Z")
@Stability(Stable)
public interface CfnClusterSnapshotProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnClusterSnapshot.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.docdbelastic.*;
 CfnClusterSnapshotProps cfnClusterSnapshotProps = CfnClusterSnapshotProps.builder()
         .clusterArn("clusterArn")
         .snapshotName("snapshotName")
         // the properties below are optional
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdbelastic-clustersnapshot.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnClusterSnapshotProps.Builder	A builder for CfnClusterSnapshotProps
static final class	CfnClusterSnapshotProps.Jsii$Proxy	An implementation for CfnClusterSnapshotProps

Method Summary

Modifier and Type	Method	Description
static CfnClusterSnapshotProps.Builder	builder()
String	getClusterArn()	The ARN of the elastic cluster of which to create a snapshot.
String	getSnapshotName()	The name of the elastic cluster snapshot.
default List<CfnTag>	getTags()	An array of key-value pairs to apply to the elastic cluster snapshot.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getClusterArn

@Stability(Stable)
@NotNull
String getClusterArn()

The ARN of the elastic cluster of which to create a snapshot.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdbelastic-clustersnapshot.html#cfn-docdbelastic-clustersnapshot-clusterarn

getSnapshotName

@Stability(Stable)
@NotNull
String getSnapshotName()

The name of the elastic cluster snapshot.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdbelastic-clustersnapshot.html#cfn-docdbelastic-clustersnapshot-snapshotname

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

An array of key-value pairs to apply to the elastic cluster snapshot.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdbelastic-clustersnapshot.html#cfn-docdbelastic-clustersnapshot-tags

builder

@Stability(Stable)
static CfnClusterSnapshotProps.Builder builder()

Returns:

a CfnClusterSnapshotProps.Builder of CfnClusterSnapshotProps