software.amazon.awscdk.services.fsx

Class CfnVolume

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

All Implemented Interfaces:

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

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:39.450Z")
 @Stability(value=Stable)
public class CfnVolume
extends CfnResource
implements IInspectable

A CloudFormation `AWS::FSx::Volume`.

Creates an FSx for ONTAP or Amazon FSx for OpenZFS storage 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.*;
 CfnVolume cfnVolume = CfnVolume.Builder.create(this, "MyCfnVolume")
         .name("name")
         // the properties below are optional
         .backupId("backupId")
         .ontapConfiguration(OntapConfigurationProperty.builder()
                 .junctionPath("junctionPath")
                 .sizeInMegabytes("sizeInMegabytes")
                 .storageEfficiencyEnabled("storageEfficiencyEnabled")
                 .storageVirtualMachineId("storageVirtualMachineId")
                 // the properties below are optional
                 .securityStyle("securityStyle")
                 .tieringPolicy(TieringPolicyProperty.builder()
                         .coolingPeriod(123)
                         .name("name")
                         .build())
                 .build())
         .openZfsConfiguration(OpenZFSConfigurationProperty.builder()
                 .parentVolumeId("parentVolumeId")
                 // the properties below are optional
                 .copyTagsToSnapshots(false)
                 .dataCompressionType("dataCompressionType")
                 .nfsExports(List.of(NfsExportsProperty.builder()
                         .clientConfigurations(List.of(ClientConfigurationsProperty.builder()
                                 .clients("clients")
                                 .options(List.of("options"))
                                 .build()))
                         .build()))
                 .options(List.of("options"))
                 .originSnapshot(OriginSnapshotProperty.builder()
                         .copyStrategy("copyStrategy")
                         .snapshotArn("snapshotArn")
                         .build())
                 .readOnly(false)
                 .recordSizeKiB(123)
                 .storageCapacityQuotaGiB(123)
                 .storageCapacityReservationGiB(123)
                 .userAndGroupQuotas(List.of(UserAndGroupQuotasProperty.builder()
                         .id(123)
                         .storageCapacityQuotaGiB(123)
                         .type("type")
                         .build()))
                 .build())
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .volumeType("volumeType")
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnVolume.Builder A fluent builder for CfnVolume.
static interface	CfnVolume.ClientConfigurationsProperty Specifies who can mount an OpenZFS file system and the options available while mounting the file system.
static interface	CfnVolume.NfsExportsProperty The configuration object for mounting a Network File System (NFS) file system.
static interface	CfnVolume.OntapConfigurationProperty Specifies the configuration of the ONTAP volume that you are creating.
static interface	CfnVolume.OpenZFSConfigurationProperty Specifies the configuration of the Amazon FSx for OpenZFS volume that you are creating.
static interface	CfnVolume.OriginSnapshotProperty The configuration object that specifies the snapshot to use as the origin of the data for the volume.
static interface	CfnVolume.TieringPolicyProperty Describes the data tiering policy for an ONTAP volume.
static interface	CfnVolume.UserAndGroupQuotasProperty An object specifying how much storage users or groups can use on the volume.

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

software.amazon.jsii.JsiiObject.InitializationMode

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

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

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

software.constructs.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
	CfnVolume(software.constructs.Construct scope, String id, CfnVolumeProps props) Create a new `AWS::FSx::Volume`.
protected	CfnVolume(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnVolume(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
String	getAttrResourceArn() Returns the volume's Amazon Resource Name (ARN).
String	getAttrUuid() Returns the volume's universally unique identifier (UUID).
String	getAttrVolumeId() Returns the volume's ID.
String	getBackupId() Specifies the ID of the volume backup to use to create a new volume.
protected Map<String,Object>	getCfnProperties()
String	getName() The name of the volume.
Object	getOntapConfiguration() The configuration of an Amazon FSx for NetApp ONTAP volume.
Object	getOpenZfsConfiguration() The configuration of an Amazon FSx for OpenZFS volume.
TagManager	getTags() An array of key-value pairs to apply to this resource.
String	getVolumeType() The type of the volume.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setBackupId(String value) Specifies the ID of the volume backup to use to create a new volume.
void	setName(String value) The name of the volume.
void	setOntapConfiguration(CfnVolume.OntapConfigurationProperty value) The configuration of an Amazon FSx for NetApp ONTAP volume.
void	setOntapConfiguration(IResolvable value) The configuration of an Amazon FSx for NetApp ONTAP volume.
void	setOpenZfsConfiguration(CfnVolume.OpenZFSConfigurationProperty value) The configuration of an Amazon FSx for OpenZFS volume.
void	setOpenZfsConfiguration(IResolvable value) The configuration of an Amazon FSx for OpenZFS volume.
void	setVolumeType(String value) The type of the volume.

Methods inherited from class software.amazon.awscdk.CfnResource

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

CfnVolume

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

CfnVolume

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

CfnVolume

@Stability(value=Stable)
public CfnVolume(@NotNull
                                          software.constructs.Construct scope,
                                          @NotNull
                                          String id,
                                          @NotNull
                                          CfnVolumeProps props)

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

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 volume's Amazon Resource Name (ARN).

Example: arn:aws:fsx:us-east-2:111122223333:volume/fs-0123456789abcdef9/fsvol-01234567891112223

getAttrUuid

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

Returns the volume's universally unique identifier (UUID).

Example: abcd0123-cd45-ef67-11aa-1111aaaa23bc

getAttrVolumeId

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

Returns the volume's ID.

Example: fsvol-0123456789abcdefa

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

setName

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

The name of the volume.

getBackupId

@Stability(value=Stable)
 @Nullable
public String getBackupId()

Specifies the ID of the volume backup to use to create a new volume.

setBackupId

@Stability(value=Stable)
public void setBackupId(@Nullable
                                                 String value)

Specifies the ID of the volume backup to use to create a new volume.

getOntapConfiguration

@Stability(value=Stable)
 @Nullable
public Object getOntapConfiguration()

The configuration of an Amazon FSx for NetApp ONTAP volume.

setOntapConfiguration

@Stability(value=Stable)
public void setOntapConfiguration(@Nullable
                                                           CfnVolume.OntapConfigurationProperty value)

The configuration of an Amazon FSx for NetApp ONTAP volume.

setOntapConfiguration

@Stability(value=Stable)
public void setOntapConfiguration(@Nullable
                                                           IResolvable value)

The configuration of an Amazon FSx for NetApp ONTAP volume.

getOpenZfsConfiguration

@Stability(value=Stable)
 @Nullable
public Object getOpenZfsConfiguration()

The configuration of an Amazon FSx for OpenZFS volume.

setOpenZfsConfiguration

@Stability(value=Stable)
public void setOpenZfsConfiguration(@Nullable
                                                             CfnVolume.OpenZFSConfigurationProperty value)

The configuration of an Amazon FSx for OpenZFS volume.

setOpenZfsConfiguration

@Stability(value=Stable)
public void setOpenZfsConfiguration(@Nullable
                                                             IResolvable value)

The configuration of an Amazon FSx for OpenZFS volume.

getVolumeType

@Stability(value=Stable)
 @Nullable
public String getVolumeType()

The type of the volume.

setVolumeType

@Stability(value=Stable)
public void setVolumeType(@Nullable
                                                   String value)

The type of the volume.