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

Class CfnVolumePropsMixin.OpenZFSConfigurationProperty.Builder

java.lang.Object

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

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnVolumePropsMixin.OpenZFSConfigurationProperty>

Enclosing interface:

CfnVolumePropsMixin.OpenZFSConfigurationProperty

@Stability(Stable)
public static final class CfnVolumePropsMixin.OpenZFSConfigurationProperty.Builder
extends Object
implements software.amazon.jsii.Builder<CfnVolumePropsMixin.OpenZFSConfigurationProperty>

A builder for CfnVolumePropsMixin.OpenZFSConfigurationProperty

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CfnVolumePropsMixin.OpenZFSConfigurationProperty	build()	Builds the configured instance.
CfnVolumePropsMixin.OpenZFSConfigurationProperty.Builder	copyTagsToSnapshots(Boolean copyTagsToSnapshots)	Sets the value of CfnVolumePropsMixin.OpenZFSConfigurationProperty.getCopyTagsToSnapshots()
CfnVolumePropsMixin.OpenZFSConfigurationProperty.Builder	copyTagsToSnapshots(IResolvable copyTagsToSnapshots)	Sets the value of CfnVolumePropsMixin.OpenZFSConfigurationProperty.getCopyTagsToSnapshots()
CfnVolumePropsMixin.OpenZFSConfigurationProperty.Builder	dataCompressionType(String dataCompressionType)	Sets the value of CfnVolumePropsMixin.OpenZFSConfigurationProperty.getDataCompressionType()
CfnVolumePropsMixin.OpenZFSConfigurationProperty.Builder	nfsExports(List<? extends Object> nfsExports)	Sets the value of CfnVolumePropsMixin.OpenZFSConfigurationProperty.getNfsExports()
CfnVolumePropsMixin.OpenZFSConfigurationProperty.Builder	nfsExports(IResolvable nfsExports)	Sets the value of CfnVolumePropsMixin.OpenZFSConfigurationProperty.getNfsExports()
CfnVolumePropsMixin.OpenZFSConfigurationProperty.Builder	options(List<String> options)	Sets the value of CfnVolumePropsMixin.OpenZFSConfigurationProperty.getOptions()
CfnVolumePropsMixin.OpenZFSConfigurationProperty.Builder	originSnapshot(CfnVolumePropsMixin.OriginSnapshotProperty originSnapshot)	Sets the value of CfnVolumePropsMixin.OpenZFSConfigurationProperty.getOriginSnapshot()
CfnVolumePropsMixin.OpenZFSConfigurationProperty.Builder	originSnapshot(IResolvable originSnapshot)	Sets the value of CfnVolumePropsMixin.OpenZFSConfigurationProperty.getOriginSnapshot()
CfnVolumePropsMixin.OpenZFSConfigurationProperty.Builder	parentVolumeId(String parentVolumeId)	Sets the value of CfnVolumePropsMixin.OpenZFSConfigurationProperty.getParentVolumeId()
CfnVolumePropsMixin.OpenZFSConfigurationProperty.Builder	readOnly(Boolean readOnly)	Sets the value of CfnVolumePropsMixin.OpenZFSConfigurationProperty.getReadOnly()
CfnVolumePropsMixin.OpenZFSConfigurationProperty.Builder	readOnly(IResolvable readOnly)	Sets the value of CfnVolumePropsMixin.OpenZFSConfigurationProperty.getReadOnly()
CfnVolumePropsMixin.OpenZFSConfigurationProperty.Builder	recordSizeKiB(Number recordSizeKiB)	Sets the value of CfnVolumePropsMixin.OpenZFSConfigurationProperty.getRecordSizeKiB()
CfnVolumePropsMixin.OpenZFSConfigurationProperty.Builder	storageCapacityQuotaGiB(Number storageCapacityQuotaGiB)	Sets the value of CfnVolumePropsMixin.OpenZFSConfigurationProperty.getStorageCapacityQuotaGiB()
CfnVolumePropsMixin.OpenZFSConfigurationProperty.Builder	storageCapacityReservationGiB(Number storageCapacityReservationGiB)	Sets the value of CfnVolumePropsMixin.OpenZFSConfigurationProperty.getStorageCapacityReservationGiB()
CfnVolumePropsMixin.OpenZFSConfigurationProperty.Builder	userAndGroupQuotas(List<? extends Object> userAndGroupQuotas)	Sets the value of CfnVolumePropsMixin.OpenZFSConfigurationProperty.getUserAndGroupQuotas()
CfnVolumePropsMixin.OpenZFSConfigurationProperty.Builder	userAndGroupQuotas(IResolvable userAndGroupQuotas)	Sets the value of CfnVolumePropsMixin.OpenZFSConfigurationProperty.getUserAndGroupQuotas()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Builder

public Builder()

Method Details

copyTagsToSnapshots

@Stability(Stable)
public CfnVolumePropsMixin.OpenZFSConfigurationProperty.Builder copyTagsToSnapshots(Boolean copyTagsToSnapshots)

Sets the value of CfnVolumePropsMixin.OpenZFSConfigurationProperty.getCopyTagsToSnapshots()

Parameters:

copyTagsToSnapshots - A Boolean value indicating whether tags for the volume should be copied to snapshots. This value defaults to false . If this value is set to true , and you do not specify any tags, all tags for the original volume are copied over to snapshots. If this value is set to true , and you do specify one or more tags, only the specified tags for the original volume are copied over to snapshots. If you specify one or more tags when creating a new snapshot, no tags are copied over from the original volume, regardless of this value.

Returns:

this

copyTagsToSnapshots

@Stability(Stable)
public CfnVolumePropsMixin.OpenZFSConfigurationProperty.Builder copyTagsToSnapshots(IResolvable copyTagsToSnapshots)

Sets the value of CfnVolumePropsMixin.OpenZFSConfigurationProperty.getCopyTagsToSnapshots()

Parameters:

copyTagsToSnapshots - A Boolean value indicating whether tags for the volume should be copied to snapshots. This value defaults to false . If this value is set to true , and you do not specify any tags, all tags for the original volume are copied over to snapshots. If this value is set to true , and you do specify one or more tags, only the specified tags for the original volume are copied over to snapshots. If you specify one or more tags when creating a new snapshot, no tags are copied over from the original volume, regardless of this value.

Returns:

this

dataCompressionType

@Stability(Stable)
public CfnVolumePropsMixin.OpenZFSConfigurationProperty.Builder dataCompressionType(String dataCompressionType)

Sets the value of CfnVolumePropsMixin.OpenZFSConfigurationProperty.getDataCompressionType()

Parameters:

dataCompressionType - Specifies the method used to compress the data on the volume. The compression type is NONE by default.

• NONE - Doesn't compress the data on the volume. NONE is the default.
• ZSTD - Compresses the data in the volume using the Zstandard (ZSTD) compression algorithm. Compared to LZ4, Z-Standard provides a better compression ratio to minimize on-disk storage utilization.
• LZ4 - Compresses the data in the volume using the LZ4 compression algorithm. Compared to Z-Standard, LZ4 is less compute-intensive and delivers higher write throughput speeds.

Returns:

this

nfsExports

@Stability(Stable)
public CfnVolumePropsMixin.OpenZFSConfigurationProperty.Builder nfsExports(IResolvable nfsExports)

Sets the value of CfnVolumePropsMixin.OpenZFSConfigurationProperty.getNfsExports()

Parameters:

nfsExports - The configuration object for mounting a Network File System (NFS) file system.

Returns:

this

nfsExports

@Stability(Stable)
public CfnVolumePropsMixin.OpenZFSConfigurationProperty.Builder nfsExports(List<? extends Object> nfsExports)

Sets the value of CfnVolumePropsMixin.OpenZFSConfigurationProperty.getNfsExports()

Parameters:

nfsExports - The configuration object for mounting a Network File System (NFS) file system.

Returns:

this

options

@Stability(Stable)
public CfnVolumePropsMixin.OpenZFSConfigurationProperty.Builder options(List<String> options)

Sets the value of CfnVolumePropsMixin.OpenZFSConfigurationProperty.getOptions()

Parameters:

options - To delete the volume's child volumes, snapshots, and clones, use the string DELETE_CHILD_VOLUMES_AND_SNAPSHOTS .

Returns:

this

originSnapshot

@Stability(Stable)
public CfnVolumePropsMixin.OpenZFSConfigurationProperty.Builder originSnapshot(IResolvable originSnapshot)

Sets the value of CfnVolumePropsMixin.OpenZFSConfigurationProperty.getOriginSnapshot()

Parameters:

originSnapshot - The configuration object that specifies the snapshot to use as the origin of the data for the volume.

Returns:

this

originSnapshot

@Stability(Stable)
public CfnVolumePropsMixin.OpenZFSConfigurationProperty.Builder originSnapshot(CfnVolumePropsMixin.OriginSnapshotProperty originSnapshot)

Sets the value of CfnVolumePropsMixin.OpenZFSConfigurationProperty.getOriginSnapshot()

Parameters:

originSnapshot - The configuration object that specifies the snapshot to use as the origin of the data for the volume.

Returns:

this

parentVolumeId

@Stability(Stable)
public CfnVolumePropsMixin.OpenZFSConfigurationProperty.Builder parentVolumeId(String parentVolumeId)

Sets the value of CfnVolumePropsMixin.OpenZFSConfigurationProperty.getParentVolumeId()

Parameters:

parentVolumeId - The ID of the volume to use as the parent volume of the volume that you are creating.

Returns:

this

readOnly

@Stability(Stable)
public CfnVolumePropsMixin.OpenZFSConfigurationProperty.Builder readOnly(Boolean readOnly)

Sets the value of CfnVolumePropsMixin.OpenZFSConfigurationProperty.getReadOnly()

Parameters:

readOnly - A Boolean value indicating whether the volume is read-only.

Returns:

this

readOnly

@Stability(Stable)
public CfnVolumePropsMixin.OpenZFSConfigurationProperty.Builder readOnly(IResolvable readOnly)

Sets the value of CfnVolumePropsMixin.OpenZFSConfigurationProperty.getReadOnly()

Parameters:

readOnly - A Boolean value indicating whether the volume is read-only.

Returns:

this

recordSizeKiB

@Stability(Stable)
public CfnVolumePropsMixin.OpenZFSConfigurationProperty.Builder recordSizeKiB(Number recordSizeKiB)

Sets the value of CfnVolumePropsMixin.OpenZFSConfigurationProperty.getRecordSizeKiB()

Parameters:

recordSizeKiB - Specifies the suggested block size for a volume in a ZFS dataset, in kibibytes (KiB). For file systems using the Intelligent-Tiering storage class, valid values are 128, 256, 512, 1024, 2048, or 4096 KiB, with a default of 1024 KiB. For all other file systems, valid values are 4, 8, 16, 32, 64, 128, 256, 512, or 1024 KiB, with a default of 128 KiB. We recommend using the default setting for the majority of use cases. Generally, workloads that write in fixed small or large record sizes may benefit from setting a custom record size, like database workloads (small record size) or media streaming workloads (large record size). For additional guidance on when to set a custom record size, see ZFS Record size in the Amazon FSx for OpenZFS User Guide .

Returns:

this

storageCapacityQuotaGiB

@Stability(Stable)
public CfnVolumePropsMixin.OpenZFSConfigurationProperty.Builder storageCapacityQuotaGiB(Number storageCapacityQuotaGiB)

Sets the value of CfnVolumePropsMixin.OpenZFSConfigurationProperty.getStorageCapacityQuotaGiB()

Parameters:

storageCapacityQuotaGiB - Sets the maximum storage size in gibibytes (GiB) for the volume. You can specify a quota that is larger than the storage on the parent volume. A volume quota limits the amount of storage that the volume can consume to the configured amount, but does not guarantee the space will be available on the parent volume. To guarantee quota space, you must also set StorageCapacityReservationGiB . To not specify a storage capacity quota, set this to -1 .

For more information, see Volume properties in the Amazon FSx for OpenZFS User Guide .

Returns:

this

storageCapacityReservationGiB

@Stability(Stable)
public CfnVolumePropsMixin.OpenZFSConfigurationProperty.Builder storageCapacityReservationGiB(Number storageCapacityReservationGiB)

Sets the value of CfnVolumePropsMixin.OpenZFSConfigurationProperty.getStorageCapacityReservationGiB()

Parameters:

storageCapacityReservationGiB - Specifies the amount of storage in gibibytes (GiB) to reserve from the parent volume. Setting StorageCapacityReservationGiB guarantees that the specified amount of storage space on the parent volume will always be available for the volume. You can't reserve more storage than the parent volume has. To not specify a storage capacity reservation, set this to 0 or -1 . For more information, see Volume properties in the Amazon FSx for OpenZFS User Guide .

Returns:

this

userAndGroupQuotas

@Stability(Stable)
public CfnVolumePropsMixin.OpenZFSConfigurationProperty.Builder userAndGroupQuotas(IResolvable userAndGroupQuotas)

Sets the value of CfnVolumePropsMixin.OpenZFSConfigurationProperty.getUserAndGroupQuotas()

Parameters:

userAndGroupQuotas - Configures how much storage users and groups can use on the volume.

Returns:

this

userAndGroupQuotas

@Stability(Stable)
public CfnVolumePropsMixin.OpenZFSConfigurationProperty.Builder userAndGroupQuotas(List<? extends Object> userAndGroupQuotas)

Sets the value of CfnVolumePropsMixin.OpenZFSConfigurationProperty.getUserAndGroupQuotas()

Parameters:

userAndGroupQuotas - Configures how much storage users and groups can use on the volume.

Returns:

this

build

@Stability(Stable)
public CfnVolumePropsMixin.OpenZFSConfigurationProperty build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<CfnVolumePropsMixin.OpenZFSConfigurationProperty>

Returns:

a new instance of CfnVolumePropsMixin.OpenZFSConfigurationProperty

Throws:

NullPointerException - if any required attribute was not provided