Class OntapFileSystemConfiguration
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<OntapFileSystemConfiguration.Builder,
OntapFileSystemConfiguration>
Configuration for the FSx for NetApp ONTAP file system.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal Integer
Returns the value of the AutomaticBackupRetentionDays property for this object.builder()
final String
Returns the value of the DailyAutomaticBackupStartTime property for this object.final OntapDeploymentType
Specifies the FSx for ONTAP file system deployment type in use in the file system.final String
Specifies the FSx for ONTAP file system deployment type in use in the file system.final DiskIopsConfiguration
The SSD IOPS configuration for the ONTAP file system, specifying the number of provisioned IOPS and the provision mode.final String
(Multi-AZ only) Specifies the IP address range in which the endpoints to access your file system will be created.final FileSystemEndpoints
TheManagement
andIntercluster
endpoints that are used to access data or to manage the file system using the NetApp ONTAP CLI, REST API, or NetApp SnapMirror.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final String
You can use thefsxadmin
user account to access the NetApp ONTAP CLI and REST API.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final Integer
haPairs()
Specifies how many high-availability (HA) file server pairs the file system will have.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the RouteTableIds property.final String
Returns the value of the PreferredSubnetId property for this object.(Multi-AZ only) The VPC route tables in which your file system's endpoints are created.static Class
<? extends OntapFileSystemConfiguration.Builder> final Integer
Returns the value of the ThroughputCapacity property for this object.final Integer
Use to choose the throughput capacity per HA pair.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final String
Returns the value of the WeeklyMaintenanceStartTime property for this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
automaticBackupRetentionDays
Returns the value of the AutomaticBackupRetentionDays property for this object.- Returns:
- The value of the AutomaticBackupRetentionDays property for this object.
-
dailyAutomaticBackupStartTime
Returns the value of the DailyAutomaticBackupStartTime property for this object.- Returns:
- The value of the DailyAutomaticBackupStartTime property for this object.
-
deploymentType
Specifies the FSx for ONTAP file system deployment type in use in 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 Multi-AZ or Single-AZ file system deployment.
If the service returns an enum value that is not available in the current SDK version,
deploymentType
will returnOntapDeploymentType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromdeploymentTypeAsString()
.- Returns:
- Specifies the FSx for ONTAP file system deployment type in use in 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 Multi-AZ or Single-AZ file system deployment.
-
- See Also:
-
-
deploymentTypeAsString
Specifies the FSx for ONTAP file system deployment type in use in 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 Multi-AZ or Single-AZ file system deployment.
If the service returns an enum value that is not available in the current SDK version,
deploymentType
will returnOntapDeploymentType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromdeploymentTypeAsString()
.- Returns:
- Specifies the FSx for ONTAP file system deployment type in use in 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 Multi-AZ or Single-AZ file system deployment.
-
- See Also:
-
-
endpointIpAddressRange
(Multi-AZ only) Specifies the IP address range in which the endpoints to access your file system will be created. By default in the Amazon FSx API, Amazon FSx selects an unused IP address range for you from the 198.19.* range. By default in the Amazon FSx console, Amazon FSx chooses the last 64 IP addresses from the VPC’s primary CIDR range to use as the endpoint IP address range for the file system. You can have overlapping endpoint IP addresses for file systems deployed in the same VPC/route tables.
- Returns:
- (Multi-AZ only) Specifies the IP address range in which the endpoints to access your file system will be created. By default in the Amazon FSx API, Amazon FSx selects an unused IP address range for you from the 198.19.* range. By default in the Amazon FSx console, Amazon FSx chooses the last 64 IP addresses from the VPC’s primary CIDR range to use as the endpoint IP address range for the file system. You can have overlapping endpoint IP addresses for file systems deployed in the same VPC/route tables.
-
endpoints
The
Management
andIntercluster
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
andIntercluster
endpoints that are used to access data or to manage the file system using the NetApp ONTAP CLI, REST API, or NetApp SnapMirror.
-
diskIopsConfiguration
The SSD IOPS configuration for the ONTAP file system, specifying the number of provisioned IOPS and the provision mode.
- Returns:
- The SSD IOPS configuration for the ONTAP file system, specifying the number of provisioned IOPS and the provision mode.
-
preferredSubnetId
Returns the value of the PreferredSubnetId property for this object.- Returns:
- The value of the PreferredSubnetId property for this object.
-
hasRouteTableIds
public final boolean hasRouteTableIds()For responses, this returns true if the service returned a value for the RouteTableIds property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
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
(Multi-AZ only) The VPC route tables in which your file system's endpoints are created.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasRouteTableIds()
method.- Returns:
- (Multi-AZ only) The VPC route tables in which your file system's endpoints are created.
-
throughputCapacity
Returns the value of the ThroughputCapacity property for this object.- Returns:
- The value of the ThroughputCapacity property for this object.
-
weeklyMaintenanceStartTime
Returns the value of the WeeklyMaintenanceStartTime property for this object.- Returns:
- The value of the WeeklyMaintenanceStartTime property for this object.
-
fsxAdminPassword
You can use the
fsxadmin
user account to access the NetApp ONTAP CLI and REST API. The password value is always redacted in the response.- Returns:
- You can use the
fsxadmin
user account to access the NetApp ONTAP CLI and REST API. The password value is always redacted in the response.
-
haPairs
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
, andThroughputCapacity
. 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 ofDeploymentType
isSINGLE_AZ_1
orMULTI_AZ_1
.
- 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
, andThroughputCapacity
. 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 ofDeploymentType
isSINGLE_AZ_1
orMULTI_AZ_1
.
-
-
-
throughputCapacityPerHAPair
Use to choose the throughput capacity per HA pair. When the value of
HAPairs
is equal to 1, the value ofThroughputCapacityPerHAPair
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
andMULTI_AZ_1
, valid values are 128, 256, 512, 1024, 2048, or 4096 MBps. -
For
SINGLE_AZ_2
, valid values are 3072 or 6144 MBps.
Amazon FSx responds with an HTTP status code 400 (Bad Request) for the following conditions:
-
The value of
ThroughputCapacity
andThroughputCapacityPerHAPair
are not the same value. -
The value of deployment type is
SINGLE_AZ_2
andThroughputCapacity
/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. When the value of
HAPairs
is equal to 1, the value ofThroughputCapacityPerHAPair
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
andMULTI_AZ_1
, valid values are 128, 256, 512, 1024, 2048, or 4096 MBps. -
For
SINGLE_AZ_2
, valid values are 3072 or 6144 MBps.
Amazon FSx responds with an HTTP status code 400 (Bad Request) for the following conditions:
-
The value of
ThroughputCapacity
andThroughputCapacityPerHAPair
are not the same value. -
The value of deployment type is
SINGLE_AZ_2
andThroughputCapacity
/ThroughputCapacityPerHAPair
is a valid HA pair (a value between 2 and 12). -
The value of
ThroughputCapacityPerHAPair
is not a valid value.
-
-
-
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 interfaceToCopyableBuilder<OntapFileSystemConfiguration.Builder,
OntapFileSystemConfiguration> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-