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

Class CreateFileSystemOntapConfiguration

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

The ONTAP configuration properties of the FSx for ONTAP file system that you are creating.

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

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

      See Also:

    • deploymentTypeAsString

      public final String deploymentTypeAsString()

      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.

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

      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, as long as they don't overlap with any subnet.

      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, as long as they don't overlap with any subnet.

    • fsxAdminPassword

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

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

    • diskIopsConfiguration

      public final DiskIopsConfiguration diskIopsConfiguration()

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

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

    • preferredSubnetId

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

      Returns:
      Required when DeploymentType is set to MULTI_AZ_1. This specifies the subnet in which you want the preferred file server to be located.

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

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

    • throughputCapacity

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

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

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

    • haPairs

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

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

    • throughputCapacityPerHAPair

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

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

    • toBuilder

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

    • builder

      public static CreateFileSystemOntapConfiguration.Builder builder()

    • serializableBuilderClass

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