Package software.amazon.awscdk.services.redshiftserverless

Class CfnSnapshot

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.redshiftserverless.CfnSnapshot

All Implemented Interfaces:

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

@Generated(value="jsii-pacmak/1.112.0 (build de1bc80)",
           date="2025-07-16T11:43:21.683Z")
@Stability(Stable)
public class CfnSnapshot
extends CfnResource
implements IInspectable, ITaggableV2

A snapshot object that contains databases.

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.redshiftserverless.*;
 CfnSnapshot cfnSnapshot = CfnSnapshot.Builder.create(this, "MyCfnSnapshot")
         .snapshotName("snapshotName")
         // the properties below are optional
         .namespaceName("namespaceName")
         .retentionPeriod(123)
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshiftserverless-snapshot.html

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	CfnSnapshot.Builder	A fluent builder for CfnSnapshot.
static interface	CfnSnapshot.SnapshotProperty	A snapshot object that contains databases.

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

software.amazon.jsii.JsiiObject.InitializationMode

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	CfnSnapshot(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnSnapshot(software.amazon.jsii.JsiiObjectRef objRef)
	CfnSnapshot(software.constructs.Construct scope, String id, CfnSnapshotProps props)

Method Summary

Modifier and Type	Method	Description
String	getAttrOwnerAccount()	The owner AWS ;
IResolvable	getAttrSnapshot()
String	getAttrSnapshotAdminUsername()	The username of the database within a snapshot.
String	getAttrSnapshotKmsKeyId()	The unique identifier of the KMS key used to encrypt the snapshot.
String	getAttrSnapshotNamespaceArn()	The Amazon Resource Name (ARN) of the namespace the snapshot was created from.
String	getAttrSnapshotNamespaceName()	The name of the namepsace.
String	getAttrSnapshotOwnerAccount()	The owner AWS ;
Number	getAttrSnapshotRetentionPeriod()	The retention period of the snapshot created by the scheduled action.
String	getAttrSnapshotSnapshotArn()	The Amazon Resource Name (ARN) of the snapshot.
String	getAttrSnapshotSnapshotCreateTime()	The timestamp of when the snapshot was created.
String	getAttrSnapshotSnapshotName()	The name of the snapshot.
String	getAttrSnapshotStatus()	The status of the snapshot.
TagManager	getCdkTagManager()	Tag Manager which manages the tags for this resource.
protected Map<String,Object>	getCfnProperties()
String	getNamespaceName()	The name of the namepsace.
Number	getRetentionPeriod()	The retention period of the snapshot created by the scheduled action.
String	getSnapshotName()	The name of the snapshot.
List<CfnTag>	getTags()	An array of Tag objects to associate with the snapshot.
void	inspect(TreeInspector inspector)	Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setNamespaceName(String value)	The name of the namepsace.
void	setRetentionPeriod(Number value)	The retention period of the snapshot created by the scheduled action.
void	setSnapshotName(String value)	The name of the snapshot.
void	setTags(List<CfnTag> value)	An array of Tag objects to associate with the snapshot.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, 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

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

CfnSnapshot

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

CfnSnapshot

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

CfnSnapshot

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

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

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.

getAttrOwnerAccount

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

The owner AWS ;

account of the snapshot.

getAttrSnapshot

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

getAttrSnapshotAdminUsername

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

The username of the database within a snapshot.

getAttrSnapshotKmsKeyId

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

The unique identifier of the KMS key used to encrypt the snapshot.

getAttrSnapshotNamespaceArn

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

The Amazon Resource Name (ARN) of the namespace the snapshot was created from.

getAttrSnapshotNamespaceName

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

The name of the namepsace.

getAttrSnapshotOwnerAccount

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

The owner AWS ;

account of the snapshot.

getAttrSnapshotRetentionPeriod

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

The retention period of the snapshot created by the scheduled action.

getAttrSnapshotSnapshotArn

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

The Amazon Resource Name (ARN) of the snapshot.

getAttrSnapshotSnapshotCreateTime

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

The timestamp of when the snapshot was created.

getAttrSnapshotSnapshotName

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

The name of the snapshot.

getAttrSnapshotStatus

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

The status of the 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

getSnapshotName

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

The name of the snapshot.

setSnapshotName

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

The name of the snapshot.

getNamespaceName

@Stability(Stable)
@Nullable
public String getNamespaceName()

The name of the namepsace.

setNamespaceName

@Stability(Stable)
public void setNamespaceName(@Nullable
 String value)

The name of the namepsace.

getRetentionPeriod

@Stability(Stable)
@Nullable
public Number getRetentionPeriod()

The retention period of the snapshot created by the scheduled action.

setRetentionPeriod

@Stability(Stable)
public void setRetentionPeriod(@Nullable
 Number value)

The retention period of the snapshot created by the scheduled action.

getTags

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

An array of Tag objects to associate with the snapshot.

setTags

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

An array of Tag objects to associate with the snapshot.