com.amazonaws.services.fsx.model

Class OntapFileSystemConfiguration

java.lang.Object

com.amazonaws.services.fsx.model.OntapFileSystemConfiguration

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class OntapFileSystemConfiguration
extends Object
implements Serializable, Cloneable, StructuredPojo

Configuration for the FSx for NetApp ONTAP file system.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
OntapFileSystemConfiguration()

Method Summary

Modifier and Type	Method and Description
OntapFileSystemConfiguration	clone()
boolean	equals(Object obj)
Integer	getAutomaticBackupRetentionDays()
String	getDailyAutomaticBackupStartTime()
String	getDeploymentType() Specifies the FSx for ONTAP file system deployment type in use in the file system.
DiskIopsConfiguration	getDiskIopsConfiguration() The SSD IOPS configuration for the ONTAP file system, specifying the number of provisioned IOPS and the provision mode.
String	getEndpointIpAddressRange() (Multi-AZ only) Specifies the IP address range in which the endpoints to access your file system will be created.
FileSystemEndpoints	getEndpoints() 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.
String	getFsxAdminPassword() You can use the fsxadmin user account to access the NetApp ONTAP CLI and REST API.
Integer	getHAPairs() Specifies how many high-availability (HA) file server pairs the file system will have.
String	getPreferredSubnetId()
List<String>	getRouteTableIds() (Multi-AZ only) The VPC route tables in which your file system's endpoints are created.
Integer	getThroughputCapacity()
Integer	getThroughputCapacityPerHAPair() Use to choose the throughput capacity per HA pair.
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 in use in the file system.
void	setDiskIopsConfiguration(DiskIopsConfiguration diskIopsConfiguration) The SSD IOPS configuration for the ONTAP file system, specifying the number of provisioned IOPS and the provision mode.
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	setEndpoints(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.
void	setFsxAdminPassword(String fsxAdminPassword) You can use the fsxadmin user account to access the NetApp ONTAP CLI and REST API.
void	setHAPairs(Integer hAPairs) Specifies how many high-availability (HA) file server pairs the file system will have.
void	setPreferredSubnetId(String preferredSubnetId)
void	setRouteTableIds(Collection<String> routeTableIds) (Multi-AZ only) The VPC route tables in which your file system's endpoints are created.
void	setThroughputCapacity(Integer throughputCapacity)
void	setThroughputCapacityPerHAPair(Integer throughputCapacityPerHAPair) Use to choose the throughput capacity per HA pair.
void	setWeeklyMaintenanceStartTime(String weeklyMaintenanceStartTime)
String	toString() Returns a string representation of this object.
OntapFileSystemConfiguration	withAutomaticBackupRetentionDays(Integer automaticBackupRetentionDays)
OntapFileSystemConfiguration	withDailyAutomaticBackupStartTime(String dailyAutomaticBackupStartTime)
OntapFileSystemConfiguration	withDeploymentType(OntapDeploymentType deploymentType) Specifies the FSx for ONTAP file system deployment type in use in the file system.
OntapFileSystemConfiguration	withDeploymentType(String deploymentType) Specifies the FSx for ONTAP file system deployment type in use in the file system.
OntapFileSystemConfiguration	withDiskIopsConfiguration(DiskIopsConfiguration diskIopsConfiguration) The SSD IOPS configuration for the ONTAP file system, specifying the number of provisioned IOPS and the provision mode.
OntapFileSystemConfiguration	withEndpointIpAddressRange(String endpointIpAddressRange) (Multi-AZ only) Specifies the IP address range in which the endpoints to access your file system will be created.
OntapFileSystemConfiguration	withEndpoints(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.
OntapFileSystemConfiguration	withFsxAdminPassword(String fsxAdminPassword) You can use the fsxadmin user account to access the NetApp ONTAP CLI and REST API.
OntapFileSystemConfiguration	withHAPairs(Integer hAPairs) Specifies how many high-availability (HA) file server pairs the file system will have.
OntapFileSystemConfiguration	withPreferredSubnetId(String preferredSubnetId)
OntapFileSystemConfiguration	withRouteTableIds(Collection<String> routeTableIds) (Multi-AZ only) The VPC route tables in which your file system's endpoints are created.
OntapFileSystemConfiguration	withRouteTableIds(String... routeTableIds) (Multi-AZ only) The VPC route tables in which your file system's endpoints are created.
OntapFileSystemConfiguration	withThroughputCapacity(Integer throughputCapacity)
OntapFileSystemConfiguration	withThroughputCapacityPerHAPair(Integer throughputCapacityPerHAPair) Use to choose the throughput capacity per HA pair.
OntapFileSystemConfiguration	withWeeklyMaintenanceStartTime(String weeklyMaintenanceStartTime)

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

OntapFileSystemConfiguration

public OntapFileSystemConfiguration()

Method Detail

setAutomaticBackupRetentionDays

public void setAutomaticBackupRetentionDays(Integer automaticBackupRetentionDays)

Parameters:

automaticBackupRetentionDays -

getAutomaticBackupRetentionDays

public Integer getAutomaticBackupRetentionDays()

Returns:

withAutomaticBackupRetentionDays

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

Parameters:

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.

See Also:

OntapDeploymentType

getDeploymentType

public String getDeploymentType()

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.

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:

OntapDeploymentType

withDeploymentType

public OntapFileSystemConfiguration withDeploymentType(String 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

OntapDeploymentType

withDeploymentType

public OntapFileSystemConfiguration withDeploymentType(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.

Parameters:

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.

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.

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.

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.

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.

withEndpointIpAddressRange

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

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

setEndpoints

public void setEndpoints(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.

Parameters:

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.

getEndpoints

public FileSystemEndpoints getEndpoints()

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.

withEndpoints

public OntapFileSystemConfiguration withEndpoints(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.

Parameters:

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:

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 ONTAP file system, specifying the number of provisioned IOPS and the provision mode.

Parameters:

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

getDiskIopsConfiguration

public DiskIopsConfiguration getDiskIopsConfiguration()

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.

withDiskIopsConfiguration

public OntapFileSystemConfiguration withDiskIopsConfiguration(DiskIopsConfiguration diskIopsConfiguration)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

setPreferredSubnetId

public void setPreferredSubnetId(String preferredSubnetId)

Parameters:

preferredSubnetId -

getPreferredSubnetId

public String getPreferredSubnetId()

Returns:

withPreferredSubnetId

public OntapFileSystemConfiguration withPreferredSubnetId(String preferredSubnetId)

Parameters:

preferredSubnetId -

Returns:

Returns a reference to this object so that method calls can be chained together.

getRouteTableIds

public List<String> getRouteTableIds()

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

Returns:

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

setRouteTableIds

public void setRouteTableIds(Collection<String> routeTableIds)

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

Parameters:

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

withRouteTableIds

public OntapFileSystemConfiguration withRouteTableIds(String... routeTableIds)

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

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) The VPC route tables in which your file system's endpoints are created.

Returns:

Returns a reference to this object so that method calls can be chained together.

withRouteTableIds

public OntapFileSystemConfiguration withRouteTableIds(Collection<String> routeTableIds)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

setThroughputCapacity

public void setThroughputCapacity(Integer throughputCapacity)

Parameters:

throughputCapacity -

getThroughputCapacity

public Integer getThroughputCapacity()

Returns:

withThroughputCapacity

public OntapFileSystemConfiguration withThroughputCapacity(Integer throughputCapacity)

Parameters:

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 OntapFileSystemConfiguration withWeeklyMaintenanceStartTime(String weeklyMaintenanceStartTime)

Parameters:

weeklyMaintenanceStartTime -

Returns:

Returns a reference to this object so that method calls can be chained together.

setFsxAdminPassword

public void setFsxAdminPassword(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.

Parameters:

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.

getFsxAdminPassword

public String getFsxAdminPassword()

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.

withFsxAdminPassword

public OntapFileSystemConfiguration withFsxAdminPassword(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.

Parameters:

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:

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

Parameters:

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.

getHAPairs

public Integer getHAPairs()

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.

withHAPairs

public OntapFileSystemConfiguration withHAPairs(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.

Parameters:

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:

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

Parameters:

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.

getThroughputCapacityPerHAPair

public Integer getThroughputCapacityPerHAPair()

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.

withThroughputCapacityPerHAPair

public OntapFileSystemConfiguration withThroughputCapacityPerHAPair(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.

Parameters:

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:

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