Package software.amazon.awssdk.services.fsx.model

Interface CreateFileSystemOntapConfiguration.Builder

All Superinterfaces:
Buildable, CopyableBuilder<CreateFileSystemOntapConfiguration.Builder,CreateFileSystemOntapConfiguration>, SdkBuilder<CreateFileSystemOntapConfiguration.Builder,CreateFileSystemOntapConfiguration>, SdkPojo
Enclosing class:
CreateFileSystemOntapConfiguration
public static interface CreateFileSystemOntapConfiguration.Builder extends SdkPojo, CopyableBuilder<CreateFileSystemOntapConfiguration.Builder,CreateFileSystemOntapConfiguration>

  • Method Details

    • automaticBackupRetentionDays

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

    • dailyAutomaticBackupStartTime

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

      CreateFileSystemOntapConfiguration.Builder deploymentType(String deploymentType)

      Specifies the FSx for ONTAP file system deployment type to use in creating the file system.

      • MULTI_AZ_1 - (Default) A high availability file system configured for Multi-AZ redundancy to tolerate temporary Availability Zone (AZ) unavailability.

      • SINGLE_AZ_1 - A file system configured for Single-AZ redundancy.

      • SINGLE_AZ_2 - A file system configured with multiple high-availability (HA) pairs for Single-AZ redundancy.

      For information about the use cases for Multi-AZ and Single-AZ deployments, refer to Choosing a file system deployment type.

      Parameters:
      deploymentType - Specifies the FSx for ONTAP file system deployment type to use in creating the file system.

      • MULTI_AZ_1 - (Default) A high availability file system configured for Multi-AZ redundancy to tolerate temporary Availability Zone (AZ) unavailability.

      • SINGLE_AZ_1 - A file system configured for Single-AZ redundancy.

      • SINGLE_AZ_2 - A file system configured with multiple high-availability (HA) pairs for Single-AZ redundancy.

      For information about the use cases for Multi-AZ and Single-AZ deployments, refer to Choosing a file system deployment type.

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

    • deploymentType

      CreateFileSystemOntapConfiguration.Builder deploymentType(OntapDeploymentType deploymentType)

      Specifies the FSx for ONTAP file system deployment type to use in creating the file system.

      • MULTI_AZ_1 - (Default) A high availability file system configured for Multi-AZ redundancy to tolerate temporary Availability Zone (AZ) unavailability.

      • SINGLE_AZ_1 - A file system configured for Single-AZ redundancy.

      • SINGLE_AZ_2 - A file system configured with multiple high-availability (HA) pairs for Single-AZ redundancy.

      For information about the use cases for Multi-AZ and Single-AZ deployments, refer to Choosing a file system deployment type.

      Parameters:
      deploymentType - Specifies the FSx for ONTAP file system deployment type to use in creating the file system.

      • MULTI_AZ_1 - (Default) A high availability file system configured for Multi-AZ redundancy to tolerate temporary Availability Zone (AZ) unavailability.

      • SINGLE_AZ_1 - A file system configured for Single-AZ redundancy.

      • SINGLE_AZ_2 - A file system configured with multiple high-availability (HA) pairs for Single-AZ redundancy.

      For information about the use cases for Multi-AZ and Single-AZ deployments, refer to Choosing a file system deployment type.

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

    • endpointIpAddressRange

      CreateFileSystemOntapConfiguration.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, Amazon FSx selects an unused IP address range for you from the 198.19.* range. By default in the Amazon FSx console, Amazon FSx chooses the last 64 IP addresses from the VPC’s primary CIDR range to use as the endpoint IP address range for the file system. 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:
      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, Amazon FSx selects an unused IP address range for you from the 198.19.* range. By default in the Amazon FSx console, Amazon FSx chooses the last 64 IP addresses from the VPC’s primary CIDR range to use as the endpoint IP address range for the file system. 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.

    • fsxAdminPassword

      CreateFileSystemOntapConfiguration.Builder fsxAdminPassword(String fsxAdminPassword)

      The ONTAP administrative password for the fsxadmin user with which you administer your file system using the NetApp ONTAP CLI and REST API.

      Parameters:
      fsxAdminPassword - The ONTAP administrative password for the fsxadmin user with which you administer your file system using the NetApp ONTAP CLI and REST API.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • diskIopsConfiguration

      CreateFileSystemOntapConfiguration.Builder diskIopsConfiguration(DiskIopsConfiguration diskIopsConfiguration)

      The SSD IOPS configuration for the FSx for ONTAP file system.

      Parameters:
      diskIopsConfiguration - The SSD IOPS configuration for the FSx for ONTAP file system.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • diskIopsConfiguration

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

      The SSD IOPS configuration for the FSx for ONTAP file system.

      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:

    • preferredSubnetId

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

    • routeTableIds

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

      Amazon FSx manages these route tables for Multi-AZ file systems using tag-based authentication. These route tables are tagged with Key: AmazonFSx; Value: ManagedByAmazonFSx. When creating FSx for ONTAP Multi-AZ file systems using CloudFormation we recommend that you add the Key: AmazonFSx; Value: ManagedByAmazonFSx tag manually.

      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.

      Amazon FSx manages these route tables for Multi-AZ file systems using tag-based authentication. These route tables are tagged with Key: AmazonFSx; Value: ManagedByAmazonFSx. When creating FSx for ONTAP Multi-AZ file systems using CloudFormation we recommend that you add the Key: AmazonFSx; Value: ManagedByAmazonFSx tag manually.

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

    • routeTableIds

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

      Amazon FSx manages these route tables for Multi-AZ file systems using tag-based authentication. These route tables are tagged with Key: AmazonFSx; Value: ManagedByAmazonFSx. When creating FSx for ONTAP Multi-AZ file systems using CloudFormation we recommend that you add the Key: AmazonFSx; Value: ManagedByAmazonFSx tag manually.

      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.

      Amazon FSx manages these route tables for Multi-AZ file systems using tag-based authentication. These route tables are tagged with Key: AmazonFSx; Value: ManagedByAmazonFSx. When creating FSx for ONTAP Multi-AZ file systems using CloudFormation we recommend that you add the Key: AmazonFSx; Value: ManagedByAmazonFSx tag manually.

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

    • throughputCapacity

      CreateFileSystemOntapConfiguration.Builder throughputCapacity(Integer throughputCapacity)

      Sets the throughput capacity for the file system that you're creating in megabytes per second (MBps). For more information, see Managing throughput capacity in the FSx for ONTAP User Guide.

      Amazon FSx responds with an HTTP status code 400 (Bad Request) for the following conditions:

      • The value of ThroughputCapacity and ThroughputCapacityPerHAPair are not the same value.

      • The value of ThroughputCapacity when divided by the value of HAPairs is outside of the valid range for ThroughputCapacity.

      Parameters:
      throughputCapacity - Sets the throughput capacity for the file system that you're creating in megabytes per second (MBps). For more information, see Managing throughput capacity in the FSx for ONTAP User Guide.

      Amazon FSx responds with an HTTP status code 400 (Bad Request) for the following conditions:

      • The value of ThroughputCapacity and ThroughputCapacityPerHAPair are not the same value.

      • The value of ThroughputCapacity when divided by the value of HAPairs is outside of the valid range for ThroughputCapacity.

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

    • weeklyMaintenanceStartTime

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

    • haPairs

      CreateFileSystemOntapConfiguration.Builder haPairs(Integer haPairs)

      Specifies how many high-availability (HA) pairs of file servers will power your file system. Scale-up file systems are powered by 1 HA pair. The default value is 1. FSx for ONTAP scale-out file systems are powered by up to 12 HA pairs. The value of this property affects the values of StorageCapacity, Iops, and ThroughputCapacity. For more information, see High-availability (HA) pairs in the FSx for ONTAP user guide.

      Amazon FSx responds with an HTTP status code 400 (Bad Request) for the following conditions:

      • The value of HAPairs is less than 1 or greater than 12.

      • The value of HAPairs is greater than 1 and the value of DeploymentType is SINGLE_AZ_1 or MULTI_AZ_1.

      Parameters:
      haPairs - Specifies how many high-availability (HA) pairs of file servers will power your file system. Scale-up file systems are powered by 1 HA pair. The default value is 1. FSx for ONTAP scale-out file systems are powered by up to 12 HA pairs. The value of this property affects the values of StorageCapacity, Iops, and ThroughputCapacity. For more information, see High-availability (HA) pairs in the FSx for ONTAP user guide.

      Amazon FSx responds with an HTTP status code 400 (Bad Request) for the following conditions:

      • The value of HAPairs is less than 1 or greater than 12.

      • The value of HAPairs is greater than 1 and the value of DeploymentType is SINGLE_AZ_1 or MULTI_AZ_1.

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

    • throughputCapacityPerHAPair

      CreateFileSystemOntapConfiguration.Builder throughputCapacityPerHAPair(Integer throughputCapacityPerHAPair)

      Use to choose the throughput capacity per HA pair, rather than the total throughput for the file system.

      You can define either the ThroughputCapacityPerHAPair or the ThroughputCapacity when creating a file system, but not both.

      This field and ThroughputCapacity are the same for scale-up file systems powered by one HA pair.

      • For SINGLE_AZ_1 and MULTI_AZ_1 file systems, valid values are 128, 256, 512, 1024, 2048, or 4096 MBps.

      • For SINGLE_AZ_2 file systems, valid values are 3072 or 6144 MBps.

      Amazon FSx responds with an HTTP status code 400 (Bad Request) for the following conditions:

      • The value of ThroughputCapacity and ThroughputCapacityPerHAPair are not the same value for file systems with one HA pair.

      • The value of deployment type is SINGLE_AZ_2 and ThroughputCapacity / ThroughputCapacityPerHAPair is a valid HA pair (a value between 2 and 12).

      • The value of ThroughputCapacityPerHAPair is not a valid value.

      Parameters:
      throughputCapacityPerHAPair - Use to choose the throughput capacity per HA pair, rather than the total throughput for the file system.

      You can define either the ThroughputCapacityPerHAPair or the ThroughputCapacity when creating a file system, but not both.

      This field and ThroughputCapacity are the same for scale-up file systems powered by one HA pair.

      • For SINGLE_AZ_1 and MULTI_AZ_1 file systems, valid values are 128, 256, 512, 1024, 2048, or 4096 MBps.

      • For SINGLE_AZ_2 file systems, valid values are 3072 or 6144 MBps.

      Amazon FSx responds with an HTTP status code 400 (Bad Request) for the following conditions:

      • The value of ThroughputCapacity and ThroughputCapacityPerHAPair are not the same value for file systems with one HA pair.

      • The value of deployment type is SINGLE_AZ_2 and ThroughputCapacity / ThroughputCapacityPerHAPair is a valid HA pair (a value between 2 and 12).

      • The value of ThroughputCapacityPerHAPair is not a valid value.

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