software.amazon.awssdk.services.fsx.model

Class CreateFileSystemOpenZFSConfiguration

java.lang.Object

software.amazon.awssdk.services.fsx.model.CreateFileSystemOpenZFSConfiguration

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<CreateFileSystemOpenZFSConfiguration.Builder,CreateFileSystemOpenZFSConfiguration>

@Generated(value="software.amazon.awssdk:codegen")
public final class CreateFileSystemOpenZFSConfiguration
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<CreateFileSystemOpenZFSConfiguration.Builder,CreateFileSystemOpenZFSConfiguration>

The Amazon FSx for OpenZFS configuration properties for the file system that you are creating.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CreateFileSystemOpenZFSConfiguration.Builder

Method Summary

Modifier and Type	Method and Description
Integer	automaticBackupRetentionDays() Returns the value of the AutomaticBackupRetentionDays property for this object.
static CreateFileSystemOpenZFSConfiguration.Builder	builder()
Boolean	copyTagsToBackups() A Boolean value indicating whether tags for the file system should be copied to backups.
Boolean	copyTagsToVolumes() A Boolean value indicating whether tags for the file system should be copied to volumes.
String	dailyAutomaticBackupStartTime() Returns the value of the DailyAutomaticBackupStartTime property for this object.
OpenZFSDeploymentType	deploymentType() Specifies the file system deployment type.
String	deploymentTypeAsString() Specifies the file system deployment type.
DiskIopsConfiguration	diskIopsConfiguration() Returns the value of the DiskIopsConfiguration property for this object.
String	endpointIpAddressRange() (Multi-AZ only) Specifies the IP address range in which the endpoints to access your file system will be created.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasRouteTableIds() For responses, this returns true if the service returned a value for the RouteTableIds property.
String	preferredSubnetId() Required when DeploymentType is set to MULTI_AZ_1.
OpenZFSCreateRootVolumeConfiguration	rootVolumeConfiguration() The configuration Amazon FSx uses when creating the root value of the Amazon FSx for OpenZFS file system.
List<String>	routeTableIds() (Multi-AZ only) Specifies the route tables in which Amazon FSx creates the rules for routing traffic to the correct file server.
List<SdkField<?>>	sdkFields()
static Class<? extends CreateFileSystemOpenZFSConfiguration.Builder>	serializableBuilderClass()
Integer	throughputCapacity() Specifies the throughput of an Amazon FSx for OpenZFS file system, measured in megabytes per second (MBps).
CreateFileSystemOpenZFSConfiguration.Builder	toBuilder()
String	toString() Returns a string representation of this object.
String	weeklyMaintenanceStartTime() Returns the value of the WeeklyMaintenanceStartTime property for this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

automaticBackupRetentionDays

public final Integer automaticBackupRetentionDays()

Returns the value of the AutomaticBackupRetentionDays property for this object.

Returns:

The value of the AutomaticBackupRetentionDays property for this object.

copyTagsToBackups

public final Boolean copyTagsToBackups()

A Boolean value indicating whether tags for the file system should be copied to backups. This value defaults to false. If it's set to true, all tags for the file system are copied to all automatic and user-initiated backups 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 backups. If you specify one or more tags when creating a user-initiated backup, no tags are copied from the file system, regardless of this value.

Returns:

A Boolean value indicating whether tags for the file system should be copied to backups. This value defaults to false. If it's set to true, all tags for the file system are copied to all automatic and user-initiated backups 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 backups. If you specify one or more tags when creating a user-initiated backup, no tags are copied from the file system, regardless of this value.

copyTagsToVolumes

public final Boolean copyTagsToVolumes()

A Boolean value indicating whether tags for the file system should be copied to volumes. This value defaults to false. If it's set to true, all tags for the file system are copied to volumes 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 volumes. If you specify one or more tags when creating the volume, no tags are copied from the file system, regardless of this value.

Returns:

A Boolean value indicating whether tags for the file system should be copied to volumes. This value defaults to false. If it's set to true, all tags for the file system are copied to volumes 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 volumes. If you specify one or more tags when creating the volume, no tags are copied from the file system, regardless of this value.

dailyAutomaticBackupStartTime

public final String dailyAutomaticBackupStartTime()

Returns the value of the DailyAutomaticBackupStartTime property for this object.

Returns:

The value of the DailyAutomaticBackupStartTime property for this object.

deploymentType

public final OpenZFSDeploymentType deploymentType()

Specifies the file system deployment type. Single AZ deployment types are configured for redundancy within a single Availability Zone in an Amazon Web Services Region . Valid values are the following:

• MULTI_AZ_1- Creates file systems with high availability that are configured for Multi-AZ redundancy to tolerate temporary unavailability in Availability Zones (AZs). Multi_AZ_1 is available only in the US East (N. Virginia), US East (Ohio), US West (Oregon), Asia Pacific (Singapore), Asia Pacific (Tokyo), and Europe (Ireland) Amazon Web Services Regions.

• SINGLE_AZ_1- Creates file systems with throughput capacities of 64 - 4,096 MB/s. Single_AZ_1 is available in all Amazon Web Services Regions where Amazon FSx for OpenZFS is available.

• SINGLE_AZ_2- Creates file systems with throughput capacities of 160 - 10,240 MB/s using an NVMe L2ARC cache. Single_AZ_2 is available only in the US East (N. Virginia), US East (Ohio), US West (Oregon), Asia Pacific (Singapore), Asia Pacific (Tokyo), and Europe (Ireland) Amazon Web Services Regions.

For more information, see Deployment type availability and File system performance in the Amazon FSx for OpenZFS User Guide.

If the service returns an enum value that is not available in the current SDK version, deploymentType will return OpenZFSDeploymentType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from deploymentTypeAsString().

Returns:

Specifies the file system deployment type. Single AZ deployment types are configured for redundancy within a single Availability Zone in an Amazon Web Services Region . Valid values are the following:

• MULTI_AZ_1- Creates file systems with high availability that are configured for Multi-AZ redundancy to tolerate temporary unavailability in Availability Zones (AZs). Multi_AZ_1 is available only in the US East (N. Virginia), US East (Ohio), US West (Oregon), Asia Pacific (Singapore), Asia Pacific (Tokyo), and Europe (Ireland) Amazon Web Services Regions.

• SINGLE_AZ_1- Creates file systems with throughput capacities of 64 - 4,096 MB/s. Single_AZ_1 is available in all Amazon Web Services Regions where Amazon FSx for OpenZFS is available.

• SINGLE_AZ_2- Creates file systems with throughput capacities of 160 - 10,240 MB/s using an NVMe L2ARC cache. Single_AZ_2 is available only in the US East (N. Virginia), US East (Ohio), US West (Oregon), Asia Pacific (Singapore), Asia Pacific (Tokyo), and Europe (Ireland) Amazon Web Services Regions.

For more information, see Deployment type availability and File system performance in the Amazon FSx for OpenZFS User Guide.

See Also:

OpenZFSDeploymentType

deploymentTypeAsString

public final String deploymentTypeAsString()

Specifies the file system deployment type. Single AZ deployment types are configured for redundancy within a single Availability Zone in an Amazon Web Services Region . Valid values are the following:

• MULTI_AZ_1- Creates file systems with high availability that are configured for Multi-AZ redundancy to tolerate temporary unavailability in Availability Zones (AZs). Multi_AZ_1 is available only in the US East (N. Virginia), US East (Ohio), US West (Oregon), Asia Pacific (Singapore), Asia Pacific (Tokyo), and Europe (Ireland) Amazon Web Services Regions.

• SINGLE_AZ_1- Creates file systems with throughput capacities of 64 - 4,096 MB/s. Single_AZ_1 is available in all Amazon Web Services Regions where Amazon FSx for OpenZFS is available.

• SINGLE_AZ_2- Creates file systems with throughput capacities of 160 - 10,240 MB/s using an NVMe L2ARC cache. Single_AZ_2 is available only in the US East (N. Virginia), US East (Ohio), US West (Oregon), Asia Pacific (Singapore), Asia Pacific (Tokyo), and Europe (Ireland) Amazon Web Services Regions.

For more information, see Deployment type availability and File system performance in the Amazon FSx for OpenZFS User Guide.

If the service returns an enum value that is not available in the current SDK version, deploymentType will return OpenZFSDeploymentType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from deploymentTypeAsString().

Returns:

Specifies the file system deployment type. Single AZ deployment types are configured for redundancy within a single Availability Zone in an Amazon Web Services Region . Valid values are the following:

• MULTI_AZ_1- Creates file systems with high availability that are configured for Multi-AZ redundancy to tolerate temporary unavailability in Availability Zones (AZs). Multi_AZ_1 is available only in the US East (N. Virginia), US East (Ohio), US West (Oregon), Asia Pacific (Singapore), Asia Pacific (Tokyo), and Europe (Ireland) Amazon Web Services Regions.

• SINGLE_AZ_1- Creates file systems with throughput capacities of 64 - 4,096 MB/s. Single_AZ_1 is available in all Amazon Web Services Regions where Amazon FSx for OpenZFS is available.

• SINGLE_AZ_2- Creates file systems with throughput capacities of 160 - 10,240 MB/s using an NVMe L2ARC cache. Single_AZ_2 is available only in the US East (N. Virginia), US East (Ohio), US West (Oregon), Asia Pacific (Singapore), Asia Pacific (Tokyo), and Europe (Ireland) Amazon Web Services Regions.

For more information, see Deployment type availability and File system performance in the Amazon FSx for OpenZFS User Guide.

See Also:

OpenZFSDeploymentType

throughputCapacity

public final Integer throughputCapacity()

Specifies the throughput of an Amazon FSx for OpenZFS file system, measured in megabytes per second (MBps). Valid values depend on the DeploymentType you choose, as follows:

• For MULTI_AZ_1 and SINGLE_AZ_2, valid values are 160, 320, 640, 1280, 2560, 3840, 5120, 7680, or 10240 MBps.

• For SINGLE_AZ_1, valid values are 64, 128, 256, 512, 1024, 2048, 3072, or 4096 MBps.

You pay for additional throughput capacity that you provision.

Returns:

Specifies the throughput of an Amazon FSx for OpenZFS file system, measured in megabytes per second (MBps). Valid values depend on the DeploymentType you choose, as follows:

• For MULTI_AZ_1 and SINGLE_AZ_2, valid values are 160, 320, 640, 1280, 2560, 3840, 5120, 7680, or 10240 MBps.

• For SINGLE_AZ_1, valid values are 64, 128, 256, 512, 1024, 2048, 3072, or 4096 MBps.

You pay for additional throughput capacity that you provision.

weeklyMaintenanceStartTime

public final String weeklyMaintenanceStartTime()

Returns the value of the WeeklyMaintenanceStartTime property for this object.

Returns:

The value of the WeeklyMaintenanceStartTime property for this object.

diskIopsConfiguration

public final DiskIopsConfiguration diskIopsConfiguration()

Returns the value of the DiskIopsConfiguration property for this object.

Returns:

The value of the DiskIopsConfiguration property for this object.

rootVolumeConfiguration

public final OpenZFSCreateRootVolumeConfiguration rootVolumeConfiguration()

The configuration Amazon FSx uses when creating the root value of the Amazon FSx for OpenZFS file system. All volumes are children of the root volume.

Returns:

The configuration Amazon FSx uses when creating the root value of the Amazon FSx for OpenZFS file system. All volumes are children of the root volume.

preferredSubnetId

public final String preferredSubnetId()

Required when DeploymentType is set to MULTI_AZ_1. This specifies the subnet in which you want the preferred file server to be located.

Returns:

Required when DeploymentType is set to MULTI_AZ_1. This specifies the subnet in which you want the preferred file server to be located.

endpointIpAddressRange

public final String endpointIpAddressRange()

(Multi-AZ only) Specifies the IP address range in which the endpoints to access your file system will be created. By default in the Amazon FSx API and Amazon FSx console, Amazon FSx selects an available /28 IP address range for you from one of the VPC's CIDR ranges. You can have overlapping endpoint IP addresses for file systems deployed in the same VPC/route tables.

Returns:

(Multi-AZ only) Specifies the IP address range in which the endpoints to access your file system will be created. By default in the Amazon FSx API and Amazon FSx console, Amazon FSx selects an available /28 IP address range for you from one of the VPC's CIDR ranges. You can have overlapping endpoint IP addresses for file systems deployed in the same VPC/route tables.

hasRouteTableIds

public final boolean hasRouteTableIds()

For responses, this returns true if the service returned a value for the RouteTableIds property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

routeTableIds

public final List<String> routeTableIds()

(Multi-AZ only) Specifies the route tables in which Amazon FSx creates the rules for routing traffic to the correct file server. You should specify all virtual private cloud (VPC) route tables associated with the subnets in which your clients are located. By default, Amazon FSx selects your VPC's default route table.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasRouteTableIds() method.

Returns:

(Multi-AZ only) Specifies the route tables in which Amazon FSx creates the rules for routing traffic to the correct file server. You should specify all virtual private cloud (VPC) route tables associated with the subnets in which your clients are located. By default, Amazon FSx selects your VPC's default route table.

toBuilder

public CreateFileSystemOpenZFSConfiguration.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateFileSystemOpenZFSConfiguration.Builder,CreateFileSystemOpenZFSConfiguration>

builder

public static CreateFileSystemOpenZFSConfiguration.Builder builder()

serializableBuilderClass

public static Class<? extends CreateFileSystemOpenZFSConfiguration.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final 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

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo