Package software.amazon.awscdk.services.fsx

Class CfnVolume.OpenZFSConfigurationProperty.Jsii$Proxy

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.fsx.CfnVolume.OpenZFSConfigurationProperty.Jsii$Proxy

All Implemented Interfaces:

CfnVolume.OpenZFSConfigurationProperty, software.amazon.jsii.JsiiSerializable

Enclosing interface:

CfnVolume.OpenZFSConfigurationProperty

@Stability(Stable)
@Internal
public static final class CfnVolume.OpenZFSConfigurationProperty.Jsii$Proxy
extends software.amazon.jsii.JsiiObject
implements CfnVolume.OpenZFSConfigurationProperty

An implementation for CfnVolume.OpenZFSConfigurationProperty

Nested Class Summary

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

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.fsx.CfnVolume.OpenZFSConfigurationProperty

CfnVolume.OpenZFSConfigurationProperty.Builder, CfnVolume.OpenZFSConfigurationProperty.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Jsii$Proxy(CfnVolume.OpenZFSConfigurationProperty.Builder builder)	Constructor that initializes the object based on literal property values passed by the CfnVolume.OpenZFSConfigurationProperty.Builder.
protected	Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)	Constructor that initializes the object based on values retrieved from the JsiiObject.

Method Summary

Modifier and Type	Method	Description
com.fasterxml.jackson.databind.JsonNode	$jsii$toJson()
final boolean	equals(Object o)
final Object	getCopyTagsToSnapshots()	A Boolean value indicating whether tags for the volume should be copied to snapshots.
final String	getDataCompressionType()	Specifies the method used to compress the data on the volume.
final Object	getNfsExports()	The configuration object for mounting a Network File System (NFS) file system.
final List<String>	getOptions()	To delete the volume's child volumes, snapshots, and clones, use the string DELETE_CHILD_VOLUMES_AND_SNAPSHOTS .
final Object	getOriginSnapshot()	The configuration object that specifies the snapshot to use as the origin of the data for the volume.
final String	getParentVolumeId()	The ID of the volume to use as the parent volume of the volume that you are creating.
final Object	getReadOnly()	A Boolean value indicating whether the volume is read-only.
final Number	getRecordSizeKiB()	Specifies the suggested block size for a volume in a ZFS dataset, in kibibytes (KiB).
final Number	getStorageCapacityQuotaGiB()	Sets the maximum storage size in gibibytes (GiB) for the volume.
final Number	getStorageCapacityReservationGiB()	Specifies the amount of storage in gibibytes (GiB) to reserve from the parent volume.
final Object	getUserAndGroupQuotas()	Configures how much storage users and groups can use on the volume.
final int	hashCode()

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, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Jsii$Proxy

protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)

Constructor that initializes the object based on values retrieved from the JsiiObject.

Parameters:

objRef - Reference to the JSII managed object.

Jsii$Proxy

protected Jsii$Proxy(CfnVolume.OpenZFSConfigurationProperty.Builder builder)

Constructor that initializes the object based on literal property values passed by the CfnVolume.OpenZFSConfigurationProperty.Builder.

Method Details

getParentVolumeId

public final String getParentVolumeId()

Description copied from interface: CfnVolume.OpenZFSConfigurationProperty

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

Specified by:

getParentVolumeId in interface CfnVolume.OpenZFSConfigurationProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-volume-openzfsconfiguration.html#cfn-fsx-volume-openzfsconfiguration-parentvolumeid

getCopyTagsToSnapshots

public final Object getCopyTagsToSnapshots()

Description copied from interface: CfnVolume.OpenZFSConfigurationProperty

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 union: either Boolean or IResolvable

Specified by:

getCopyTagsToSnapshots in interface CfnVolume.OpenZFSConfigurationProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-volume-openzfsconfiguration.html#cfn-fsx-volume-openzfsconfiguration-copytagstosnapshots

getDataCompressionType

public final String getDataCompressionType()

Description copied from interface: CfnVolume.OpenZFSConfigurationProperty

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.

Specified by:

getDataCompressionType in interface CfnVolume.OpenZFSConfigurationProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-volume-openzfsconfiguration.html#cfn-fsx-volume-openzfsconfiguration-datacompressiontype

getNfsExports

public final Object getNfsExports()

Description copied from interface: CfnVolume.OpenZFSConfigurationProperty

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

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnVolume.NfsExportsProperty>

Specified by:

getNfsExports in interface CfnVolume.OpenZFSConfigurationProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-volume-openzfsconfiguration.html#cfn-fsx-volume-openzfsconfiguration-nfsexports

getOptions

public final List<String> getOptions()

Description copied from interface: CfnVolume.OpenZFSConfigurationProperty

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

Specified by:

getOptions in interface CfnVolume.OpenZFSConfigurationProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-volume-openzfsconfiguration.html#cfn-fsx-volume-openzfsconfiguration-options

getOriginSnapshot

public final Object getOriginSnapshot()

Description copied from interface: CfnVolume.OpenZFSConfigurationProperty

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

Returns union: either IResolvable or CfnVolume.OriginSnapshotProperty

Specified by:

getOriginSnapshot in interface CfnVolume.OpenZFSConfigurationProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-volume-openzfsconfiguration.html#cfn-fsx-volume-openzfsconfiguration-originsnapshot

getReadOnly

public final Object getReadOnly()

Description copied from interface: CfnVolume.OpenZFSConfigurationProperty

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

Returns union: either Boolean or IResolvable

Specified by:

getReadOnly in interface CfnVolume.OpenZFSConfigurationProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-volume-openzfsconfiguration.html#cfn-fsx-volume-openzfsconfiguration-readonly

getRecordSizeKiB

public final Number getRecordSizeKiB()

Description copied from interface: CfnVolume.OpenZFSConfigurationProperty

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 .

Specified by:

getRecordSizeKiB in interface CfnVolume.OpenZFSConfigurationProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-volume-openzfsconfiguration.html#cfn-fsx-volume-openzfsconfiguration-recordsizekib

getStorageCapacityQuotaGiB

public final Number getStorageCapacityQuotaGiB()

Description copied from interface: CfnVolume.OpenZFSConfigurationProperty

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 .

Specified by:

getStorageCapacityQuotaGiB in interface CfnVolume.OpenZFSConfigurationProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-volume-openzfsconfiguration.html#cfn-fsx-volume-openzfsconfiguration-storagecapacityquotagib

getStorageCapacityReservationGiB

public final Number getStorageCapacityReservationGiB()

Description copied from interface: CfnVolume.OpenZFSConfigurationProperty

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 .

Specified by:

getStorageCapacityReservationGiB in interface CfnVolume.OpenZFSConfigurationProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-volume-openzfsconfiguration.html#cfn-fsx-volume-openzfsconfiguration-storagecapacityreservationgib

getUserAndGroupQuotas

public final Object getUserAndGroupQuotas()

Description copied from interface: CfnVolume.OpenZFSConfigurationProperty

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

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnVolume.UserAndGroupQuotasProperty>

Specified by:

getUserAndGroupQuotas in interface CfnVolume.OpenZFSConfigurationProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-volume-openzfsconfiguration.html#cfn-fsx-volume-openzfsconfiguration-userandgroupquotas

$jsii$toJson

@Internal
public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()

Specified by:

$jsii$toJson in interface software.amazon.jsii.JsiiSerializable

equals

public final boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public final int hashCode()

Overrides:

hashCode in class Object