Interface OpenZFSFileSystemConfiguration.Builder

All Superinterfaces:
Buildable, CopyableBuilder<OpenZFSFileSystemConfiguration.Builder,OpenZFSFileSystemConfiguration>, SdkBuilder<OpenZFSFileSystemConfiguration.Builder,OpenZFSFileSystemConfiguration>, SdkPojo
Enclosing class:
OpenZFSFileSystemConfiguration
@Mutable @NotThreadSafe public static interface OpenZFSFileSystemConfiguration.Builder extends SdkPojo, CopyableBuilder<OpenZFSFileSystemConfiguration.Builder,OpenZFSFileSystemConfiguration>

  • Method Details

    • automaticBackupRetentionDays

      OpenZFSFileSystemConfiguration.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

      OpenZFSFileSystemConfiguration.Builder copyTagsToBackups(Boolean copyTagsToBackups)

      A Boolean value indicating whether tags on the file system should be copied to backups. If it's set to true, all tags on the file system are copied to all automatic backups and any user-initiated backups where the user doesn't specify any 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 on the file system should be copied to backups. If it's set to true, all tags on the file system are copied to all automatic backups and any user-initiated backups where the user doesn't specify any 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

      OpenZFSFileSystemConfiguration.Builder copyTagsToVolumes(Boolean copyTagsToVolumes)

      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:
      copyTagsToVolumes - 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.

    • dailyAutomaticBackupStartTime

      OpenZFSFileSystemConfiguration.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

      OpenZFSFileSystemConfiguration.Builder deploymentType(String deploymentType)

      Specifies the file-system deployment type. Amazon FSx for OpenZFS supports
 MULTI_AZ_1, SINGLE_AZ_HA_2, SINGLE_AZ_HA_1, SINGLE_AZ_2, and SINGLE_AZ_1.

      Parameters:
      deploymentType - Specifies the file-system deployment type. Amazon FSx for OpenZFS supports
 MULTI_AZ_1, SINGLE_AZ_HA_2, SINGLE_AZ_HA_1, SINGLE_AZ_2, and SINGLE_AZ_1.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • deploymentType

      OpenZFSFileSystemConfiguration.Builder deploymentType(OpenZFSDeploymentType deploymentType)

      Specifies the file-system deployment type. Amazon FSx for OpenZFS supports
 MULTI_AZ_1, SINGLE_AZ_HA_2, SINGLE_AZ_HA_1, SINGLE_AZ_2, and SINGLE_AZ_1.

      Parameters:
      deploymentType - Specifies the file-system deployment type. Amazon FSx for OpenZFS supports
 MULTI_AZ_1, SINGLE_AZ_HA_2, SINGLE_AZ_HA_1, SINGLE_AZ_2, and SINGLE_AZ_1.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • throughputCapacity

      OpenZFSFileSystemConfiguration.Builder throughputCapacity(Integer throughputCapacity)

      The throughput of an Amazon FSx file system, measured in megabytes per second (MBps).

      Parameters:
      throughputCapacity - The throughput of an Amazon FSx file system, measured in megabytes per second (MBps).
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • weeklyMaintenanceStartTime

      OpenZFSFileSystemConfiguration.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

      OpenZFSFileSystemConfiguration.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 OpenZFSFileSystemConfiguration.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:

    • rootVolumeId

      OpenZFSFileSystemConfiguration.Builder rootVolumeId(String rootVolumeId)

      The ID of the root volume of the OpenZFS file system.

      Parameters:
      rootVolumeId - The ID of the root volume of the OpenZFS file system.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • preferredSubnetId

      OpenZFSFileSystemConfiguration.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

      OpenZFSFileSystemConfiguration.Builder endpointIpAddressRange(String endpointIpAddressRange)

      (Multi-AZ only) Specifies the IPv4 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 IPv4 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.

    • endpointIpv6AddressRange

      OpenZFSFileSystemConfiguration.Builder endpointIpv6AddressRange(String endpointIpv6AddressRange)

      (Multi-AZ only) Specifies the IPv6 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 /118 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, as long as they don't overlap with any subnet.

      Parameters:
      endpointIpv6AddressRange - (Multi-AZ only) Specifies the IPv6 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 /118 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, as long as they don't overlap with any subnet.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • routeTableIds

      OpenZFSFileSystemConfiguration.Builder routeTableIds(Collection<String> routeTableIds)

      (Multi-AZ only) The VPC route tables in which your file system's endpoints are created.

      Parameters:
      routeTableIds - (Multi-AZ only) The VPC route tables in which your file system's endpoints are created.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • routeTableIds

      OpenZFSFileSystemConfiguration.Builder routeTableIds(String... routeTableIds)

      (Multi-AZ only) The VPC route tables in which your file system's endpoints are created.

      Parameters:
      routeTableIds - (Multi-AZ only) The VPC route tables in which your file system's endpoints are created.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • endpointIpAddress

      OpenZFSFileSystemConfiguration.Builder endpointIpAddress(String endpointIpAddress)

      The IPv4 address of the endpoint that is used to access data or to manage the file system.

      Parameters:
      endpointIpAddress - The IPv4 address of the endpoint that is used to access data or to manage the file system.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • endpointIpv6Address

      OpenZFSFileSystemConfiguration.Builder endpointIpv6Address(String endpointIpv6Address)

      The IPv6 address of the endpoint that is used to access data or to manage the file system.

      Parameters:
      endpointIpv6Address - The IPv6 address of the endpoint that is used to access data or to manage the file system.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • readCacheConfiguration

      OpenZFSFileSystemConfiguration.Builder readCacheConfiguration(OpenZFSReadCacheConfiguration readCacheConfiguration)

      Required when StorageType is set to INTELLIGENT_TIERING. Specifies the optional provisioned SSD read cache.

      Parameters:
      readCacheConfiguration - Required when StorageType is set to INTELLIGENT_TIERING. Specifies the optional provisioned SSD read cache.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • readCacheConfiguration

      default OpenZFSFileSystemConfiguration.Builder readCacheConfiguration(Consumer<OpenZFSReadCacheConfiguration.Builder> readCacheConfiguration)

      Required when StorageType is set to INTELLIGENT_TIERING. Specifies the optional provisioned SSD read cache.

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

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

      Parameters:
      readCacheConfiguration - a consumer that will call methods on OpenZFSReadCacheConfiguration.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also: