software.amazon.awssdk.services.fsx.model

Interface CreateFileSystemOpenZFSConfiguration.Builder

All Superinterfaces:

Buildable, CopyableBuilder<CreateFileSystemOpenZFSConfiguration.Builder,CreateFileSystemOpenZFSConfiguration>, SdkBuilder<CreateFileSystemOpenZFSConfiguration.Builder,CreateFileSystemOpenZFSConfiguration>, SdkPojo

Enclosing class:

CreateFileSystemOpenZFSConfiguration

public static interface CreateFileSystemOpenZFSConfiguration.Builder
extends SdkPojo, CopyableBuilder<CreateFileSystemOpenZFSConfiguration.Builder,CreateFileSystemOpenZFSConfiguration>

Method Summary

Modifier and Type	Method and Description
CreateFileSystemOpenZFSConfiguration.Builder	automaticBackupRetentionDays(Integer automaticBackupRetentionDays) Sets the value of the AutomaticBackupRetentionDays property for this object.
CreateFileSystemOpenZFSConfiguration.Builder	copyTagsToBackups(Boolean copyTagsToBackups) A Boolean value indicating whether tags for the file system should be copied to backups.
CreateFileSystemOpenZFSConfiguration.Builder	copyTagsToVolumes(Boolean copyTagsToVolumes) A Boolean value indicating whether tags for the file system should be copied to volumes.
CreateFileSystemOpenZFSConfiguration.Builder	dailyAutomaticBackupStartTime(String dailyAutomaticBackupStartTime) Sets the value of the DailyAutomaticBackupStartTime property for this object.
CreateFileSystemOpenZFSConfiguration.Builder	deploymentType(OpenZFSDeploymentType deploymentType) Specifies the file system deployment type.
CreateFileSystemOpenZFSConfiguration.Builder	deploymentType(String deploymentType) Specifies the file system deployment type.
default CreateFileSystemOpenZFSConfiguration.Builder	diskIopsConfiguration(Consumer<DiskIopsConfiguration.Builder> diskIopsConfiguration) Sets the value of the DiskIopsConfiguration property for this object.
CreateFileSystemOpenZFSConfiguration.Builder	diskIopsConfiguration(DiskIopsConfiguration diskIopsConfiguration) Sets the value of the DiskIopsConfiguration property for this object.
CreateFileSystemOpenZFSConfiguration.Builder	endpointIpAddressRange(String endpointIpAddressRange) (Multi-AZ only) Specifies the IP address range in which the endpoints to access your file system will be created.
CreateFileSystemOpenZFSConfiguration.Builder	preferredSubnetId(String preferredSubnetId) Required when DeploymentType is set to MULTI_AZ_1.
default CreateFileSystemOpenZFSConfiguration.Builder	rootVolumeConfiguration(Consumer<OpenZFSCreateRootVolumeConfiguration.Builder> rootVolumeConfiguration) The configuration Amazon FSx uses when creating the root value of the Amazon FSx for OpenZFS file system.
CreateFileSystemOpenZFSConfiguration.Builder	rootVolumeConfiguration(OpenZFSCreateRootVolumeConfiguration rootVolumeConfiguration) The configuration Amazon FSx uses when creating the root value of the Amazon FSx for OpenZFS file system.
CreateFileSystemOpenZFSConfiguration.Builder	routeTableIds(Collection<String> routeTableIds) (Multi-AZ only) Specifies the route tables in which Amazon FSx creates the rules for routing traffic to the correct file server.
CreateFileSystemOpenZFSConfiguration.Builder	routeTableIds(String... routeTableIds) (Multi-AZ only) Specifies the route tables in which Amazon FSx creates the rules for routing traffic to the correct file server.
CreateFileSystemOpenZFSConfiguration.Builder	throughputCapacity(Integer throughputCapacity) Specifies the throughput of an Amazon FSx for OpenZFS file system, measured in megabytes per second (MBps).
CreateFileSystemOpenZFSConfiguration.Builder	weeklyMaintenanceStartTime(String weeklyMaintenanceStartTime) Sets the value of the WeeklyMaintenanceStartTime property for this object.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

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

copy

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

applyMutation, build

Method Detail

automaticBackupRetentionDays

CreateFileSystemOpenZFSConfiguration.Builder automaticBackupRetentionDays(Integer automaticBackupRetentionDays)

Sets the value of the AutomaticBackupRetentionDays property for this object.

Parameters:

automaticBackupRetentionDays - The new value for the AutomaticBackupRetentionDays property for this object.

Returns:

Returns a reference to this object so that method calls can be chained together.

copyTagsToBackups

CreateFileSystemOpenZFSConfiguration.Builder copyTagsToBackups(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

copyTagsToVolumes

CreateFileSystemOpenZFSConfiguration.Builder copyTagsToVolumes(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

dailyAutomaticBackupStartTime

CreateFileSystemOpenZFSConfiguration.Builder dailyAutomaticBackupStartTime(String dailyAutomaticBackupStartTime)

Sets the value of the DailyAutomaticBackupStartTime property for this object.

Parameters:

dailyAutomaticBackupStartTime - The new value for the DailyAutomaticBackupStartTime property for this object.

Returns:

Returns a reference to this object so that method calls can be chained together.

deploymentType

CreateFileSystemOpenZFSConfiguration.Builder deploymentType(String 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

OpenZFSDeploymentType, OpenZFSDeploymentType

deploymentType

CreateFileSystemOpenZFSConfiguration.Builder deploymentType(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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

OpenZFSDeploymentType, OpenZFSDeploymentType

throughputCapacity

CreateFileSystemOpenZFSConfiguration.Builder throughputCapacity(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

weeklyMaintenanceStartTime

CreateFileSystemOpenZFSConfiguration.Builder weeklyMaintenanceStartTime(String weeklyMaintenanceStartTime)

Sets the value of the WeeklyMaintenanceStartTime property for this object.

Parameters:

weeklyMaintenanceStartTime - The new value for the WeeklyMaintenanceStartTime property for this object.

Returns:

Returns a reference to this object so that method calls can be chained together.

diskIopsConfiguration

CreateFileSystemOpenZFSConfiguration.Builder diskIopsConfiguration(DiskIopsConfiguration diskIopsConfiguration)

Sets the value of the DiskIopsConfiguration property for this object.

Parameters:

diskIopsConfiguration - The new value for the DiskIopsConfiguration property for this object.

Returns:

Returns a reference to this object so that method calls can be chained together.

diskIopsConfiguration

default CreateFileSystemOpenZFSConfiguration.Builder diskIopsConfiguration(Consumer<DiskIopsConfiguration.Builder> diskIopsConfiguration)

Sets the value of the DiskIopsConfiguration property for this object. This is a convenience method that creates an instance of the DiskIopsConfiguration.Builder avoiding the need to create one manually via DiskIopsConfiguration.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to diskIopsConfiguration(DiskIopsConfiguration).

Parameters:

diskIopsConfiguration - a consumer that will call methods on DiskIopsConfiguration.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

diskIopsConfiguration(DiskIopsConfiguration)

rootVolumeConfiguration

CreateFileSystemOpenZFSConfiguration.Builder rootVolumeConfiguration(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

rootVolumeConfiguration

default CreateFileSystemOpenZFSConfiguration.Builder rootVolumeConfiguration(Consumer<OpenZFSCreateRootVolumeConfiguration.Builder> 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.

This is a convenience method that creates an instance of the OpenZFSCreateRootVolumeConfiguration.Builder avoiding the need to create one manually via OpenZFSCreateRootVolumeConfiguration.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to rootVolumeConfiguration(OpenZFSCreateRootVolumeConfiguration).

Parameters:

rootVolumeConfiguration - a consumer that will call methods on OpenZFSCreateRootVolumeConfiguration.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

rootVolumeConfiguration(OpenZFSCreateRootVolumeConfiguration)

preferredSubnetId

CreateFileSystemOpenZFSConfiguration.Builder preferredSubnetId(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

endpointIpAddressRange

CreateFileSystemOpenZFSConfiguration.Builder endpointIpAddressRange(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

routeTableIds

CreateFileSystemOpenZFSConfiguration.Builder routeTableIds(Collection<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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

routeTableIds

CreateFileSystemOpenZFSConfiguration.Builder routeTableIds(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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.