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

Interface UpdateFileSystemOntapConfiguration.Builder

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

  • Method Details

    • automaticBackupRetentionDays

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

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

    • fsxAdminPassword

      UpdateFileSystemOntapConfiguration.Builder fsxAdminPassword(String fsxAdminPassword)

      Update the password for the fsxadmin user by entering a new password. You use the fsxadmin user to access the NetApp ONTAP CLI and REST API to manage your file system resources. For more information, see Managing resources using NetApp Applicaton.

      Parameters:
      fsxAdminPassword - Update the password for the fsxadmin user by entering a new password. You use the fsxadmin user to access the NetApp ONTAP CLI and REST API to manage your file system resources. For more information, see Managing resources using NetApp Applicaton.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • weeklyMaintenanceStartTime

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

      UpdateFileSystemOntapConfiguration.Builder diskIopsConfiguration(DiskIopsConfiguration diskIopsConfiguration)

      The SSD IOPS (input output operations per second) configuration for an Amazon FSx for NetApp ONTAP file system. The default is 3 IOPS per GB of storage capacity, but you can provision additional IOPS per GB of storage. The configuration consists of an IOPS mode (AUTOMATIC or USER_PROVISIONED ), and in the case of USER_PROVISIONED IOPS, the total number of SSD IOPS provisioned. For more information, see Updating SSD storage capacity and IOPS.

      Parameters:
      diskIopsConfiguration - The SSD IOPS (input output operations per second) configuration for an Amazon FSx for NetApp ONTAP file system. The default is 3 IOPS per GB of storage capacity, but you can provision additional IOPS per GB of storage. The configuration consists of an IOPS mode (AUTOMATIC or USER_PROVISIONED), and in the case of USER_PROVISIONED IOPS, the total number of SSD IOPS provisioned. For more information, see Updating SSD storage capacity and IOPS.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • diskIopsConfiguration

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

      The SSD IOPS (input output operations per second) configuration for an Amazon FSx for NetApp ONTAP file system. The default is 3 IOPS per GB of storage capacity, but you can provision additional IOPS per GB of storage. The configuration consists of an IOPS mode (AUTOMATIC or USER_PROVISIONED ), and in the case of USER_PROVISIONED IOPS, the total number of SSD IOPS provisioned. For more information, see Updating SSD storage capacity and IOPS.

      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:

    • throughputCapacity

      UpdateFileSystemOntapConfiguration.Builder throughputCapacity(Integer throughputCapacity)

      Enter a new value to change the amount of throughput capacity for the file system 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 - Enter a new value to change the amount of throughput capacity for the file system 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.

    • addRouteTableIds

      UpdateFileSystemOntapConfiguration.Builder addRouteTableIds(Collection<String> addRouteTableIds)

      (Multi-AZ only) A list of IDs of new virtual private cloud (VPC) route tables to associate (add) with your Amazon FSx for NetApp ONTAP file system.

      Parameters:
      addRouteTableIds - (Multi-AZ only) A list of IDs of new virtual private cloud (VPC) route tables to associate (add) with your Amazon FSx for NetApp ONTAP file system.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • addRouteTableIds

      UpdateFileSystemOntapConfiguration.Builder addRouteTableIds(String... addRouteTableIds)

      (Multi-AZ only) A list of IDs of new virtual private cloud (VPC) route tables to associate (add) with your Amazon FSx for NetApp ONTAP file system.

      Parameters:
      addRouteTableIds - (Multi-AZ only) A list of IDs of new virtual private cloud (VPC) route tables to associate (add) with your Amazon FSx for NetApp ONTAP file system.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • removeRouteTableIds

      UpdateFileSystemOntapConfiguration.Builder removeRouteTableIds(Collection<String> removeRouteTableIds)

      (Multi-AZ only) A list of IDs of existing virtual private cloud (VPC) route tables to disassociate (remove) from your Amazon FSx for NetApp ONTAP file system. You can use the API operation to retrieve the list of VPC route table IDs for a file system.

      Parameters:
      removeRouteTableIds - (Multi-AZ only) A list of IDs of existing virtual private cloud (VPC) route tables to disassociate (remove) from your Amazon FSx for NetApp ONTAP file system. You can use the API operation to retrieve the list of VPC route table IDs for a file system.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • removeRouteTableIds

      UpdateFileSystemOntapConfiguration.Builder removeRouteTableIds(String... removeRouteTableIds)

      (Multi-AZ only) A list of IDs of existing virtual private cloud (VPC) route tables to disassociate (remove) from your Amazon FSx for NetApp ONTAP file system. You can use the API operation to retrieve the list of VPC route table IDs for a file system.

      Parameters:
      removeRouteTableIds - (Multi-AZ only) A list of IDs of existing virtual private cloud (VPC) route tables to disassociate (remove) from your Amazon FSx for NetApp ONTAP file system. You can use the API operation to retrieve the list of VPC route table IDs for a file system.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • throughputCapacityPerHAPair

      UpdateFileSystemOntapConfiguration.Builder throughputCapacityPerHAPair(Integer throughputCapacityPerHAPair)

      Use to choose the throughput capacity per HA pair, rather than 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, valid values are 128, 256, 512, 1024, 2048, or 4096 MBps.

      • For SINGLE_AZ_2, 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.

      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, valid values are 128, 256, 512, 1024, 2048, or 4096 MBps.

      • For SINGLE_AZ_2, 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.