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

Class UpdateFileSystemOntapConfiguration

java.lang.Object
software.amazon.awssdk.services.fsx.model.UpdateFileSystemOntapConfiguration
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<UpdateFileSystemOntapConfiguration.Builder,UpdateFileSystemOntapConfiguration>
@Generated("software.amazon.awssdk:codegen") public final class UpdateFileSystemOntapConfiguration extends Object implements SdkPojo, Serializable, ToCopyableBuilder<UpdateFileSystemOntapConfiguration.Builder,UpdateFileSystemOntapConfiguration>

The configuration updates for an Amazon FSx for NetApp ONTAP file system.

See Also:

  • Method Details

    • automaticBackupRetentionDays

      public final Integer automaticBackupRetentionDays()
      Returns the value of the AutomaticBackupRetentionDays property for this object.
      Returns:
      The value of the AutomaticBackupRetentionDays property for this object.

    • dailyAutomaticBackupStartTime

      public final String dailyAutomaticBackupStartTime()
      Returns the value of the DailyAutomaticBackupStartTime property for this object.
      Returns:
      The value of the DailyAutomaticBackupStartTime property for this object.

    • fsxAdminPassword

      public final 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.

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

    • weeklyMaintenanceStartTime

      public final String weeklyMaintenanceStartTime()
      Returns the value of the WeeklyMaintenanceStartTime property for this object.
      Returns:
      The value of the WeeklyMaintenanceStartTime property for this object.

    • diskIopsConfiguration

      public final 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.

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

    • throughputCapacity

      public final 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.

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

    • hasAddRouteTableIds

      public final boolean hasAddRouteTableIds()
      For responses, this returns true if the service returned a value for the AddRouteTableIds property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • addRouteTableIds

      public final List<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.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasAddRouteTableIds() method.

      Returns:
      (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.

    • hasRemoveRouteTableIds

      public final boolean hasRemoveRouteTableIds()
      For responses, this returns true if the service returned a value for the RemoveRouteTableIds property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • removeRouteTableIds

      public final List<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.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasRemoveRouteTableIds() method.

      Returns:
      (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.

    • throughputCapacityPerHAPair

      public final 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.

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

    • toBuilder

      public UpdateFileSystemOntapConfiguration.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<UpdateFileSystemOntapConfiguration.Builder,UpdateFileSystemOntapConfiguration>
      Returns:
      a builder for type T

    • builder

      public static UpdateFileSystemOntapConfiguration.Builder builder()

    • serializableBuilderClass

      public static Class<? extends UpdateFileSystemOntapConfiguration.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.