Package software.amazon.awscdk.cfnpropertymixins.services.fsx

Class CfnVolumePropsMixin

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.Mixin

software.amazon.awscdk.cfnpropertymixins.services.fsx.CfnVolumePropsMixin

All Implemented Interfaces:

software.amazon.jsii.JsiiSerializable, software.constructs.IMixin

@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)",
           date="2026-03-11T13:19:59.558Z")
@Stability(Stable)
public class CfnVolumePropsMixin
extends Mixin
implements software.constructs.IMixin

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.cfnpropertymixins.services.fsx.*;
 import software.amazon.awscdk.*;
 IMergeStrategy mergeStrategy;
 CfnVolumePropsMixin cfnVolumePropsMixin = CfnVolumePropsMixin.Builder.create(CfnVolumeMixinProps.builder()
         .backupId("backupId")
         .name("name")
         .ontapConfiguration(OntapConfigurationProperty.builder()
                 .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()
                         .auditLogVolume("auditLogVolume")
                         .autocommitPeriod(AutocommitPeriodProperty.builder()
                                 .type("type")
                                 .value(123)
                                 .build())
                         .privilegedDelete("privilegedDelete")
                         .retentionPeriod(SnaplockRetentionPeriodProperty.builder()
                                 .defaultRetention(RetentionPeriodProperty.builder()
                                         .type("type")
                                         .value(123)
                                         .build())
                                 .maximumRetention(RetentionPeriodProperty.builder()
                                         .type("type")
                                         .value(123)
                                         .build())
                                 .minimumRetention(RetentionPeriodProperty.builder()
                                         .type("type")
                                         .value(123)
                                         .build())
                                 .build())
                         .snaplockType("snaplockType")
                         .volumeAppendModeEnabled("volumeAppendModeEnabled")
                         .build())
                 .snapshotPolicy("snapshotPolicy")
                 .storageEfficiencyEnabled("storageEfficiencyEnabled")
                 .storageVirtualMachineId("storageVirtualMachineId")
                 .tieringPolicy(TieringPolicyProperty.builder()
                         .coolingPeriod(123)
                         .name("name")
                         .build())
                 .volumeStyle("volumeStyle")
                 .build())
         .openZfsConfiguration(OpenZFSConfigurationProperty.builder()
                 .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())
                 .parentVolumeId("parentVolumeId")
                 .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())
 .strategy(mergeStrategy)
 .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-fsx-volume.html

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CfnVolumePropsMixin.AggregateConfigurationProperty	Use to specify configuration options for a volume’s storage aggregate or aggregates.
static interface	CfnVolumePropsMixin.AutocommitPeriodProperty	Sets the autocommit period of files in an FSx for ONTAP SnapLock volume, which determines how long the files must remain unmodified before they're automatically transitioned to the write once, read many (WORM) state.
static final class	CfnVolumePropsMixin.Builder	A fluent builder for CfnVolumePropsMixin.
static interface	CfnVolumePropsMixin.ClientConfigurationsProperty	Specifies who can mount an OpenZFS file system and the options available while mounting the file system.
static interface	CfnVolumePropsMixin.NfsExportsProperty	The configuration object for mounting a Network File System (NFS) file system.
static interface	CfnVolumePropsMixin.OntapConfigurationProperty	Specifies the configuration of the ONTAP volume that you are creating.
static interface	CfnVolumePropsMixin.OpenZFSConfigurationProperty	Specifies the configuration of the Amazon FSx for OpenZFS volume that you are creating.
static interface	CfnVolumePropsMixin.OriginSnapshotProperty	The configuration object that specifies the snapshot to use as the origin of the data for the volume.
static interface	CfnVolumePropsMixin.RetentionPeriodProperty	Specifies the retention period of an FSx for ONTAP SnapLock volume.
static interface	CfnVolumePropsMixin.SnaplockConfigurationProperty	Specifies the SnapLock configuration for an FSx for ONTAP SnapLock volume.
static interface	CfnVolumePropsMixin.SnaplockRetentionPeriodProperty	The configuration to set the retention period of an FSx for ONTAP SnapLock volume.
static interface	CfnVolumePropsMixin.TieringPolicyProperty	Describes the data tiering policy for an ONTAP volume.
static interface	CfnVolumePropsMixin.UserAndGroupQuotasProperty	Configures how much storage users and 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.constructs.IMixin

software.constructs.IMixin.Jsii$Default, software.constructs.IMixin.Jsii$Proxy

Field Summary

Fields

Modifier and Type	Field	Description
protected static final List<String>	CFN_PROPERTY_KEYS

Constructor Summary

Constructors

Modifier	Constructor	Description
	CfnVolumePropsMixin(CfnVolumeMixinProps props)	Create a mixin to apply properties to AWS::FSx::Volume.
	CfnVolumePropsMixin(CfnVolumeMixinProps props, CfnPropertyMixinOptions options)	Create a mixin to apply properties to AWS::FSx::Volume.
protected	CfnVolumePropsMixin(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnVolumePropsMixin(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method	Description
void	applyTo(software.constructs.IConstruct construct)	Apply the mixin properties to the construct.
protected CfnVolumeMixinProps	getProps()
protected IMergeStrategy	getStrategy()
Boolean	supports(software.constructs.IConstruct construct)	Check if this mixin supports the given construct.

Methods inherited from class software.amazon.awscdk.Mixin

isMixin

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, toString, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Details

CFN_PROPERTY_KEYS

@Stability(Stable)
protected static final List<String> CFN_PROPERTY_KEYS

Constructor Details

CfnVolumePropsMixin

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

CfnVolumePropsMixin

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

CfnVolumePropsMixin

@Stability(Stable)
public CfnVolumePropsMixin(@NotNull
 CfnVolumeMixinProps props,
 @Nullable
 CfnPropertyMixinOptions options)

Create a mixin to apply properties to AWS::FSx::Volume.

Parameters:

props - L1 properties to apply. This parameter is required.

options - Mixin options.

CfnVolumePropsMixin

@Stability(Stable)
public CfnVolumePropsMixin(@NotNull
 CfnVolumeMixinProps props)

Create a mixin to apply properties to AWS::FSx::Volume.

Parameters:

props - L1 properties to apply. This parameter is required.

Method Details

applyTo

@Stability(Stable)
public void applyTo(@NotNull
 software.constructs.IConstruct construct)

Apply the mixin properties to the construct.

Specified by:

applyTo in interface software.constructs.IMixin

Specified by:

applyTo in class Mixin

Parameters:

construct - This parameter is required.

supports

@Stability(Stable)
@NotNull
public Boolean supports(@NotNull
 software.constructs.IConstruct construct)

Check if this mixin supports the given construct.

Specified by:

supports in interface software.constructs.IMixin

Overrides:

supports in class Mixin

Parameters:

construct - This parameter is required.

getProps

@Stability(Stable)
@NotNull
protected CfnVolumeMixinProps getProps()

getStrategy

@Stability(Stable)
@NotNull
protected IMergeStrategy getStrategy()