Package software.amazon.awscdk.services.rds

Class CfnClusterSnapshot

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.rds.CfnClusterSnapshot

All Implemented Interfaces:

IInspectable, IEnvironmentAware, IClusterSnapshotRef, ITaggableV2, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.139.0 (build 26a6b54)",
           date="2026-09-02T11:03:17.178Z")
@Stability(Stable)
public class CfnClusterSnapshot
extends CfnResource
implements IInspectable, IClusterSnapshotRef, ITaggableV2

Creates a snapshot of a DB cluster.

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.rds.*;
 CfnClusterSnapshot cfnClusterSnapshot = CfnClusterSnapshot.Builder.create(this, "MyCfnClusterSnapshot")
         .dbClusterIdentifier("dbClusterIdentifier")
         .dbClusterSnapshotIdentifier("dbClusterSnapshotIdentifier")
         // 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-rds-clustersnapshot.html

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	CfnClusterSnapshot.Builder	A fluent builder for CfnClusterSnapshot.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.interfaces.rds.IClusterSnapshotRef

IClusterSnapshotRef.Jsii$Default, IClusterSnapshotRef.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.ITaggableV2

ITaggableV2.Jsii$Default, ITaggableV2.Jsii$Proxy

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CfnClusterSnapshot(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnClusterSnapshot(software.amazon.jsii.JsiiObjectRef objRef)
	CfnClusterSnapshot(software.constructs.Construct scope, String id, CfnClusterSnapshotProps props)	Create a new AWS::RDS::ClusterSnapshot.

Method Summary

Modifier and Type	Method	Description
Number	getAttrAllocatedStorage()	The allocated storage size of the DB cluster snapshot in gibibytes (GiB).
List<String>	getAttrAvailabilityZones()	The list of Availability Zones where instances in the DB cluster snapshot can be restored.
String	getAttrClusterCreateTime()	The time when the DB cluster was created, in Universal Coordinated Time (UTC).
String	getAttrDbClusterResourceId()	The resource ID of the DB cluster that this DB cluster snapshot was created from.
String	getAttrDbClusterSnapshotArn()	The Amazon Resource Name (ARN) for the DB cluster snapshot.
String	getAttrEngine()	The name of the database engine for this DB cluster snapshot.
String	getAttrEngineMode()	The engine mode of the database engine for this DB cluster snapshot.
String	getAttrEngineVersion()	The version of the database engine for this DB cluster snapshot.
IResolvable	getAttrIamDatabaseAuthenticationEnabled()	Indicates whether mapping of AWS IAM accounts to database accounts is enabled.
String	getAttrKmsKeyId()	If StorageEncrypted is true, the AWS KMS key identifier for the encrypted DB cluster snapshot.
String	getAttrLicenseModel()	The license model information for this DB cluster snapshot.
String	getAttrMasterUsername()	The master username for this DB cluster snapshot.
Number	getAttrPort()	The port that the DB cluster was listening on at the time of the snapshot.
String	getAttrSnapshotCreateTime()	The time when the snapshot was taken, in Universal Coordinated Time (UTC).
String	getAttrSnapshotType()	The type of the DB cluster snapshot.
String	getAttrStatus()	The status of this DB cluster snapshot.
IResolvable	getAttrStorageEncrypted()	Indicates whether the DB cluster snapshot is encrypted.
String	getAttrVpcId()	The VPC ID associated with the DB cluster snapshot.
TagManager	getCdkTagManager()	Tag Manager which manages the tags for this resource.
protected Map<String,Object>	getCfnProperties()
protected Map<String,String>	getCfnPropertyNames()
ClusterSnapshotReference	getClusterSnapshotRef()	A reference to a ClusterSnapshot resource.
String	getDbClusterIdentifier()	The identifier of the DB cluster to create a snapshot for.
String	getDbClusterSnapshotIdentifier()	The identifier for the DB cluster snapshot.
List<CfnTag>	getTags()	The tags to be assigned to the DB cluster snapshot.
void	inspect(TreeInspector inspector)	Examines the CloudFormation resource and discloses attributes.
static Boolean	isCfnClusterSnapshot(Object x)	Checks whether the given object is a CfnClusterSnapshot.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setDbClusterIdentifier(String value)	The identifier of the DB cluster to create a snapshot for.
void	setDbClusterSnapshotIdentifier(String value)	The identifier for the DB cluster snapshot.
void	setTags(List<CfnTag> value)	The tags to be assigned to the DB cluster snapshot.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, addResourceDependency, addResourceDependency, applyCrossStackReferenceStrength, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, cfnPropertyName, getAtt, getAtt, getCfnOptions, getCfnResourceType, getEnv, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, removeDependency, removeResourceDependency, replaceDependency, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId, with

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.constructs.IConstruct

getNode, with

Methods inherited from interface software.amazon.awscdk.interfaces.IEnvironmentAware

getEnv

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Details

CFN_RESOURCE_TYPE_NAME

@Stability(Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Details

CfnClusterSnapshot

protected CfnClusterSnapshot(software.amazon.jsii.JsiiObjectRef objRef)

CfnClusterSnapshot

protected CfnClusterSnapshot(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnClusterSnapshot

@Stability(Stable)
public CfnClusterSnapshot(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 CfnClusterSnapshotProps props)

Create a new AWS::RDS::ClusterSnapshot.

Parameters:

scope - Scope in which this resource is defined. This parameter is required.

id - Construct identifier for this resource (unique in its scope). This parameter is required.

props - Resource properties. This parameter is required.

Method Details

isCfnClusterSnapshot

@Stability(Stable)
@NotNull
public static Boolean isCfnClusterSnapshot(@NotNull
 Object x)

Checks whether the given object is a CfnClusterSnapshot.

Parameters:

x - This parameter is required.

inspect

@Stability(Stable)
public void inspect(@NotNull
 TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(Stable)
@NotNull
protected Map<String,Object> renderProperties(@NotNull
 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrAllocatedStorage

@Stability(Stable)
@NotNull
public Number getAttrAllocatedStorage()

The allocated storage size of the DB cluster snapshot in gibibytes (GiB).

getAttrAvailabilityZones

@Stability(Stable)
@NotNull
public List<String> getAttrAvailabilityZones()

The list of Availability Zones where instances in the DB cluster snapshot can be restored.

getAttrClusterCreateTime

@Stability(Stable)
@NotNull
public String getAttrClusterCreateTime()

The time when the DB cluster was created, in Universal Coordinated Time (UTC).

getAttrDbClusterResourceId

@Stability(Stable)
@NotNull
public String getAttrDbClusterResourceId()

The resource ID of the DB cluster that this DB cluster snapshot was created from.

getAttrDbClusterSnapshotArn

@Stability(Stable)
@NotNull
public String getAttrDbClusterSnapshotArn()

The Amazon Resource Name (ARN) for the DB cluster snapshot.

getAttrEngine

@Stability(Stable)
@NotNull
public String getAttrEngine()

The name of the database engine for this DB cluster snapshot.

getAttrEngineMode

@Stability(Stable)
@NotNull
public String getAttrEngineMode()

The engine mode of the database engine for this DB cluster snapshot.

getAttrEngineVersion

@Stability(Stable)
@NotNull
public String getAttrEngineVersion()

The version of the database engine for this DB cluster snapshot.

getAttrIamDatabaseAuthenticationEnabled

@Stability(Stable)
@NotNull
public IResolvable getAttrIamDatabaseAuthenticationEnabled()

Indicates whether mapping of AWS IAM accounts to database accounts is enabled.

getAttrKmsKeyId

@Stability(Stable)
@NotNull
public String getAttrKmsKeyId()

If StorageEncrypted is true, the AWS KMS key identifier for the encrypted DB cluster snapshot.

getAttrLicenseModel

@Stability(Stable)
@NotNull
public String getAttrLicenseModel()

The license model information for this DB cluster snapshot.

getAttrMasterUsername

@Stability(Stable)
@NotNull
public String getAttrMasterUsername()

The master username for this DB cluster snapshot.

getAttrPort

@Stability(Stable)
@NotNull
public Number getAttrPort()

The port that the DB cluster was listening on at the time of the snapshot.

getAttrSnapshotCreateTime

@Stability(Stable)
@NotNull
public String getAttrSnapshotCreateTime()

The time when the snapshot was taken, in Universal Coordinated Time (UTC).

getAttrSnapshotType

@Stability(Stable)
@NotNull
public String getAttrSnapshotType()

The type of the DB cluster snapshot.

getAttrStatus

@Stability(Stable)
@NotNull
public String getAttrStatus()

The status of this DB cluster snapshot.

getAttrStorageEncrypted

@Stability(Stable)
@NotNull
public IResolvable getAttrStorageEncrypted()

Indicates whether the DB cluster snapshot is encrypted.

getAttrVpcId

@Stability(Stable)
@NotNull
public String getAttrVpcId()

The VPC ID associated with the DB cluster snapshot.

getCdkTagManager

@Stability(Stable)
@NotNull
public TagManager getCdkTagManager()

Tag Manager which manages the tags for this resource.

Specified by:

getCdkTagManager in interface ITaggableV2

getCfnProperties

@Stability(Stable)
@NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getCfnPropertyNames

@Stability(Stable)
@NotNull
protected Map<String,String> getCfnPropertyNames()

Overrides:

getCfnPropertyNames in class CfnResource

getClusterSnapshotRef

@Stability(Stable)
@NotNull
public ClusterSnapshotReference getClusterSnapshotRef()

A reference to a ClusterSnapshot resource.

Specified by:

getClusterSnapshotRef in interface IClusterSnapshotRef

getDbClusterIdentifier

@Stability(Stable)
@NotNull
public String getDbClusterIdentifier()

The identifier of the DB cluster to create a snapshot for.

setDbClusterIdentifier

@Stability(Stable)
public void setDbClusterIdentifier(@NotNull
 String value)

The identifier of the DB cluster to create a snapshot for.

getDbClusterSnapshotIdentifier

@Stability(Stable)
@NotNull
public String getDbClusterSnapshotIdentifier()

The identifier for the DB cluster snapshot.

setDbClusterSnapshotIdentifier

@Stability(Stable)
public void setDbClusterSnapshotIdentifier(@NotNull
 String value)

The identifier for the DB cluster snapshot.

getTags

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

The tags to be assigned to the DB cluster snapshot.

setTags

@Stability(Stable)
public void setTags(@Nullable
 List<CfnTag> value)

The tags to be assigned to the DB cluster snapshot.