software.amazon.awscdk.services.fsx

Class CfnSnapshot

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.CfnElement

software.amazon.awscdk.core.CfnRefElement

software.amazon.awscdk.core.CfnResource

software.amazon.awscdk.services.fsx.CfnSnapshot

All Implemented Interfaces:

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

@Generated(value="jsii-pacmak/1.70.0 (build 03c2f6f)",
           date="2022-11-01T13:16:49.277Z")
 @Stability(value=Stable)
public class CfnSnapshot
extends CfnResource
implements IInspectable

A CloudFormation `AWS::FSx::Snapshot`.

A snapshot of an Amazon FSx for OpenZFS volume.

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

Nested Class Summary

Nested Classes

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

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

software.amazon.jsii.JsiiObject.InitializationMode

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

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnSnapshot(Construct scope, String id, CfnSnapshotProps props) Create a new `AWS::FSx::Snapshot`.
protected	CfnSnapshot(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnSnapshot(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
String	getAttrResourceArn() Returns the snapshot's Amazon Resource Name (ARN).
protected Map<String,Object>	getCfnProperties()
String	getName() The name of the snapshot.
TagManager	getTags() An array of key-value pairs to apply to this resource.
String	getVolumeId() The ID of the volume that the snapshot is of.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setName(String value) The name of the snapshot.
void	setVolumeId(String value) The ID of the volume that the snapshot is of.

Methods inherited from class software.amazon.awscdk.core.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

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 Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnSnapshot

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

CfnSnapshot

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

CfnSnapshot

@Stability(value=Stable)
public CfnSnapshot(@NotNull
                                            Construct scope,
                                            @NotNull
                                            String id,
                                            @NotNull
                                            CfnSnapshotProps props)

Create a new `AWS::FSx::Snapshot`.

Parameters:

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

id - - scoped id of the resource. This parameter is required.

props - - resource properties. This parameter is required.

Method Detail

inspect

@Stability(value=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(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrResourceArn

@Stability(value=Stable)
 @NotNull
public String getAttrResourceArn()

Returns the snapshot's Amazon Resource Name (ARN).

Example: arn:aws:fsx:us-east-2:111133334444:snapshot/fsvol-01234567890123456/fsvolsnap-0123456789abcedf5

getCfnProperties

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

Overrides:

getCfnProperties in class CfnResource

getTags

@Stability(value=Stable)
 @NotNull
public TagManager getTags()

An array of key-value pairs to apply to this resource.

For more information, see Tag .

getName

@Stability(value=Stable)
 @NotNull
public String getName()

The name of the snapshot.

setName

@Stability(value=Stable)
public void setName(@NotNull
                                             String value)

The name of the snapshot.

getVolumeId

@Stability(value=Stable)
 @NotNull
public String getVolumeId()

The ID of the volume that the snapshot is of.

setVolumeId

@Stability(value=Stable)
public void setVolumeId(@NotNull
                                                 String value)

The ID of the volume that the snapshot is of.