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

Interface OntapFileSystemConfiguration.Builder

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

  • Method Details

    • automaticBackupRetentionDays

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

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

      OntapFileSystemConfiguration.Builder deploymentType(String deploymentType)

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

      • MULTI_AZ_1 - A high availability file system configured for Multi-AZ redundancy to tolerate temporary Availability Zone (AZ) unavailability. This is a first-generation FSx for ONTAP file system.

      • MULTI_AZ_2 - A high availability file system configured for Multi-AZ redundancy to tolerate temporary AZ unavailability. This is a second-generation FSx for ONTAP file system.

      • SINGLE_AZ_1 - A file system configured for Single-AZ redundancy. This is a first-generation FSx for ONTAP file system.

      • SINGLE_AZ_2 - A file system configured with multiple high-availability (HA) pairs for Single-AZ redundancy. This is a second-generation FSx for ONTAP file system.

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

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

      • MULTI_AZ_1 - A high availability file system configured for Multi-AZ redundancy to tolerate temporary Availability Zone (AZ) unavailability. This is a first-generation FSx for ONTAP file system.

      • MULTI_AZ_2 - A high availability file system configured for Multi-AZ redundancy to tolerate temporary AZ unavailability. This is a second-generation FSx for ONTAP file system.

      • SINGLE_AZ_1 - A file system configured for Single-AZ redundancy. This is a first-generation FSx for ONTAP file system.

      • SINGLE_AZ_2 - A file system configured with multiple high-availability (HA) pairs for Single-AZ redundancy. This is a second-generation FSx for ONTAP file system.

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

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

    • deploymentType

      OntapFileSystemConfiguration.Builder deploymentType(OntapDeploymentType deploymentType)

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

      • MULTI_AZ_1 - A high availability file system configured for Multi-AZ redundancy to tolerate temporary Availability Zone (AZ) unavailability. This is a first-generation FSx for ONTAP file system.

      • MULTI_AZ_2 - A high availability file system configured for Multi-AZ redundancy to tolerate temporary AZ unavailability. This is a second-generation FSx for ONTAP file system.

      • SINGLE_AZ_1 - A file system configured for Single-AZ redundancy. This is a first-generation FSx for ONTAP file system.

      • SINGLE_AZ_2 - A file system configured with multiple high-availability (HA) pairs for Single-AZ redundancy. This is a second-generation FSx for ONTAP file system.

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

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

      • MULTI_AZ_1 - A high availability file system configured for Multi-AZ redundancy to tolerate temporary Availability Zone (AZ) unavailability. This is a first-generation FSx for ONTAP file system.

      • MULTI_AZ_2 - A high availability file system configured for Multi-AZ redundancy to tolerate temporary AZ unavailability. This is a second-generation FSx for ONTAP file system.

      • SINGLE_AZ_1 - A file system configured for Single-AZ redundancy. This is a first-generation FSx for ONTAP file system.

      • SINGLE_AZ_2 - A file system configured with multiple high-availability (HA) pairs for Single-AZ redundancy. This is a second-generation FSx for ONTAP file system.

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

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

    • endpointIpAddressRange

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

      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • endpoints

      OntapFileSystemConfiguration.Builder endpoints(FileSystemEndpoints endpoints)

      The Management and Intercluster endpoints that are used to access data or to manage the file system using the NetApp ONTAP CLI, REST API, or NetApp SnapMirror.

      Parameters:
      endpoints - The Management and Intercluster endpoints that are used to access data or to manage the file system using the NetApp ONTAP CLI, REST API, or NetApp SnapMirror.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • endpoints

      default OntapFileSystemConfiguration.Builder endpoints(Consumer<FileSystemEndpoints.Builder> endpoints)

      The Management and Intercluster endpoints that are used to access data or to manage the file system using the NetApp ONTAP CLI, REST API, or NetApp SnapMirror.

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

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

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

    • diskIopsConfiguration

      OntapFileSystemConfiguration.Builder diskIopsConfiguration(DiskIopsConfiguration diskIopsConfiguration)

      The SSD IOPS configuration for the ONTAP file system, specifying the number of provisioned IOPS and the provision mode.

      Parameters:
      diskIopsConfiguration - The SSD IOPS configuration for the ONTAP file system, specifying the number of provisioned IOPS and the provision mode.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • diskIopsConfiguration

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

      The SSD IOPS configuration for the ONTAP file system, specifying the number of provisioned IOPS and the provision mode.

      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

      OntapFileSystemConfiguration.Builder preferredSubnetId(String preferredSubnetId)
      Sets the value of the PreferredSubnetId property for this object.
      Parameters:
      preferredSubnetId - The new value for the PreferredSubnetId property for this object.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • routeTableIds

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

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

    • throughputCapacity

      OntapFileSystemConfiguration.Builder throughputCapacity(Integer throughputCapacity)
      Sets the value of the ThroughputCapacity property for this object.
      Parameters:
      throughputCapacity - The new value for the ThroughputCapacity property for this object.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • weeklyMaintenanceStartTime

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

    • fsxAdminPassword

      OntapFileSystemConfiguration.Builder fsxAdminPassword(String fsxAdminPassword)

      You can use the fsxadmin user account to access the NetApp ONTAP CLI and REST API. The password value is always redacted in the response.

      Parameters:
      fsxAdminPassword - You can use the fsxadmin user account to access the NetApp ONTAP CLI and REST API. The password value is always redacted in the response.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • haPairs

      OntapFileSystemConfiguration.Builder haPairs(Integer haPairs)

      Specifies how many high-availability (HA) file server pairs the file system will have. The default value is 1. 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, MULTI_AZ_1, or MULTI_AZ_2.

      Parameters:
      haPairs - Specifies how many high-availability (HA) file server pairs the file system will have. The default value is 1. 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, MULTI_AZ_1, or MULTI_AZ_2.

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

    • throughputCapacityPerHAPair

      OntapFileSystemConfiguration.Builder throughputCapacityPerHAPair(Integer throughputCapacityPerHAPair)

      Use to choose the throughput capacity per HA pair. When the value of HAPairs is equal to 1, the value of ThroughputCapacityPerHAPair is the total throughput for the file system.

      This field and ThroughputCapacity cannot be defined in the same API call, but one is required.

      This field and ThroughputCapacity are the same for file systems with 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, valid values are 1536, 3072, or 6144 MBps.

      • For MULTI_AZ_2, valid values are 384, 768, 1536, 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.

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

      • The value of ThroughputCapacityPerHAPair is not a valid value.

      Parameters:
      throughputCapacityPerHAPair - Use to choose the throughput capacity per HA pair. When the value of HAPairs is equal to 1, the value of ThroughputCapacityPerHAPair is the total throughput for the file system.

      This field and ThroughputCapacity cannot be defined in the same API call, but one is required.

      This field and ThroughputCapacity are the same for file systems with 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, valid values are 1536, 3072, or 6144 MBps.

      • For MULTI_AZ_2, valid values are 384, 768, 1536, 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.

      • The value of deployment type is SINGLE_AZ_2 and ThroughputCapacity / ThroughputCapacityPerHAPair is not a valid HA pair (a value between 1 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.