Class OntapFileSystemConfiguration

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

Configuration for the 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.

    • deploymentType

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

      If the service returns an enum value that is not available in the current SDK version, deploymentType will return OntapDeploymentType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from deploymentTypeAsString().

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

      See Also:

    • deploymentTypeAsString

      public final String deploymentTypeAsString()

      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.

      If the service returns an enum value that is not available in the current SDK version, deploymentType will return OntapDeploymentType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from deploymentTypeAsString().

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

      See Also:

    • endpointIpAddressRange

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

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

    • endpoints

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

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

    • diskIopsConfiguration

      public final DiskIopsConfiguration diskIopsConfiguration()

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

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

    • preferredSubnetId

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

    • hasRouteTableIds

      public final boolean hasRouteTableIds()
      For responses, this returns true if the service returned a value for the RouteTableIds 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.

    • routeTableIds

      public final List<String> routeTableIds()

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

      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 hasRouteTableIds() method.

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

    • throughputCapacity

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

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

    • fsxAdminPassword

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

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

    • haPairs

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

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

    • throughputCapacityPerHAPair

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

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

    • toBuilder

      public OntapFileSystemConfiguration.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<OntapFileSystemConfiguration.Builder,OntapFileSystemConfiguration>
      Returns:
      a builder for type T

    • builder

      public static OntapFileSystemConfiguration.Builder builder()

    • serializableBuilderClass

      public static Class<? extends OntapFileSystemConfiguration.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.