Package software.amazon.awscdk.services.fsx

Class CfnFileSystem.OntapConfigurationProperty.Jsii$Proxy

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.fsx.CfnFileSystem.OntapConfigurationProperty.Jsii$Proxy

All Implemented Interfaces:

CfnFileSystem.OntapConfigurationProperty, software.amazon.jsii.JsiiSerializable

Enclosing interface:

CfnFileSystem.OntapConfigurationProperty

@Stability(Stable)
@Internal
public static final class CfnFileSystem.OntapConfigurationProperty.Jsii$Proxy
extends software.amazon.jsii.JsiiObject
implements CfnFileSystem.OntapConfigurationProperty

An implementation for CfnFileSystem.OntapConfigurationProperty

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.fsx.CfnFileSystem.OntapConfigurationProperty

CfnFileSystem.OntapConfigurationProperty.Builder, CfnFileSystem.OntapConfigurationProperty.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Jsii$Proxy(CfnFileSystem.OntapConfigurationProperty.Builder builder)	Constructor that initializes the object based on literal property values passed by the CfnFileSystem.OntapConfigurationProperty.Builder.
protected	Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)	Constructor that initializes the object based on values retrieved from the JsiiObject.

Method Summary

Modifier and Type	Method	Description
com.fasterxml.jackson.databind.JsonNode	$jsii$toJson()
final boolean	equals(Object o)
final Number	getAutomaticBackupRetentionDays()	The number of days to retain automatic backups.
final String	getDailyAutomaticBackupStartTime()	A recurring daily time, in the format HH:MM .
final String	getDeploymentType()	Specifies the FSx for ONTAP file system deployment type to use in creating the file system.
final Object	getDiskIopsConfiguration()	The SSD IOPS configuration for the FSx for ONTAP file system.
final String	getEndpointIpAddressRange()	(Multi-AZ only) Specifies the IP address range in which the endpoints to access your file system will be created.
final 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.
final Number	getHaPairs()	Specifies how many high-availability (HA) pairs of file servers will power your file system.
final String	getPreferredSubnetId()	Required when DeploymentType is set to MULTI_AZ_1 or MULTI_AZ_2 .
final 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.
final Number	getThroughputCapacity()	Sets the throughput capacity for the file system that you're creating in megabytes per second (MBps).
final Number	getThroughputCapacityPerHaPair()	Use to choose the throughput capacity per HA pair, rather than the total throughput for the file system.
final String	getWeeklyMaintenanceStartTime()	A recurring weekly time, in the format D:HH:MM .
final int	hashCode()

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

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

Constructor Details

Jsii$Proxy

protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)

Constructor that initializes the object based on values retrieved from the JsiiObject.

Parameters:

objRef - Reference to the JSII managed object.

Jsii$Proxy

protected Jsii$Proxy(CfnFileSystem.OntapConfigurationProperty.Builder builder)

Constructor that initializes the object based on literal property values passed by the CfnFileSystem.OntapConfigurationProperty.Builder.

Method Details

getDeploymentType

public final String getDeploymentType()

Description copied from interface: CfnFileSystem.OntapConfigurationProperty

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 .

Specified by:

getDeploymentType in interface CfnFileSystem.OntapConfigurationProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-ontapconfiguration.html#cfn-fsx-filesystem-ontapconfiguration-deploymenttype

getAutomaticBackupRetentionDays

public final Number getAutomaticBackupRetentionDays()

Description copied from interface: CfnFileSystem.OntapConfigurationProperty

The number of days to retain automatic backups.

Setting this property to 0 disables automatic backups. You can retain automatic backups for a maximum of 90 days. The default is 30 .

Specified by:

getAutomaticBackupRetentionDays in interface CfnFileSystem.OntapConfigurationProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-ontapconfiguration.html#cfn-fsx-filesystem-ontapconfiguration-automaticbackupretentiondays

getDailyAutomaticBackupStartTime

public final String getDailyAutomaticBackupStartTime()

Description copied from interface: CfnFileSystem.OntapConfigurationProperty

A recurring daily time, in the format HH:MM .

HH is the zero-padded hour of the day (0-23), and MM is the zero-padded minute of the hour. For example, 05:00 specifies 5 AM daily.

Specified by:

getDailyAutomaticBackupStartTime in interface CfnFileSystem.OntapConfigurationProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-ontapconfiguration.html#cfn-fsx-filesystem-ontapconfiguration-dailyautomaticbackupstarttime

getDiskIopsConfiguration

public final Object getDiskIopsConfiguration()

Description copied from interface: CfnFileSystem.OntapConfigurationProperty

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

Specified by:

getDiskIopsConfiguration in interface CfnFileSystem.OntapConfigurationProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-ontapconfiguration.html#cfn-fsx-filesystem-ontapconfiguration-diskiopsconfiguration

getEndpointIpAddressRange

public final String getEndpointIpAddressRange()

Description copied from interface: CfnFileSystem.OntapConfigurationProperty

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

Specified by:

getEndpointIpAddressRange in interface CfnFileSystem.OntapConfigurationProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-ontapconfiguration.html#cfn-fsx-filesystem-ontapconfiguration-endpointipaddressrange

getFsxAdminPassword

public final String getFsxAdminPassword()

Description copied from interface: CfnFileSystem.OntapConfigurationProperty

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

Specified by:

getFsxAdminPassword in interface CfnFileSystem.OntapConfigurationProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-ontapconfiguration.html#cfn-fsx-filesystem-ontapconfiguration-fsxadminpassword

getHaPairs

public final Number getHaPairs()

Description copied from interface: CfnFileSystem.OntapConfigurationProperty

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 .

Specified by:

getHaPairs in interface CfnFileSystem.OntapConfigurationProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-ontapconfiguration.html#cfn-fsx-filesystem-ontapconfiguration-hapairs

getPreferredSubnetId

public final String getPreferredSubnetId()

Description copied from interface: CfnFileSystem.OntapConfigurationProperty

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.

Specified by:

getPreferredSubnetId in interface CfnFileSystem.OntapConfigurationProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-ontapconfiguration.html#cfn-fsx-filesystem-ontapconfiguration-preferredsubnetid

getRouteTableIds

public final List<String> getRouteTableIds()

Description copied from interface: CfnFileSystem.OntapConfigurationProperty

(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 AWS CloudFormation we recommend that you add the Key: AmazonFSx; Value: ManagedByAmazonFSx tag manually.

Specified by:

getRouteTableIds in interface CfnFileSystem.OntapConfigurationProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-ontapconfiguration.html#cfn-fsx-filesystem-ontapconfiguration-routetableids

getThroughputCapacity

public final Number getThroughputCapacity()

Description copied from interface: CfnFileSystem.OntapConfigurationProperty

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 .

Specified by:

getThroughputCapacity in interface CfnFileSystem.OntapConfigurationProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-ontapconfiguration.html#cfn-fsx-filesystem-ontapconfiguration-throughputcapacity

getThroughputCapacityPerHaPair

public final Number getThroughputCapacityPerHaPair()

Description copied from interface: CfnFileSystem.OntapConfigurationProperty

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.

Specified by:

getThroughputCapacityPerHaPair in interface CfnFileSystem.OntapConfigurationProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-ontapconfiguration.html#cfn-fsx-filesystem-ontapconfiguration-throughputcapacityperhapair

getWeeklyMaintenanceStartTime

public final String getWeeklyMaintenanceStartTime()

Description copied from interface: CfnFileSystem.OntapConfigurationProperty

A recurring weekly time, in the format D:HH:MM .

D is the day of the week, for which 1 represents Monday and 7 represents Sunday. For further details, see the ISO-8601 spec as described on Wikipedia .

HH is the zero-padded hour of the day (0-23), and MM is the zero-padded minute of the hour.

For example, 1:05:00 specifies maintenance at 5 AM Monday.

Specified by:

getWeeklyMaintenanceStartTime in interface CfnFileSystem.OntapConfigurationProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-ontapconfiguration.html#cfn-fsx-filesystem-ontapconfiguration-weeklymaintenancestarttime

$jsii$toJson

@Internal
public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()

Specified by:

$jsii$toJson in interface software.amazon.jsii.JsiiSerializable

equals

public final boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public final int hashCode()

Overrides:

hashCode in class Object