Package software.amazon.awscdk.services.fsx

Class CfnFileSystem.Builder

java.lang.Object

software.amazon.awscdk.services.fsx.CfnFileSystem.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnFileSystem>

Enclosing class:

CfnFileSystem

@Stability(Stable)
public static final class CfnFileSystem.Builder
extends Object
implements software.amazon.jsii.Builder<CfnFileSystem>

A fluent builder for CfnFileSystem.

Method Summary

Modifier and Type	Method	Description
CfnFileSystem.Builder	backupId(String backupId)	The ID of the file system backup that you are using to create a file system.
CfnFileSystem	build()
static CfnFileSystem.Builder	create(software.constructs.Construct scope, String id)
CfnFileSystem.Builder	fileSystemType(String fileSystemType)	The type of Amazon FSx file system, which can be LUSTRE , WINDOWS , ONTAP , or OPENZFS .
CfnFileSystem.Builder	fileSystemTypeVersion(String fileSystemTypeVersion)	For FSx for Lustre file systems, sets the Lustre version for the file system that you're creating.
CfnFileSystem.Builder	kmsKeyId(String kmsKeyId)	The ID of the AWS Key Management Service ( AWS KMS ) key used to encrypt Amazon FSx file system data.
CfnFileSystem.Builder	lustreConfiguration(IResolvable lustreConfiguration)	The Lustre configuration for the file system being created.
CfnFileSystem.Builder	lustreConfiguration(CfnFileSystem.LustreConfigurationProperty lustreConfiguration)	The Lustre configuration for the file system being created.
CfnFileSystem.Builder	ontapConfiguration(IResolvable ontapConfiguration)	The ONTAP configuration properties of the FSx for ONTAP file system that you are creating.
CfnFileSystem.Builder	ontapConfiguration(CfnFileSystem.OntapConfigurationProperty ontapConfiguration)	The ONTAP configuration properties of the FSx for ONTAP file system that you are creating.
CfnFileSystem.Builder	openZfsConfiguration(IResolvable openZfsConfiguration)	The Amazon FSx for OpenZFS configuration properties for the file system that you are creating.
CfnFileSystem.Builder	openZfsConfiguration(CfnFileSystem.OpenZFSConfigurationProperty openZfsConfiguration)	The Amazon FSx for OpenZFS configuration properties for the file system that you are creating.
CfnFileSystem.Builder	securityGroupIds(List<String> securityGroupIds)	A list of IDs specifying the security groups to apply to all network interfaces created for file system access.
CfnFileSystem.Builder	storageCapacity(Number storageCapacity)	Sets the storage capacity of the file system that you're creating.
CfnFileSystem.Builder	storageType(String storageType)	Sets the storage type for the file system that you're creating.
CfnFileSystem.Builder	subnetIds(List<String> subnetIds)	Specifies the IDs of the subnets that the file system will be accessible from.
CfnFileSystem.Builder	tags(List<? extends CfnTag> tags)	The tags to associate with the file system.
CfnFileSystem.Builder	windowsConfiguration(IResolvable windowsConfiguration)	The configuration object for the Microsoft Windows file system you are creating.
CfnFileSystem.Builder	windowsConfiguration(CfnFileSystem.WindowsConfigurationProperty windowsConfiguration)	The configuration object for the Microsoft Windows file system you are creating.

Methods inherited from class java.lang.Object

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

Method Details

create

@Stability(Stable)
public static CfnFileSystem.Builder create(software.constructs.Construct scope,
 String id)

Parameters:

scope - Scope in which this resource is defined. This parameter is required.

id - Construct identifier for this resource (unique in its scope). This parameter is required.

Returns:

a new instance of CfnFileSystem.Builder.

fileSystemType

@Stability(Stable)
public CfnFileSystem.Builder fileSystemType(String fileSystemType)

The type of Amazon FSx file system, which can be LUSTRE , WINDOWS , ONTAP , or OPENZFS .

Parameters:

fileSystemType - The type of Amazon FSx file system, which can be LUSTRE , WINDOWS , ONTAP , or OPENZFS . This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-fsx-filesystem.html#cfn-fsx-filesystem-filesystemtype

subnetIds

@Stability(Stable)
public CfnFileSystem.Builder subnetIds(List<String> subnetIds)

Specifies the IDs of the subnets that the file system will be accessible from.

For Windows and ONTAP MULTI_AZ_1 deployment types,provide exactly two subnet IDs, one for the preferred file server and one for the standby file server. You specify one of these subnets as the preferred subnet using the WindowsConfiguration > PreferredSubnetID or OntapConfiguration > PreferredSubnetID properties. For more information about Multi-AZ file system configuration, see Availability and durability: Single-AZ and Multi-AZ file systems in the Amazon FSx for Windows User Guide and Availability and durability in the Amazon FSx for ONTAP User Guide .

For Windows SINGLE_AZ_1 and SINGLE_AZ_2 and all Lustre deployment types, provide exactly one subnet ID. The file server is launched in that subnet's Availability Zone.

Parameters:

subnetIds - Specifies the IDs of the subnets that the file system will be accessible from. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-fsx-filesystem.html#cfn-fsx-filesystem-subnetids

backupId

@Stability(Stable)
public CfnFileSystem.Builder backupId(String backupId)

The ID of the file system backup that you are using to create a file system.

For more information, see CreateFileSystemFromBackup .

Parameters:

backupId - The ID of the file system backup that you are using to create a file system. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-fsx-filesystem.html#cfn-fsx-filesystem-backupid

fileSystemTypeVersion

@Stability(Stable)
public CfnFileSystem.Builder fileSystemTypeVersion(String fileSystemTypeVersion)

For FSx for Lustre file systems, sets the Lustre version for the file system that you're creating.

Valid values are 2.10 , 2.12 , and 2.15 :

• 2.10 is supported by the Scratch and Persistent_1 Lustre deployment types.
• 2.12 is supported by all Lustre deployment types, except for PERSISTENT_2 with a metadata configuration mode.
• 2.15 is supported by all Lustre deployment types and is recommended for all new file systems.

Default value is 2.10 , except for the following deployments:

• Default value is 2.12 when DeploymentType is set to PERSISTENT_2 without a metadata configuration mode.
• Default value is 2.15 when DeploymentType is set to PERSISTENT_2 with a metadata configuration mode.

Parameters:

fileSystemTypeVersion - For FSx for Lustre file systems, sets the Lustre version for the file system that you're creating. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-fsx-filesystem.html#cfn-fsx-filesystem-filesystemtypeversion

kmsKeyId

@Stability(Stable)
public CfnFileSystem.Builder kmsKeyId(String kmsKeyId)

The ID of the AWS Key Management Service ( AWS KMS ) key used to encrypt Amazon FSx file system data.

Used as follows with Amazon FSx file system types:

• Amazon FSx for Lustre PERSISTENT_1 and PERSISTENT_2 deployment types only.

SCRATCH_1 and SCRATCH_2 types are encrypted using the Amazon FSx service AWS KMS key for your account.

• Amazon FSx for NetApp ONTAP
• Amazon FSx for OpenZFS
• Amazon FSx for Windows File Server

Parameters:

kmsKeyId - The ID of the AWS Key Management Service ( AWS KMS ) key used to encrypt Amazon FSx file system data. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-fsx-filesystem.html#cfn-fsx-filesystem-kmskeyid

lustreConfiguration

@Stability(Stable)
public CfnFileSystem.Builder lustreConfiguration(IResolvable lustreConfiguration)

The Lustre configuration for the file system being created.

The following parameters are not supported when creating Lustre file systems with a data repository association.

• AutoImportPolicy
• ExportPath
• ImportedChunkSize
• ImportPath

Parameters:

lustreConfiguration - The Lustre configuration for the file system being created. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-fsx-filesystem.html#cfn-fsx-filesystem-lustreconfiguration

lustreConfiguration

@Stability(Stable)
public CfnFileSystem.Builder lustreConfiguration(CfnFileSystem.LustreConfigurationProperty lustreConfiguration)

The Lustre configuration for the file system being created.

The following parameters are not supported when creating Lustre file systems with a data repository association.

• AutoImportPolicy
• ExportPath
• ImportedChunkSize
• ImportPath

Parameters:

lustreConfiguration - The Lustre configuration for the file system being created. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-fsx-filesystem.html#cfn-fsx-filesystem-lustreconfiguration

ontapConfiguration

@Stability(Stable)
public CfnFileSystem.Builder ontapConfiguration(IResolvable ontapConfiguration)

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

Parameters:

ontapConfiguration - The ONTAP configuration properties of the FSx for ONTAP file system that you are creating. This parameter is required.

Returns:

this

See Also:

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

ontapConfiguration

@Stability(Stable)
public CfnFileSystem.Builder ontapConfiguration(CfnFileSystem.OntapConfigurationProperty ontapConfiguration)

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

Parameters:

ontapConfiguration - The ONTAP configuration properties of the FSx for ONTAP file system that you are creating. This parameter is required.

Returns:

this

See Also:

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

openZfsConfiguration

@Stability(Stable)
public CfnFileSystem.Builder openZfsConfiguration(IResolvable openZfsConfiguration)

The Amazon FSx for OpenZFS configuration properties for the file system that you are creating.

Parameters:

openZfsConfiguration - The Amazon FSx for OpenZFS configuration properties for the file system that you are creating. This parameter is required.

Returns:

this

See Also:

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

openZfsConfiguration

@Stability(Stable)
public CfnFileSystem.Builder openZfsConfiguration(CfnFileSystem.OpenZFSConfigurationProperty openZfsConfiguration)

The Amazon FSx for OpenZFS configuration properties for the file system that you are creating.

Parameters:

openZfsConfiguration - The Amazon FSx for OpenZFS configuration properties for the file system that you are creating. This parameter is required.

Returns:

this

See Also:

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

securityGroupIds

@Stability(Stable)
public CfnFileSystem.Builder securityGroupIds(List<String> securityGroupIds)

A list of IDs specifying the security groups to apply to all network interfaces created for file system access.

This list isn't returned in later requests to describe the file system.

You must specify a security group if you are creating a Multi-AZ FSx for ONTAP file system in a VPC subnet that has been shared with you.

Parameters:

securityGroupIds - A list of IDs specifying the security groups to apply to all network interfaces created for file system access. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-fsx-filesystem.html#cfn-fsx-filesystem-securitygroupids

storageCapacity

@Stability(Stable)
public CfnFileSystem.Builder storageCapacity(Number storageCapacity)

Sets the storage capacity of the file system that you're creating.

StorageCapacity is required if you are creating a new file system. It is not required if you are creating a file system by restoring a backup.

FSx for Lustre file systems - The amount of storage capacity that you can configure depends on the value that you set for StorageType and the Lustre DeploymentType , as follows:

• For SCRATCH_2 , PERSISTENT_2 and PERSISTENT_1 deployment types using SSD storage type, the valid values are 1200 GiB, 2400 GiB, and increments of 2400 GiB.
• For PERSISTENT_1 HDD file systems, valid values are increments of 6000 GiB for 12 MB/s/TiB file systems and increments of 1800 GiB for 40 MB/s/TiB file systems.
• For SCRATCH_1 deployment type, valid values are 1200 GiB, 2400 GiB, and increments of 3600 GiB.

FSx for ONTAP file systems - The amount of SSD storage capacity that you can configure depends on the value of the HAPairs property. The minimum value is calculated as 1,024 GiB * HAPairs and the maximum is calculated as 524,288 GiB * HAPairs, up to a maximum amount of SSD storage capacity of 1,048,576 GiB (1 pebibyte).

FSx for OpenZFS file systems - The amount of storage capacity that you can configure is from 64 GiB up to 524,288 GiB (512 TiB). If you are creating a file system from a backup, you can specify a storage capacity equal to or greater than the original file system's storage capacity.

FSx for Windows File Server file systems - The amount of storage capacity that you can configure depends on the value that you set for StorageType as follows:

• For SSD storage, valid values are 32 GiB-65,536 GiB (64 TiB).
• For HDD storage, valid values are 2000 GiB-65,536 GiB (64 TiB).

Parameters:

storageCapacity - Sets the storage capacity of the file system that you're creating. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-fsx-filesystem.html#cfn-fsx-filesystem-storagecapacity

storageType

@Stability(Stable)
public CfnFileSystem.Builder storageType(String storageType)

Sets the storage type for the file system that you're creating. Valid values are SSD and HDD .

• Set to SSD to use solid state drive storage. SSD is supported on all Windows, Lustre, ONTAP, and OpenZFS deployment types.
• Set to HDD to use hard disk drive storage. HDD is supported on SINGLE_AZ_2 and MULTI_AZ_1 Windows file system deployment types, and on PERSISTENT_1 Lustre file system deployment types.

Default value is SSD . For more information, see Storage type options in the FSx for Windows File Server User Guide and Multiple storage options in the FSx for Lustre User Guide .

Parameters:

storageType - Sets the storage type for the file system that you're creating. Valid values are SSD and HDD . This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-fsx-filesystem.html#cfn-fsx-filesystem-storagetype

tags

@Stability(Stable)
public CfnFileSystem.Builder tags(List<? extends CfnTag> tags)

The tags to associate with the file system.

For more information, see Tagging your Amazon FSx resources in the Amazon FSx for Lustre User Guide .

Parameters:

tags - The tags to associate with the file system. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-fsx-filesystem.html#cfn-fsx-filesystem-tags

windowsConfiguration

@Stability(Stable)
public CfnFileSystem.Builder windowsConfiguration(IResolvable windowsConfiguration)

The configuration object for the Microsoft Windows file system you are creating.

This value is required if FileSystemType is set to WINDOWS .

Parameters:

windowsConfiguration - The configuration object for the Microsoft Windows file system you are creating. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-fsx-filesystem.html#cfn-fsx-filesystem-windowsconfiguration

windowsConfiguration

@Stability(Stable)
public CfnFileSystem.Builder windowsConfiguration(CfnFileSystem.WindowsConfigurationProperty windowsConfiguration)

The configuration object for the Microsoft Windows file system you are creating.

This value is required if FileSystemType is set to WINDOWS .

Parameters:

windowsConfiguration - The configuration object for the Microsoft Windows file system you are creating. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-fsx-filesystem.html#cfn-fsx-filesystem-windowsconfiguration

build

@Stability(Stable)
public CfnFileSystem build()

Specified by:

build in interface software.amazon.jsii.Builder<CfnFileSystem>

Returns:

a newly built instance of CfnFileSystem.