CreateOpenZFSVolumeConfiguration (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.fsx.model.CreateOpenZFSVolumeConfiguration

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class CreateOpenZFSVolumeConfiguration
extends Object
implements Serializable, Cloneable, StructuredPojo
```
Specifies the configuration of the Amazon FSx for OpenZFS volume that you are creating.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

CreateOpenZFSVolumeConfiguration()

Constructors
Constructor and Description
`CreateOpenZFSVolumeConfiguration()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CreateOpenZFSVolumeConfiguration`	`clone()`
`boolean`	`equals(Object obj)`
`Boolean`	`getCopyTagsToSnapshots()` A Boolean value indicating whether tags for the volume should be copied to snapshots.
`String`	`getDataCompressionType()` Specifies the method used to compress the data on the volume.
`List<OpenZFSNfsExport>`	`getNfsExports()` The configuration object for mounting a Network File System (NFS) file system.
`CreateOpenZFSOriginSnapshotConfiguration`	`getOriginSnapshot()` The configuration object that specifies the snapshot to use as the origin of the data for the volume.
`String`	`getParentVolumeId()` The ID of the volume to use as the parent volume of the volume that you are creating.
`Boolean`	`getReadOnly()` A Boolean value indicating whether the volume is read-only.
`Integer`	`getRecordSizeKiB()` Specifies the suggested block size for a volume in a ZFS dataset, in kibibytes (KiB).
`Integer`	`getStorageCapacityQuotaGiB()` Sets the maximum storage size in gibibytes (GiB) for the volume.
`Integer`	`getStorageCapacityReservationGiB()` Specifies the amount of storage in gibibytes (GiB) to reserve from the parent volume.
`List<OpenZFSUserOrGroupQuota>`	`getUserAndGroupQuotas()` Configures how much storage users and groups can use on the volume.
`int`	`hashCode()`
`Boolean`	`isCopyTagsToSnapshots()` A Boolean value indicating whether tags for the volume should be copied to snapshots.
`Boolean`	`isReadOnly()` A Boolean value indicating whether the volume is read-only.
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setCopyTagsToSnapshots(Boolean copyTagsToSnapshots)` A Boolean value indicating whether tags for the volume should be copied to snapshots.
`void`	`setDataCompressionType(String dataCompressionType)` Specifies the method used to compress the data on the volume.
`void`	`setNfsExports(Collection<OpenZFSNfsExport> nfsExports)` The configuration object for mounting a Network File System (NFS) file system.
`void`	`setOriginSnapshot(CreateOpenZFSOriginSnapshotConfiguration originSnapshot)` The configuration object that specifies the snapshot to use as the origin of the data for the volume.
`void`	`setParentVolumeId(String parentVolumeId)` The ID of the volume to use as the parent volume of the volume that you are creating.
`void`	`setReadOnly(Boolean readOnly)` A Boolean value indicating whether the volume is read-only.
`void`	`setRecordSizeKiB(Integer recordSizeKiB)` Specifies the suggested block size for a volume in a ZFS dataset, in kibibytes (KiB).
`void`	`setStorageCapacityQuotaGiB(Integer storageCapacityQuotaGiB)` Sets the maximum storage size in gibibytes (GiB) for the volume.
`void`	`setStorageCapacityReservationGiB(Integer storageCapacityReservationGiB)` Specifies the amount of storage in gibibytes (GiB) to reserve from the parent volume.
`void`	`setUserAndGroupQuotas(Collection<OpenZFSUserOrGroupQuota> userAndGroupQuotas)` Configures how much storage users and groups can use on the volume.
`String`	`toString()` Returns a string representation of this object.
`CreateOpenZFSVolumeConfiguration`	`withCopyTagsToSnapshots(Boolean copyTagsToSnapshots)` A Boolean value indicating whether tags for the volume should be copied to snapshots.
`CreateOpenZFSVolumeConfiguration`	`withDataCompressionType(OpenZFSDataCompressionType dataCompressionType)` Specifies the method used to compress the data on the volume.
`CreateOpenZFSVolumeConfiguration`	`withDataCompressionType(String dataCompressionType)` Specifies the method used to compress the data on the volume.
`CreateOpenZFSVolumeConfiguration`	`withNfsExports(Collection<OpenZFSNfsExport> nfsExports)` The configuration object for mounting a Network File System (NFS) file system.
`CreateOpenZFSVolumeConfiguration`	`withNfsExports(OpenZFSNfsExport... nfsExports)` The configuration object for mounting a Network File System (NFS) file system.
`CreateOpenZFSVolumeConfiguration`	`withOriginSnapshot(CreateOpenZFSOriginSnapshotConfiguration originSnapshot)` The configuration object that specifies the snapshot to use as the origin of the data for the volume.
`CreateOpenZFSVolumeConfiguration`	`withParentVolumeId(String parentVolumeId)` The ID of the volume to use as the parent volume of the volume that you are creating.
`CreateOpenZFSVolumeConfiguration`	`withReadOnly(Boolean readOnly)` A Boolean value indicating whether the volume is read-only.
`CreateOpenZFSVolumeConfiguration`	`withRecordSizeKiB(Integer recordSizeKiB)` Specifies the suggested block size for a volume in a ZFS dataset, in kibibytes (KiB).
`CreateOpenZFSVolumeConfiguration`	`withStorageCapacityQuotaGiB(Integer storageCapacityQuotaGiB)` Sets the maximum storage size in gibibytes (GiB) for the volume.
`CreateOpenZFSVolumeConfiguration`	`withStorageCapacityReservationGiB(Integer storageCapacityReservationGiB)` Specifies the amount of storage in gibibytes (GiB) to reserve from the parent volume.
`CreateOpenZFSVolumeConfiguration`	`withUserAndGroupQuotas(Collection<OpenZFSUserOrGroupQuota> userAndGroupQuotas)` Configures how much storage users and groups can use on the volume.
`CreateOpenZFSVolumeConfiguration`	`withUserAndGroupQuotas(OpenZFSUserOrGroupQuota... userAndGroupQuotas)` Configures how much storage users and groups can use on the volume.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - CreateOpenZFSVolumeConfiguration
```
public CreateOpenZFSVolumeConfiguration()
```
- Method Detail
  - setParentVolumeId
```
public void setParentVolumeId(String parentVolumeId)
```
    The ID of the volume to use as the parent volume of the volume that you are creating.
    
    Parameters:
    
    parentVolumeId - The ID of the volume to use as the parent volume of the volume that you are creating.
  - getParentVolumeId
```
public String getParentVolumeId()
```
    The ID of the volume to use as the parent volume of the volume that you are creating.
    
    Returns:
    
    The ID of the volume to use as the parent volume of the volume that you are creating.
  - withParentVolumeId
```
public CreateOpenZFSVolumeConfiguration withParentVolumeId(String parentVolumeId)
```
    The ID of the volume to use as the parent volume of the volume that you are creating.
    
    Parameters:
    
    parentVolumeId - The ID of the volume to use as the parent volume of the volume that you are creating.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setStorageCapacityReservationGiB
```
public void setStorageCapacityReservationGiB(Integer 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.
    
    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.
  - getStorageCapacityReservationGiB
```
public Integer getStorageCapacityReservationGiB()
```
    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:
    
    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.
  - withStorageCapacityReservationGiB
```
public CreateOpenZFSVolumeConfiguration withStorageCapacityReservationGiB(Integer 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.
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setStorageCapacityQuotaGiB
```
public void setStorageCapacityQuotaGiB(Integer 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.
    
    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.
  - getStorageCapacityQuotaGiB
```
public Integer getStorageCapacityQuotaGiB()
```
    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:
    
    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.
  - withStorageCapacityQuotaGiB
```
public CreateOpenZFSVolumeConfiguration withStorageCapacityQuotaGiB(Integer 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.
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setRecordSizeKiB
```
public void setRecordSizeKiB(Integer recordSizeKiB)
```
    Specifies the suggested block size for a volume in a ZFS dataset, in kibibytes (KiB). Valid values are 4, 8, 16, 32, 64, 128, 256, 512, or 1024 KiB. The default is 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.
    
    Parameters:
    
    recordSizeKiB - Specifies the suggested block size for a volume in a ZFS dataset, in kibibytes (KiB). Valid values are 4, 8, 16, 32, 64, 128, 256, 512, or 1024 KiB. The default is 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.
  - getRecordSizeKiB
```
public Integer getRecordSizeKiB()
```
    Specifies the suggested block size for a volume in a ZFS dataset, in kibibytes (KiB). Valid values are 4, 8, 16, 32, 64, 128, 256, 512, or 1024 KiB. The default is 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:
    
    Specifies the suggested block size for a volume in a ZFS dataset, in kibibytes (KiB). Valid values are 4, 8, 16, 32, 64, 128, 256, 512, or 1024 KiB. The default is 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.
  - withRecordSizeKiB
```
public CreateOpenZFSVolumeConfiguration withRecordSizeKiB(Integer recordSizeKiB)
```
    Specifies the suggested block size for a volume in a ZFS dataset, in kibibytes (KiB). Valid values are 4, 8, 16, 32, 64, 128, 256, 512, or 1024 KiB. The default is 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.
    
    Parameters:
    
    recordSizeKiB - Specifies the suggested block size for a volume in a ZFS dataset, in kibibytes (KiB). Valid values are 4, 8, 16, 32, 64, 128, 256, 512, or 1024 KiB. The default is 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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDataCompressionType
```
public void setDataCompressionType(String 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. ZSTD compression provides a higher level of data compression and higher read throughput performance than LZ4 compression.
    - LZ4 - Compresses the data in the volume using the LZ4 compression algorithm. LZ4 compression provides a lower level of compression and higher write throughput performance than ZSTD compression.
    For more information about volume compression types and the performance of your Amazon FSx for OpenZFS file system, see Tips for maximizing performance File system and volume settings in the Amazon FSx for OpenZFS User Guide.
    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. ZSTD compression provides a higher level of data compression and higher read throughput performance than LZ4 compression.
    
    LZ4 - Compresses the data in the volume using the LZ4 compression algorithm. LZ4 compression provides a lower level of compression and higher write throughput performance than ZSTD compression.
    
    For more information about volume compression types and the performance of your Amazon FSx for OpenZFS file system, see Tips for maximizing performance File system and volume settings in the Amazon FSx for OpenZFS User Guide.
    See Also:
    
    OpenZFSDataCompressionType
  - getDataCompressionType
```
public String getDataCompressionType()
```
    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. ZSTD compression provides a higher level of data compression and higher read throughput performance than LZ4 compression.
    - LZ4 - Compresses the data in the volume using the LZ4 compression algorithm. LZ4 compression provides a lower level of compression and higher write throughput performance than ZSTD compression.
    For more information about volume compression types and the performance of your Amazon FSx for OpenZFS file system, see Tips for maximizing performance File system and volume settings in the Amazon FSx for OpenZFS User Guide.
    Returns:
    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. ZSTD compression provides a higher level of data compression and higher read throughput performance than LZ4 compression.
    
    LZ4 - Compresses the data in the volume using the LZ4 compression algorithm. LZ4 compression provides a lower level of compression and higher write throughput performance than ZSTD compression.
    
    For more information about volume compression types and the performance of your Amazon FSx for OpenZFS file system, see Tips for maximizing performance File system and volume settings in the Amazon FSx for OpenZFS User Guide.
    See Also:
    
    OpenZFSDataCompressionType
  - withDataCompressionType
```
public CreateOpenZFSVolumeConfiguration withDataCompressionType(String 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. ZSTD compression provides a higher level of data compression and higher read throughput performance than LZ4 compression.
    - LZ4 - Compresses the data in the volume using the LZ4 compression algorithm. LZ4 compression provides a lower level of compression and higher write throughput performance than ZSTD compression.
    For more information about volume compression types and the performance of your Amazon FSx for OpenZFS file system, see Tips for maximizing performance File system and volume settings in the Amazon FSx for OpenZFS User Guide.
    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. ZSTD compression provides a higher level of data compression and higher read throughput performance than LZ4 compression.
    
    LZ4 - Compresses the data in the volume using the LZ4 compression algorithm. LZ4 compression provides a lower level of compression and higher write throughput performance than ZSTD compression.
    
    For more information about volume compression types and the performance of your Amazon FSx for OpenZFS file system, see Tips for maximizing performance File system and volume settings in the Amazon FSx for OpenZFS User Guide.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    OpenZFSDataCompressionType
  - withDataCompressionType
```
public CreateOpenZFSVolumeConfiguration withDataCompressionType(OpenZFSDataCompressionType 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. ZSTD compression provides a higher level of data compression and higher read throughput performance than LZ4 compression.
    - LZ4 - Compresses the data in the volume using the LZ4 compression algorithm. LZ4 compression provides a lower level of compression and higher write throughput performance than ZSTD compression.
    For more information about volume compression types and the performance of your Amazon FSx for OpenZFS file system, see Tips for maximizing performance File system and volume settings in the Amazon FSx for OpenZFS User Guide.
    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. ZSTD compression provides a higher level of data compression and higher read throughput performance than LZ4 compression.
    
    LZ4 - Compresses the data in the volume using the LZ4 compression algorithm. LZ4 compression provides a lower level of compression and higher write throughput performance than ZSTD compression.
    
    For more information about volume compression types and the performance of your Amazon FSx for OpenZFS file system, see Tips for maximizing performance File system and volume settings in the Amazon FSx for OpenZFS User Guide.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    OpenZFSDataCompressionType
  - setCopyTagsToSnapshots
```
public void setCopyTagsToSnapshots(Boolean copyTagsToSnapshots)
```
    A Boolean value indicating whether tags for the volume should be copied to snapshots. This value defaults to false. If it's set to true, all tags for the volume are copied to snapshots where the user doesn't specify tags. If this value is true, and you specify one or more tags, only the specified tags are copied to snapshots. If you specify one or more tags when creating the snapshot, no tags are copied from the volume, regardless of this value.
    
    Parameters:
    
    copyTagsToSnapshots - A Boolean value indicating whether tags for the volume should be copied to snapshots. This value defaults to false. If it's set to true, all tags for the volume are copied to snapshots where the user doesn't specify tags. If this value is true, and you specify one or more tags, only the specified tags are copied to snapshots. If you specify one or more tags when creating the snapshot, no tags are copied from the volume, regardless of this value.
  - getCopyTagsToSnapshots
```
public Boolean getCopyTagsToSnapshots()
```
    A Boolean value indicating whether tags for the volume should be copied to snapshots. This value defaults to false. If it's set to true, all tags for the volume are copied to snapshots where the user doesn't specify tags. If this value is true, and you specify one or more tags, only the specified tags are copied to snapshots. If you specify one or more tags when creating the snapshot, no tags are copied from the volume, regardless of this value.
    
    Returns:
    
    A Boolean value indicating whether tags for the volume should be copied to snapshots. This value defaults to false. If it's set to true, all tags for the volume are copied to snapshots where the user doesn't specify tags. If this value is true, and you specify one or more tags, only the specified tags are copied to snapshots. If you specify one or more tags when creating the snapshot, no tags are copied from the volume, regardless of this value.
  - withCopyTagsToSnapshots
```
public CreateOpenZFSVolumeConfiguration withCopyTagsToSnapshots(Boolean copyTagsToSnapshots)
```
    A Boolean value indicating whether tags for the volume should be copied to snapshots. This value defaults to false. If it's set to true, all tags for the volume are copied to snapshots where the user doesn't specify tags. If this value is true, and you specify one or more tags, only the specified tags are copied to snapshots. If you specify one or more tags when creating the snapshot, no tags are copied from the volume, regardless of this value.
    
    Parameters:
    
    copyTagsToSnapshots - A Boolean value indicating whether tags for the volume should be copied to snapshots. This value defaults to false. If it's set to true, all tags for the volume are copied to snapshots where the user doesn't specify tags. If this value is true, and you specify one or more tags, only the specified tags are copied to snapshots. If you specify one or more tags when creating the snapshot, no tags are copied from the volume, regardless of this value.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isCopyTagsToSnapshots
```
public Boolean isCopyTagsToSnapshots()
```
    A Boolean value indicating whether tags for the volume should be copied to snapshots. This value defaults to false. If it's set to true, all tags for the volume are copied to snapshots where the user doesn't specify tags. If this value is true, and you specify one or more tags, only the specified tags are copied to snapshots. If you specify one or more tags when creating the snapshot, no tags are copied from the volume, regardless of this value.
    
    Returns:
    
    A Boolean value indicating whether tags for the volume should be copied to snapshots. This value defaults to false. If it's set to true, all tags for the volume are copied to snapshots where the user doesn't specify tags. If this value is true, and you specify one or more tags, only the specified tags are copied to snapshots. If you specify one or more tags when creating the snapshot, no tags are copied from the volume, regardless of this value.
  - setOriginSnapshot
```
public void setOriginSnapshot(CreateOpenZFSOriginSnapshotConfiguration originSnapshot)
```
    The configuration object that specifies the snapshot to use as the origin of the data for the volume.
    
    Parameters:
    
    originSnapshot - The configuration object that specifies the snapshot to use as the origin of the data for the volume.
  - getOriginSnapshot
```
public CreateOpenZFSOriginSnapshotConfiguration getOriginSnapshot()
```
    The configuration object that specifies the snapshot to use as the origin of the data for the volume.
    
    Returns:
    
    The configuration object that specifies the snapshot to use as the origin of the data for the volume.
  - withOriginSnapshot
```
public CreateOpenZFSVolumeConfiguration withOriginSnapshot(CreateOpenZFSOriginSnapshotConfiguration originSnapshot)
```
    The configuration object that specifies the snapshot to use as the origin of the data for the volume.
    
    Parameters:
    
    originSnapshot - The configuration object that specifies the snapshot to use as the origin of the data for the volume.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setReadOnly
```
public void setReadOnly(Boolean readOnly)
```
    A Boolean value indicating whether the volume is read-only.
    
    Parameters:
    
    readOnly - A Boolean value indicating whether the volume is read-only.
  - getReadOnly
```
public Boolean getReadOnly()
```
    A Boolean value indicating whether the volume is read-only.
    
    Returns:
    
    A Boolean value indicating whether the volume is read-only.
  - withReadOnly
```
public CreateOpenZFSVolumeConfiguration withReadOnly(Boolean readOnly)
```
    A Boolean value indicating whether the volume is read-only.
    
    Parameters:
    
    readOnly - A Boolean value indicating whether the volume is read-only.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isReadOnly
```
public Boolean isReadOnly()
```
    A Boolean value indicating whether the volume is read-only.
    
    Returns:
    
    A Boolean value indicating whether the volume is read-only.
  - getNfsExports
```
public List<OpenZFSNfsExport> getNfsExports()
```
    The configuration object for mounting a Network File System (NFS) file system.
    
    Returns:
    
    The configuration object for mounting a Network File System (NFS) file system.
  - setNfsExports
```
public void setNfsExports(Collection<OpenZFSNfsExport> nfsExports)
```
    The configuration object for mounting a Network File System (NFS) file system.
    
    Parameters:
    
    nfsExports - The configuration object for mounting a Network File System (NFS) file system.
  - withNfsExports
```
public CreateOpenZFSVolumeConfiguration withNfsExports(OpenZFSNfsExport... nfsExports)
```
    The configuration object for mounting a Network File System (NFS) file system.
    
    NOTE: This method appends the values to the existing list (if any). Use setNfsExports(java.util.Collection) or withNfsExports(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    nfsExports - The configuration object for mounting a Network File System (NFS) file system.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withNfsExports
```
public CreateOpenZFSVolumeConfiguration withNfsExports(Collection<OpenZFSNfsExport> nfsExports)
```
    The configuration object for mounting a Network File System (NFS) file system.
    
    Parameters:
    
    nfsExports - The configuration object for mounting a Network File System (NFS) file system.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getUserAndGroupQuotas
```
public List<OpenZFSUserOrGroupQuota> getUserAndGroupQuotas()
```
    Configures how much storage users and groups can use on the volume.
    
    Returns:
    
    Configures how much storage users and groups can use on the volume.
  - setUserAndGroupQuotas
```
public void setUserAndGroupQuotas(Collection<OpenZFSUserOrGroupQuota> userAndGroupQuotas)
```
    Configures how much storage users and groups can use on the volume.
    
    Parameters:
    
    userAndGroupQuotas - Configures how much storage users and groups can use on the volume.
  - withUserAndGroupQuotas
```
public CreateOpenZFSVolumeConfiguration withUserAndGroupQuotas(OpenZFSUserOrGroupQuota... userAndGroupQuotas)
```
    Configures how much storage users and groups can use on the volume.
    
    NOTE: This method appends the values to the existing list (if any). Use setUserAndGroupQuotas(java.util.Collection) or withUserAndGroupQuotas(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    userAndGroupQuotas - Configures how much storage users and groups can use on the volume.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withUserAndGroupQuotas
```
public CreateOpenZFSVolumeConfiguration withUserAndGroupQuotas(Collection<OpenZFSUserOrGroupQuota> userAndGroupQuotas)
```
    Configures how much storage users and groups can use on the volume.
    
    Parameters:
    
    userAndGroupQuotas - Configures how much storage users and groups can use on the volume.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public CreateOpenZFSVolumeConfiguration clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

AWS SDK for Java 1.x API Reference - 1.12.773

Class CreateOpenZFSVolumeConfiguration

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

CreateOpenZFSVolumeConfiguration

Method Detail

setParentVolumeId

getParentVolumeId

withParentVolumeId

setStorageCapacityReservationGiB

getStorageCapacityReservationGiB

withStorageCapacityReservationGiB

setStorageCapacityQuotaGiB

getStorageCapacityQuotaGiB

withStorageCapacityQuotaGiB

setRecordSizeKiB

getRecordSizeKiB

withRecordSizeKiB

setDataCompressionType

getDataCompressionType

withDataCompressionType

withDataCompressionType

setCopyTagsToSnapshots

getCopyTagsToSnapshots

withCopyTagsToSnapshots

isCopyTagsToSnapshots

setOriginSnapshot

getOriginSnapshot

withOriginSnapshot

setReadOnly

getReadOnly

withReadOnly

isReadOnly

getNfsExports

setNfsExports

withNfsExports

withNfsExports

getUserAndGroupQuotas

setUserAndGroupQuotas

withUserAndGroupQuotas

withUserAndGroupQuotas

toString

equals

hashCode

clone

marshall