software.amazon.awssdk.services.fsx.model

Class CreateFileSystemOntapConfiguration

java.lang.Object

software.amazon.awssdk.services.fsx.model.CreateFileSystemOntapConfiguration

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<CreateFileSystemOntapConfiguration.Builder,CreateFileSystemOntapConfiguration>

@Generated(value="software.amazon.awssdk:codegen")
public final class CreateFileSystemOntapConfiguration
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<CreateFileSystemOntapConfiguration.Builder,CreateFileSystemOntapConfiguration>

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

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CreateFileSystemOntapConfiguration.Builder

Method Summary

Modifier and Type	Method and Description
Integer	automaticBackupRetentionDays() Returns the value of the AutomaticBackupRetentionDays property for this object.
static CreateFileSystemOntapConfiguration.Builder	builder()
String	dailyAutomaticBackupStartTime() Returns the value of the DailyAutomaticBackupStartTime property for this object.
OntapDeploymentType	deploymentType() Specifies the FSx for ONTAP file system deployment type to use in creating the file system.
String	deploymentTypeAsString() Specifies the FSx for ONTAP file system deployment type to use in creating the file system.
DiskIopsConfiguration	diskIopsConfiguration() The SSD IOPS configuration for the FSx for ONTAP file system.
String	endpointIpAddressRange() (Multi-AZ only) Specifies the IP address range in which the endpoints to access your file system will be created.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
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.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasRouteTableIds() For responses, this returns true if the service returned a value for the RouteTableIds property.
String	preferredSubnetId() Required when DeploymentType is set to MULTI_AZ_1.
List<String>	routeTableIds() (Multi-AZ only) Specifies the route tables in which Amazon FSx creates the rules for routing traffic to the correct file server.
List<SdkField<?>>	sdkFields()
static Class<? extends CreateFileSystemOntapConfiguration.Builder>	serializableBuilderClass()
Integer	throughputCapacity() Sets the throughput capacity for the file system that you're creating.
CreateFileSystemOntapConfiguration.Builder	toBuilder()
String	toString() Returns a string representation of this object.
String	weeklyMaintenanceStartTime() Returns the value of the WeeklyMaintenanceStartTime property for this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

automaticBackupRetentionDays

public final Integer automaticBackupRetentionDays()

Returns the value of the AutomaticBackupRetentionDays property for this object.

Returns:

The value of the AutomaticBackupRetentionDays property for this object.

dailyAutomaticBackupStartTime

public final String dailyAutomaticBackupStartTime()

Returns the value of the DailyAutomaticBackupStartTime property for this object.

Returns:

The value of the DailyAutomaticBackupStartTime property for this object.

deploymentType

public final OntapDeploymentType deploymentType()

Specifies the FSx for ONTAP file system deployment type to use in creating the file system.

• MULTI_AZ_1 - (Default) A high availability file system configured for Multi-AZ redundancy to tolerate temporary Availability Zone (AZ) unavailability.

• SINGLE_AZ_1 - A file system configured for Single-AZ redundancy.

For information about the use cases for Multi-AZ and Single-AZ deployments, refer to Choosing a file system deployment type.

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

Returns:

Specifies the FSx for ONTAP file system deployment type to use in creating the file system.

• MULTI_AZ_1 - (Default) A high availability file system configured for Multi-AZ redundancy to tolerate temporary Availability Zone (AZ) unavailability.

• SINGLE_AZ_1 - A file system configured for Single-AZ redundancy.

For information about the use cases for Multi-AZ and Single-AZ deployments, refer to Choosing a file system deployment type.

See Also:

OntapDeploymentType

deploymentTypeAsString

public final String deploymentTypeAsString()

Specifies the FSx for ONTAP file system deployment type to use in creating the file system.

• MULTI_AZ_1 - (Default) A high availability file system configured for Multi-AZ redundancy to tolerate temporary Availability Zone (AZ) unavailability.

• SINGLE_AZ_1 - A file system configured for Single-AZ redundancy.

For information about the use cases for Multi-AZ and Single-AZ deployments, refer to Choosing a file system deployment type.

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

Returns:

Specifies the FSx for ONTAP file system deployment type to use in creating the file system.

• MULTI_AZ_1 - (Default) A high availability file system configured for Multi-AZ redundancy to tolerate temporary Availability Zone (AZ) unavailability.

• SINGLE_AZ_1 - A file system configured for Single-AZ redundancy.

For information about the use cases for Multi-AZ and Single-AZ deployments, refer to Choosing a file system deployment type.

See Also:

OntapDeploymentType

endpointIpAddressRange

public final String endpointIpAddressRange()

(Multi-AZ only) Specifies the IP address range in which the endpoints to access your file system will be created. By default in the Amazon FSx API, Amazon FSx selects an unused IP address range for you from the 198.19.* range. By default in the Amazon FSx console, Amazon FSx chooses the last 64 IP addresses from the VPC’s primary CIDR range to use as the endpoint IP address range for the file system. You can have overlapping endpoint IP addresses for file systems deployed in the same VPC/route tables, as long as they don't overlap with any subnet.

Returns:

(Multi-AZ only) Specifies the IP address range in which the endpoints to access your file system will be created. By default in the Amazon FSx API, Amazon FSx selects an unused IP address range for you from the 198.19.* range. By default in the Amazon FSx console, Amazon FSx chooses the last 64 IP addresses from the VPC’s primary CIDR range to use as the endpoint IP address range for the file system. You can have overlapping endpoint IP addresses for file systems deployed in the same VPC/route tables, as long as they don't overlap with any subnet.

fsxAdminPassword

public final String fsxAdminPassword()

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

Returns:

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

diskIopsConfiguration

public final DiskIopsConfiguration diskIopsConfiguration()

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

Returns:

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

preferredSubnetId

public final String preferredSubnetId()

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

Returns:

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

hasRouteTableIds

public final boolean hasRouteTableIds()

For responses, this returns true if the service returned a value for the RouteTableIds property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

routeTableIds

public final List<String> routeTableIds()

(Multi-AZ only) Specifies the route tables in which Amazon FSx creates the rules for routing traffic to the correct file server. You should specify all virtual private cloud (VPC) route tables associated with the subnets in which your clients are located. By default, Amazon FSx selects your VPC's default route table.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasRouteTableIds() method.

Returns:

(Multi-AZ only) Specifies the route tables in which Amazon FSx creates the rules for routing traffic to the correct file server. You should specify all virtual private cloud (VPC) route tables associated with the subnets in which your clients are located. By default, Amazon FSx selects your VPC's default route table.

throughputCapacity

public final Integer throughputCapacity()

Sets the throughput capacity for the file system that you're creating. Valid values are 128, 256, 512, 1024, 2048, and 4096 MBps.

Returns:

Sets the throughput capacity for the file system that you're creating. Valid values are 128, 256, 512, 1024, 2048, and 4096 MBps.

weeklyMaintenanceStartTime

public final String weeklyMaintenanceStartTime()

Returns the value of the WeeklyMaintenanceStartTime property for this object.

Returns:

The value of the WeeklyMaintenanceStartTime property for this object.

toBuilder

public CreateFileSystemOntapConfiguration.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateFileSystemOntapConfiguration.Builder,CreateFileSystemOntapConfiguration>

builder

public static CreateFileSystemOntapConfiguration.Builder builder()

serializableBuilderClass

public static Class<? extends CreateFileSystemOntapConfiguration.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo