CreateFileSystemOntapConfiguration (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.fsx.model.CreateFileSystemOntapConfiguration

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class CreateFileSystemOntapConfiguration
extends Object
implements Serializable, Cloneable, StructuredPojo
```
The ONTAP configuration properties of the FSx for ONTAP file system that you are creating.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

CreateFileSystemOntapConfiguration()

Constructors
Constructor and Description
`CreateFileSystemOntapConfiguration()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CreateFileSystemOntapConfiguration`	`clone()`
`boolean`	`equals(Object obj)`
`Integer`	`getAutomaticBackupRetentionDays()`
`String`	`getDailyAutomaticBackupStartTime()`
`String`	`getDeploymentType()` Specifies the FSx for ONTAP file system deployment type to use in creating the file system.
`DiskIopsConfiguration`	`getDiskIopsConfiguration()` The SSD IOPS configuration for the FSx for ONTAP file system.
`String`	`getEndpointIpAddressRange()` (Multi-AZ only) Specifies the IP address range in which the endpoints to access your file system will be created.
`String`	`getFsxAdminPassword()` The ONTAP administrative password for the `fsxadmin` user with which you administer your file system using the NetApp ONTAP CLI and REST API.
`Integer`	`getHAPairs()` Specifies how many high-availability (HA) pairs of file servers will power your file system.
`String`	`getPreferredSubnetId()` Required when `DeploymentType` is set to `MULTI_AZ_1` or `MULTI_AZ_2`.
`List<String>`	`getRouteTableIds()` (Multi-AZ only) Specifies the route tables in which Amazon FSx creates the rules for routing traffic to the correct file server.
`Integer`	`getThroughputCapacity()` Sets the throughput capacity for the file system that you're creating in megabytes per second (MBps).
`Integer`	`getThroughputCapacityPerHAPair()` Use to choose the throughput capacity per HA pair, rather than the total throughput for the file system.
`String`	`getWeeklyMaintenanceStartTime()`
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setAutomaticBackupRetentionDays(Integer automaticBackupRetentionDays)`
`void`	`setDailyAutomaticBackupStartTime(String dailyAutomaticBackupStartTime)`
`void`	`setDeploymentType(String deploymentType)` Specifies the FSx for ONTAP file system deployment type to use in creating the file system.
`void`	`setDiskIopsConfiguration(DiskIopsConfiguration diskIopsConfiguration)` The SSD IOPS configuration for the FSx for ONTAP file system.
`void`	`setEndpointIpAddressRange(String endpointIpAddressRange)` (Multi-AZ only) Specifies the IP address range in which the endpoints to access your file system will be created.
`void`	`setFsxAdminPassword(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.
`void`	`setHAPairs(Integer hAPairs)` Specifies how many high-availability (HA) pairs of file servers will power your file system.
`void`	`setPreferredSubnetId(String preferredSubnetId)` Required when `DeploymentType` is set to `MULTI_AZ_1` or `MULTI_AZ_2`.
`void`	`setRouteTableIds(Collection<String> routeTableIds)` (Multi-AZ only) Specifies the route tables in which Amazon FSx creates the rules for routing traffic to the correct file server.
`void`	`setThroughputCapacity(Integer throughputCapacity)` Sets the throughput capacity for the file system that you're creating in megabytes per second (MBps).
`void`	`setThroughputCapacityPerHAPair(Integer throughputCapacityPerHAPair)` Use to choose the throughput capacity per HA pair, rather than the total throughput for the file system.
`void`	`setWeeklyMaintenanceStartTime(String weeklyMaintenanceStartTime)`
`String`	`toString()` Returns a string representation of this object.
`CreateFileSystemOntapConfiguration`	`withAutomaticBackupRetentionDays(Integer automaticBackupRetentionDays)`
`CreateFileSystemOntapConfiguration`	`withDailyAutomaticBackupStartTime(String dailyAutomaticBackupStartTime)`
`CreateFileSystemOntapConfiguration`	`withDeploymentType(OntapDeploymentType deploymentType)` Specifies the FSx for ONTAP file system deployment type to use in creating the file system.
`CreateFileSystemOntapConfiguration`	`withDeploymentType(String deploymentType)` Specifies the FSx for ONTAP file system deployment type to use in creating the file system.
`CreateFileSystemOntapConfiguration`	`withDiskIopsConfiguration(DiskIopsConfiguration diskIopsConfiguration)` The SSD IOPS configuration for the FSx for ONTAP file system.
`CreateFileSystemOntapConfiguration`	`withEndpointIpAddressRange(String endpointIpAddressRange)` (Multi-AZ only) Specifies the IP address range in which the endpoints to access your file system will be created.
`CreateFileSystemOntapConfiguration`	`withFsxAdminPassword(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.
`CreateFileSystemOntapConfiguration`	`withHAPairs(Integer hAPairs)` Specifies how many high-availability (HA) pairs of file servers will power your file system.
`CreateFileSystemOntapConfiguration`	`withPreferredSubnetId(String preferredSubnetId)` Required when `DeploymentType` is set to `MULTI_AZ_1` or `MULTI_AZ_2`.
`CreateFileSystemOntapConfiguration`	`withRouteTableIds(Collection<String> routeTableIds)` (Multi-AZ only) Specifies the route tables in which Amazon FSx creates the rules for routing traffic to the correct file server.
`CreateFileSystemOntapConfiguration`	`withRouteTableIds(String... routeTableIds)` (Multi-AZ only) Specifies the route tables in which Amazon FSx creates the rules for routing traffic to the correct file server.
`CreateFileSystemOntapConfiguration`	`withThroughputCapacity(Integer throughputCapacity)` Sets the throughput capacity for the file system that you're creating in megabytes per second (MBps).
`CreateFileSystemOntapConfiguration`	`withThroughputCapacityPerHAPair(Integer throughputCapacityPerHAPair)` Use to choose the throughput capacity per HA pair, rather than the total throughput for the file system.
`CreateFileSystemOntapConfiguration`	`withWeeklyMaintenanceStartTime(String weeklyMaintenanceStartTime)`

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - CreateFileSystemOntapConfiguration
```
public CreateFileSystemOntapConfiguration()
```
- Method Detail
  - setAutomaticBackupRetentionDays
```
public void setAutomaticBackupRetentionDays(Integer automaticBackupRetentionDays)
```
    Parameters:
    
    automaticBackupRetentionDays -
  - getAutomaticBackupRetentionDays
```
public Integer getAutomaticBackupRetentionDays()
```
    Returns:
  - withAutomaticBackupRetentionDays
```
public CreateFileSystemOntapConfiguration withAutomaticBackupRetentionDays(Integer automaticBackupRetentionDays)
```
    Parameters:
    
    automaticBackupRetentionDays -
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDailyAutomaticBackupStartTime
```
public void setDailyAutomaticBackupStartTime(String dailyAutomaticBackupStartTime)
```
    Parameters:
    
    dailyAutomaticBackupStartTime -
  - getDailyAutomaticBackupStartTime
```
public String getDailyAutomaticBackupStartTime()
```
    Returns:
  - withDailyAutomaticBackupStartTime
```
public CreateFileSystemOntapConfiguration withDailyAutomaticBackupStartTime(String dailyAutomaticBackupStartTime)
```
    Parameters:
    
    dailyAutomaticBackupStartTime -
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDeploymentType
```
public void setDeploymentType(String deploymentType)
```
    Specifies the FSx for ONTAP file system deployment type to use in creating 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 a file system deployment type.
    Parameters:
    deploymentType - Specifies the FSx for ONTAP file system deployment type to use in creating 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 a file system deployment type.
    See Also:
    
    OntapDeploymentType
  - getDeploymentType
```
public String getDeploymentType()
```
    Specifies the FSx for ONTAP file system deployment type to use in creating 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 a file system deployment type.
    Returns:
    Specifies the FSx for ONTAP file system deployment type to use in creating 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 a file system deployment type.
    See Also:
    
    OntapDeploymentType
  - withDeploymentType
```
public CreateFileSystemOntapConfiguration withDeploymentType(String deploymentType)
```
    Specifies the FSx for ONTAP file system deployment type to use in creating 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 a file system deployment type.
    Parameters:
    deploymentType - Specifies the FSx for ONTAP file system deployment type to use in creating 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 a file system deployment type.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    OntapDeploymentType
  - withDeploymentType
```
public CreateFileSystemOntapConfiguration withDeploymentType(OntapDeploymentType deploymentType)
```
    Specifies the FSx for ONTAP file system deployment type to use in creating 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 a file system deployment type.
    Parameters:
    deploymentType - Specifies the FSx for ONTAP file system deployment type to use in creating 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 a file system deployment type.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    OntapDeploymentType
  - setEndpointIpAddressRange
```
public void setEndpointIpAddressRange(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.
    
    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, as long as they don't overlap with any subnet.
  - getEndpointIpAddressRange
```
public String getEndpointIpAddressRange()
```
    (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.
  - withEndpointIpAddressRange
```
public CreateFileSystemOntapConfiguration withEndpointIpAddressRange(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.
    
    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, as long as they don't overlap with any subnet.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setFsxAdminPassword
```
public void setFsxAdminPassword(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.
    
    Parameters:
    
    fsxAdminPassword - The ONTAP administrative password for the fsxadmin user with which you administer your file system using the NetApp ONTAP CLI and REST API.
  - getFsxAdminPassword
```
public String getFsxAdminPassword()
```
    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.
  - withFsxAdminPassword
```
public CreateFileSystemOntapConfiguration withFsxAdminPassword(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDiskIopsConfiguration
```
public void setDiskIopsConfiguration(DiskIopsConfiguration diskIopsConfiguration)
```
    The SSD IOPS configuration for the FSx for ONTAP file system.
    
    Parameters:
    
    diskIopsConfiguration - The SSD IOPS configuration for the FSx for ONTAP file system.
  - getDiskIopsConfiguration
```
public DiskIopsConfiguration getDiskIopsConfiguration()
```
    The SSD IOPS configuration for the FSx for ONTAP file system.
    
    Returns:
    
    The SSD IOPS configuration for the FSx for ONTAP file system.
  - withDiskIopsConfiguration
```
public CreateFileSystemOntapConfiguration withDiskIopsConfiguration(DiskIopsConfiguration diskIopsConfiguration)
```
    The SSD IOPS configuration for the FSx for ONTAP file system.
    
    Parameters:
    
    diskIopsConfiguration - The SSD IOPS configuration for the FSx for ONTAP file system.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setPreferredSubnetId
```
public void setPreferredSubnetId(String preferredSubnetId)
```
    Required when DeploymentType is set to MULTI_AZ_1 or MULTI_AZ_2. This specifies the subnet in which you want the preferred file server to be located.
    
    Parameters:
    
    preferredSubnetId - Required when DeploymentType is set to MULTI_AZ_1 or MULTI_AZ_2. This specifies the subnet in which you want the preferred file server to be located.
  - getPreferredSubnetId
```
public String getPreferredSubnetId()
```
    Required when DeploymentType is set to MULTI_AZ_1 or MULTI_AZ_2. 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 or MULTI_AZ_2. This specifies the subnet in which you want the preferred file server to be located.
  - withPreferredSubnetId
```
public CreateFileSystemOntapConfiguration withPreferredSubnetId(String preferredSubnetId)
```
    Required when DeploymentType is set to MULTI_AZ_1 or MULTI_AZ_2. This specifies the subnet in which you want the preferred file server to be located.
    
    Parameters:
    
    preferredSubnetId - Required when DeploymentType is set to MULTI_AZ_1 or MULTI_AZ_2. This specifies the subnet in which you want the preferred file server to be located.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getRouteTableIds
```
public List<String> getRouteTableIds()
```
    (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.
    
    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.
  - setRouteTableIds
```
public void setRouteTableIds(Collection<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.
    
    Parameters:
    
    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.
  - withRouteTableIds
```
public CreateFileSystemOntapConfiguration withRouteTableIds(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.
    
    NOTE: This method appends the values to the existing list (if any). Use setRouteTableIds(java.util.Collection) or withRouteTableIds(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withRouteTableIds
```
public CreateFileSystemOntapConfiguration withRouteTableIds(Collection<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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setThroughputCapacity
```
public void setThroughputCapacity(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.
    Parameters:
    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.
  - getThroughputCapacity
```
public Integer getThroughputCapacity()
```
    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.
  - withThroughputCapacity
```
public CreateFileSystemOntapConfiguration withThroughputCapacity(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.
    Parameters:
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setWeeklyMaintenanceStartTime
```
public void setWeeklyMaintenanceStartTime(String weeklyMaintenanceStartTime)
```
    Parameters:
    
    weeklyMaintenanceStartTime -
  - getWeeklyMaintenanceStartTime
```
public String getWeeklyMaintenanceStartTime()
```
    Returns:
  - withWeeklyMaintenanceStartTime
```
public CreateFileSystemOntapConfiguration withWeeklyMaintenanceStartTime(String weeklyMaintenanceStartTime)
```
    Parameters:
    
    weeklyMaintenanceStartTime -
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setHAPairs
```
public void setHAPairs(Integer hAPairs)
```
    Specifies how many high-availability (HA) pairs of file servers will power your file system. First-generation file systems are powered by 1 HA pair. Second-generation multi-AZ file systems are powered by 1 HA pair. Second generation single-AZ file systems are powered by up to 12 HA pairs. 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. Block storage protocol support (iSCSI and NVMe over TCP) is disabled on file systems with more than 6 HA pairs. For more information, see Using block storage protocols.
    
    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) pairs of file servers will power your file system. First-generation file systems are powered by 1 HA pair. Second-generation multi-AZ file systems are powered by 1 HA pair. Second generation single-AZ file systems are powered by up to 12 HA pairs. 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. Block storage protocol support (iSCSI and NVMe over TCP) is disabled on file systems with more than 6 HA pairs. For more information, see Using block storage protocols.
    
    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.
  - getHAPairs
```
public Integer getHAPairs()
```
    Specifies how many high-availability (HA) pairs of file servers will power your file system. First-generation file systems are powered by 1 HA pair. Second-generation multi-AZ file systems are powered by 1 HA pair. Second generation single-AZ file systems are powered by up to 12 HA pairs. 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. Block storage protocol support (iSCSI and NVMe over TCP) is disabled on file systems with more than 6 HA pairs. For more information, see Using block storage protocols.
    
    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) pairs of file servers will power your file system. First-generation file systems are powered by 1 HA pair. Second-generation multi-AZ file systems are powered by 1 HA pair. Second generation single-AZ file systems are powered by up to 12 HA pairs. 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. Block storage protocol support (iSCSI and NVMe over TCP) is disabled on file systems with more than 6 HA pairs. For more information, see Using block storage protocols.
    
    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.
  - withHAPairs
```
public CreateFileSystemOntapConfiguration withHAPairs(Integer hAPairs)
```
    Specifies how many high-availability (HA) pairs of file servers will power your file system. First-generation file systems are powered by 1 HA pair. Second-generation multi-AZ file systems are powered by 1 HA pair. Second generation single-AZ file systems are powered by up to 12 HA pairs. 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. Block storage protocol support (iSCSI and NVMe over TCP) is disabled on file systems with more than 6 HA pairs. For more information, see Using block storage protocols.
    
    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) pairs of file servers will power your file system. First-generation file systems are powered by 1 HA pair. Second-generation multi-AZ file systems are powered by 1 HA pair. Second generation single-AZ file systems are powered by up to 12 HA pairs. 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. Block storage protocol support (iSCSI and NVMe over TCP) is disabled on file systems with more than 6 HA pairs. For more information, see Using block storage protocols.
    
    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.
  - setThroughputCapacityPerHAPair
```
public void setThroughputCapacityPerHAPair(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 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, 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 for file systems with one HA pair.
    - 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, 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 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, 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 for file systems with one HA pair.
    
    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.
  - getThroughputCapacityPerHAPair
```
public Integer getThroughputCapacityPerHAPair()
```
    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 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, 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 for file systems with one HA pair.
    - 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, 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 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, 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 for file systems with one HA pair.
    
    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.
  - withThroughputCapacityPerHAPair
```
public CreateFileSystemOntapConfiguration withThroughputCapacityPerHAPair(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 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, 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 for file systems with one HA pair.
    - 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, 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 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, 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 for file systems with one HA pair.
    
    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.
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public CreateFileSystemOntapConfiguration clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

AWS SDK for Java 1.x API Reference - 1.12.773

Class CreateFileSystemOntapConfiguration

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

CreateFileSystemOntapConfiguration

Method Detail

setAutomaticBackupRetentionDays

getAutomaticBackupRetentionDays

withAutomaticBackupRetentionDays

setDailyAutomaticBackupStartTime

getDailyAutomaticBackupStartTime

withDailyAutomaticBackupStartTime

setDeploymentType

getDeploymentType

withDeploymentType

withDeploymentType

setEndpointIpAddressRange

getEndpointIpAddressRange

withEndpointIpAddressRange

setFsxAdminPassword

getFsxAdminPassword

withFsxAdminPassword

setDiskIopsConfiguration

getDiskIopsConfiguration

withDiskIopsConfiguration

setPreferredSubnetId

getPreferredSubnetId

withPreferredSubnetId

getRouteTableIds

setRouteTableIds

withRouteTableIds

withRouteTableIds

setThroughputCapacity

getThroughputCapacity

withThroughputCapacity

setWeeklyMaintenanceStartTime

getWeeklyMaintenanceStartTime

withWeeklyMaintenanceStartTime

setHAPairs

getHAPairs

withHAPairs

setThroughputCapacityPerHAPair

getThroughputCapacityPerHAPair

withThroughputCapacityPerHAPair

toString

equals

hashCode

clone

marshall