Package 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, ITaggable, IVolumeRef, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.116.0 (build 0eddcff)", date="2025-10-29T11:15:40.546Z") @Stability(Stable) public class CfnVolume extends CfnResource implements IInspectable, IVolumeRef, ITaggable
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()
                 .storageVirtualMachineId("storageVirtualMachineId")
                 // the properties below are optional
                 .aggregateConfiguration(AggregateConfigurationProperty.builder()
                         .aggregates(List.of("aggregates"))
                         .constituentsPerAggregate(123)
                         .build())
                 .copyTagsToBackups("copyTagsToBackups")
                 .junctionPath("junctionPath")
                 .ontapVolumeType("ontapVolumeType")
                 .securityStyle("securityStyle")
                 .sizeInBytes("sizeInBytes")
                 .sizeInMegabytes("sizeInMegabytes")
                 .snaplockConfiguration(SnaplockConfigurationProperty.builder()
                         .snaplockType("snaplockType")
                         // the properties below are optional
                         .auditLogVolume("auditLogVolume")
                         .autocommitPeriod(AutocommitPeriodProperty.builder()
                                 .type("type")
                                 // the properties below are optional
                                 .value(123)
                                 .build())
                         .privilegedDelete("privilegedDelete")
                         .retentionPeriod(SnaplockRetentionPeriodProperty.builder()
                                 .defaultRetention(RetentionPeriodProperty.builder()
                                         .type("type")
                                         // the properties below are optional
                                         .value(123)
                                         .build())
                                 .maximumRetention(RetentionPeriodProperty.builder()
                                         .type("type")
                                         // the properties below are optional
                                         .value(123)
                                         .build())
                                 .minimumRetention(RetentionPeriodProperty.builder()
                                         .type("type")
                                         // the properties below are optional
                                         .value(123)
                                         .build())
                                 .build())
                         .volumeAppendModeEnabled("volumeAppendModeEnabled")
                         .build())
                 .snapshotPolicy("snapshotPolicy")
                 .storageEfficiencyEnabled("storageEfficiencyEnabled")
                 .tieringPolicy(TieringPolicyProperty.builder()
                         .coolingPeriod(123)
                         .name("name")
                         .build())
                 .volumeStyle("volumeStyle")
                 .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();

See Also:

  • 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

    • CfnVolume

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

    • CfnVolume

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

    • CfnVolume

      @Stability(Stable) public CfnVolume(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnVolumeProps 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.

    • getAttrResourceArn

      @Stability(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(Stable) @NotNull public String getAttrUuid()
      Returns the volume's universally unique identifier (UUID).

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

    • getAttrVolumeId

      @Stability(Stable) @NotNull public String getAttrVolumeId()
      Returns the volume's ID.

      Example: fsvol-0123456789abcdefa

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getTags in interface ITaggable

    • getVolumeRef

      @Stability(Stable) @NotNull public VolumeReference getVolumeRef()
      A reference to a Volume resource.
      Specified by:
      getVolumeRef in interface IVolumeRef

    • getName

      @Stability(Stable) @NotNull public String getName()
      The name of the volume.

    • setName

      @Stability(Stable) public void setName(@NotNull String value)
      The name of the volume.

    • getBackupId

      @Stability(Stable) @Nullable public String getBackupId()
      Specifies the ID of the volume backup to use to create a new volume.

    • setBackupId

      @Stability(Stable) public void setBackupId(@Nullable String value)
      Specifies the ID of the volume backup to use to create a new volume.

    • getOntapConfiguration

      @Stability(Stable) @Nullable public Object getOntapConfiguration()
      The configuration of an Amazon FSx for NetApp ONTAP volume.

      Returns union: either IResolvable or CfnVolume.OntapConfigurationProperty

    • setOntapConfiguration

      @Stability(Stable) public void setOntapConfiguration(@Nullable IResolvable value)
      The configuration of an Amazon FSx for NetApp ONTAP volume.

    • setOntapConfiguration

      @Stability(Stable) public void setOntapConfiguration(@Nullable CfnVolume.OntapConfigurationProperty value)
      The configuration of an Amazon FSx for NetApp ONTAP volume.

    • getOpenZfsConfiguration

      @Stability(Stable) @Nullable public Object getOpenZfsConfiguration()
      The configuration of an Amazon FSx for OpenZFS volume.

      Returns union: either IResolvable or CfnVolume.OpenZFSConfigurationProperty

    • setOpenZfsConfiguration

      @Stability(Stable) public void setOpenZfsConfiguration(@Nullable IResolvable value)
      The configuration of an Amazon FSx for OpenZFS volume.

    • setOpenZfsConfiguration

      @Stability(Stable) public void setOpenZfsConfiguration(@Nullable CfnVolume.OpenZFSConfigurationProperty value)
      The configuration of an Amazon FSx for OpenZFS volume.

    • getTagsRaw

      @Stability(Stable) @Nullable public List<CfnTag> getTagsRaw()
      An array of key-value pairs to apply to this resource.

    • setTagsRaw

      @Stability(Stable) public void setTagsRaw(@Nullable List<CfnTag> value)
      An array of key-value pairs to apply to this resource.

    • getVolumeType

      @Stability(Stable) @Nullable public String getVolumeType()
      The type of the volume.

    • setVolumeType

      @Stability(Stable) public void setVolumeType(@Nullable String value)
      The type of the volume.