Package software.amazon.awscdk.cfnpropertymixins.services.fsx

Class CfnFileSystemPropsMixin.OpenZFSConfigurationProperty.Jsii$Proxy

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.cfnpropertymixins.services.fsx.CfnFileSystemPropsMixin.OpenZFSConfigurationProperty.Jsii$Proxy

All Implemented Interfaces:

CfnFileSystemPropsMixin.OpenZFSConfigurationProperty, software.amazon.jsii.JsiiSerializable

Enclosing interface:

CfnFileSystemPropsMixin.OpenZFSConfigurationProperty

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

An implementation for CfnFileSystemPropsMixin.OpenZFSConfigurationProperty

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.cfnpropertymixins.services.fsx.CfnFileSystemPropsMixin.OpenZFSConfigurationProperty

CfnFileSystemPropsMixin.OpenZFSConfigurationProperty.Builder, CfnFileSystemPropsMixin.OpenZFSConfigurationProperty.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Jsii$Proxy(CfnFileSystemPropsMixin.OpenZFSConfigurationProperty.Builder builder)	Constructor that initializes the object based on literal property values passed by the CfnFileSystemPropsMixin.OpenZFSConfigurationProperty.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 Object	getCopyTagsToBackups()	A Boolean value indicating whether tags for the file system should be copied to backups.
final Object	getCopyTagsToVolumes()	A Boolean value indicating whether tags for the file system should be copied to volumes.
final String	getDailyAutomaticBackupStartTime()	A recurring daily time, in the format HH:MM .
final String	getDeploymentType()	Specifies the file system deployment type.
final Object	getDiskIopsConfiguration()	The SSD IOPS (input/output operations per second) configuration for an Amazon FSx for NetApp ONTAP, Amazon FSx for Windows File Server, or FSx for OpenZFS file system.
final String	getEndpointIpAddressRange()	(Multi-AZ only) Specifies the IPv4 address range in which the endpoints to access your file system will be created.
final String	getEndpointIpv6AddressRange()	(Multi-AZ only) Specifies the IP address range in which the endpoints to access your file system will be created.
final List<String>	getOptions()	To delete a file system if there are child volumes present below the root volume, use the string DELETE_CHILD_VOLUMES_AND_SNAPSHOTS .
final String	getPreferredSubnetId()	Required when DeploymentType is set to MULTI_AZ_1 .
final Object	getReadCacheConfiguration()	Specifies the optional provisioned SSD read cache on file systems that use the Intelligent-Tiering storage class.
final Object	getRootVolumeConfiguration()	The configuration Amazon FSx uses when creating the root value of the Amazon FSx for OpenZFS file system.
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()	Specifies the throughput of an Amazon FSx for OpenZFS file system, measured in megabytes per second (MBps).
final String	getWeeklyMaintenanceStartTime()	The preferred start time to perform weekly maintenance, formatted d:HH:MM in the UTC time zone, where d is the weekday number, from 1 through 7, beginning with Monday and ending with Sunday.
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(CfnFileSystemPropsMixin.OpenZFSConfigurationProperty.Builder builder)

Constructor that initializes the object based on literal property values passed by the CfnFileSystemPropsMixin.OpenZFSConfigurationProperty.Builder.

Method Details

getAutomaticBackupRetentionDays

public final Number getAutomaticBackupRetentionDays()

Description copied from interface: CfnFileSystemPropsMixin.OpenZFSConfigurationProperty

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

See Also:

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

getCopyTagsToBackups

public final Object getCopyTagsToBackups()

Description copied from interface: CfnFileSystemPropsMixin.OpenZFSConfigurationProperty

A Boolean value indicating whether tags for the file system should be copied to backups.

This value defaults to false . If it's set to true , all tags for the file system are copied to all automatic and user-initiated backups where the user doesn't specify tags. If this value is true , and you specify one or more tags, only the specified tags are copied to backups. If you specify one or more tags when creating a user-initiated backup, no tags are copied from the file system, regardless of this value.

Returns union: either Boolean or IResolvable

Specified by:

getCopyTagsToBackups in interface CfnFileSystemPropsMixin.OpenZFSConfigurationProperty

See Also:

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

getCopyTagsToVolumes

public final Object getCopyTagsToVolumes()

Description copied from interface: CfnFileSystemPropsMixin.OpenZFSConfigurationProperty

A Boolean value indicating whether tags for the file system should be copied to volumes.

This value defaults to false . If it's set to true , all tags for the file system are copied to volumes where the user doesn't specify tags. If this value is true , and you specify one or more tags, only the specified tags are copied to volumes. If you specify one or more tags when creating the volume, no tags are copied from the file system, regardless of this value.

Returns union: either Boolean or IResolvable

Specified by:

getCopyTagsToVolumes in interface CfnFileSystemPropsMixin.OpenZFSConfigurationProperty

See Also:

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

getDailyAutomaticBackupStartTime

public final String getDailyAutomaticBackupStartTime()

Description copied from interface: CfnFileSystemPropsMixin.OpenZFSConfigurationProperty

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

See Also:

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

getDeploymentType

public final String getDeploymentType()

Description copied from interface: CfnFileSystemPropsMixin.OpenZFSConfigurationProperty

Specifies the file system deployment type. Valid values are the following:.

• MULTI_AZ_1 - Creates file systems with high availability and durability by replicating your data and supporting failover across multiple Availability Zones in the same AWS Region .
• SINGLE_AZ_HA_2 - Creates file systems with high availability and throughput capacities of 160 - 10,240 MB/s using an NVMe L2ARC cache by deploying a primary and standby file system within the same Availability Zone.
• SINGLE_AZ_HA_1 - Creates file systems with high availability and throughput capacities of 64 - 4,096 MB/s by deploying a primary and standby file system within the same Availability Zone.
• SINGLE_AZ_2 - Creates file systems with throughput capacities of 160 - 10,240 MB/s using an NVMe L2ARC cache that automatically recover within a single Availability Zone.
• SINGLE_AZ_1 - Creates file systems with throughput capacities of 64 - 4,096 MBs that automatically recover within a single Availability Zone.

For a list of which AWS Regions each deployment type is available in, see Deployment type availability . For more information on the differences in performance between deployment types, see File system performance in the Amazon FSx for OpenZFS User Guide .

Specified by:

getDeploymentType in interface CfnFileSystemPropsMixin.OpenZFSConfigurationProperty

See Also:

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

getDiskIopsConfiguration

public final Object getDiskIopsConfiguration()

Description copied from interface: CfnFileSystemPropsMixin.OpenZFSConfigurationProperty

The SSD IOPS (input/output operations per second) configuration for an Amazon FSx for NetApp ONTAP, Amazon FSx for Windows File Server, or FSx for OpenZFS file system.

By default, Amazon FSx automatically provisions 3 IOPS per GB of storage capacity. You can provision additional IOPS per GB of storage. The configuration consists of the total number of provisioned SSD IOPS and how it is was provisioned, or the mode (by the customer or by Amazon FSx).

Returns union: either IResolvable or CfnFileSystemPropsMixin.DiskIopsConfigurationProperty

Specified by:

getDiskIopsConfiguration in interface CfnFileSystemPropsMixin.OpenZFSConfigurationProperty

See Also:

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

getEndpointIpAddressRange

public final String getEndpointIpAddressRange()

Description copied from interface: CfnFileSystemPropsMixin.OpenZFSConfigurationProperty

(Multi-AZ only) Specifies the IPv4 address range in which the endpoints to access your file system will be created.

By default in the Amazon FSx API and Amazon FSx console, Amazon FSx selects an available /28 IP address range for you from one of the VPC's CIDR ranges. 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 CfnFileSystemPropsMixin.OpenZFSConfigurationProperty

See Also:

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

getEndpointIpv6AddressRange

public final String getEndpointIpv6AddressRange()

Description copied from interface: CfnFileSystemPropsMixin.OpenZFSConfigurationProperty

(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 and Amazon FSx console, Amazon FSx selects an available /118 IP address range for you from one of the VPC's CIDR ranges. 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:

getEndpointIpv6AddressRange in interface CfnFileSystemPropsMixin.OpenZFSConfigurationProperty

See Also:

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

getOptions

public final List<String> getOptions()

Description copied from interface: CfnFileSystemPropsMixin.OpenZFSConfigurationProperty

To delete a file system if there are child volumes present below the root volume, use the string DELETE_CHILD_VOLUMES_AND_SNAPSHOTS .

If your file system has child volumes and you don't use this option, the delete request will fail.

Specified by:

getOptions in interface CfnFileSystemPropsMixin.OpenZFSConfigurationProperty

See Also:

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

getPreferredSubnetId

public final String getPreferredSubnetId()

Description copied from interface: CfnFileSystemPropsMixin.OpenZFSConfigurationProperty

Required when DeploymentType is set to MULTI_AZ_1 .

This specifies the subnet in which you want the preferred file server to be located.

Specified by:

getPreferredSubnetId in interface CfnFileSystemPropsMixin.OpenZFSConfigurationProperty

See Also:

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

getReadCacheConfiguration

public final Object getReadCacheConfiguration()

Description copied from interface: CfnFileSystemPropsMixin.OpenZFSConfigurationProperty

Specifies the optional provisioned SSD read cache on file systems that use the Intelligent-Tiering storage class.

Returns union: either IResolvable or CfnFileSystemPropsMixin.ReadCacheConfigurationProperty

Specified by:

getReadCacheConfiguration in interface CfnFileSystemPropsMixin.OpenZFSConfigurationProperty

See Also:

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

getRootVolumeConfiguration

public final Object getRootVolumeConfiguration()

Description copied from interface: CfnFileSystemPropsMixin.OpenZFSConfigurationProperty

The configuration Amazon FSx uses when creating the root value of the Amazon FSx for OpenZFS file system.

All volumes are children of the root volume.

Returns union: either IResolvable or CfnFileSystemPropsMixin.RootVolumeConfigurationProperty

Specified by:

getRootVolumeConfiguration in interface CfnFileSystemPropsMixin.OpenZFSConfigurationProperty

See Also:

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

getRouteTableIds

public final List<String> getRouteTableIds()

Description copied from interface: CfnFileSystemPropsMixin.OpenZFSConfigurationProperty

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

Specified by:

getRouteTableIds in interface CfnFileSystemPropsMixin.OpenZFSConfigurationProperty

See Also:

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

getThroughputCapacity

public final Number getThroughputCapacity()

Description copied from interface: CfnFileSystemPropsMixin.OpenZFSConfigurationProperty

Specifies the throughput of an Amazon FSx for OpenZFS file system, measured in megabytes per second (MBps).

Required if you are creating a new file system.

Valid values depend on the DeploymentType that you choose, as follows:

• For MULTI_AZ_1 and SINGLE_AZ_2 , valid values are 160, 320, 640, 1280, 2560, 3840, 5120, 7680, or 10240 MBps.
• For SINGLE_AZ_1 , valid values are 64, 128, 256, 512, 1024, 2048, 3072, or 4096 MBps.

You pay for additional throughput capacity that you provision.

Specified by:

getThroughputCapacity in interface CfnFileSystemPropsMixin.OpenZFSConfigurationProperty

See Also:

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

getWeeklyMaintenanceStartTime

public final String getWeeklyMaintenanceStartTime()

Description copied from interface: CfnFileSystemPropsMixin.OpenZFSConfigurationProperty

The preferred start time to perform weekly maintenance, formatted d:HH:MM in the UTC time zone, where d is the weekday number, from 1 through 7, beginning with Monday and ending with Sunday.

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

Specified by:

getWeeklyMaintenanceStartTime in interface CfnFileSystemPropsMixin.OpenZFSConfigurationProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-openzfsconfiguration.html#cfn-fsx-filesystem-openzfsconfiguration-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