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(value=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 and Description
CfnFileSystem.Builder	backupId(String backupId) The ID of the source backup.
CfnFileSystem	build()
static CfnFileSystem.Builder	create(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) (Optional) 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 the file system's data for Amazon FSx for Windows File Server file systems, Amazon FSx for NetApp ONTAP file systems, and `PERSISTENT` Amazon FSx for Lustre file systems at rest.
CfnFileSystem.Builder	lustreConfiguration(CfnFileSystem.LustreConfigurationProperty lustreConfiguration) The Lustre configuration for the file system being created.
CfnFileSystem.Builder	lustreConfiguration(IResolvable lustreConfiguration) The Lustre configuration for the file system being created.
CfnFileSystem.Builder	ontapConfiguration(CfnFileSystem.OntapConfigurationProperty ontapConfiguration) The ONTAP configuration properties of the FSx for ONTAP file system that you are creating.
CfnFileSystem.Builder	ontapConfiguration(IResolvable ontapConfiguration) The ONTAP configuration properties of the FSx for ONTAP file system that you are creating.
CfnFileSystem.Builder	openZfsConfiguration(CfnFileSystem.OpenZFSConfigurationProperty openZfsConfiguration) The OpenZFS configuration properties for the file system that you are creating.
CfnFileSystem.Builder	openZfsConfiguration(IResolvable openZfsConfiguration) The 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(CfnFileSystem.WindowsConfigurationProperty windowsConfiguration) The configuration object for the Microsoft Windows file system you are creating.
CfnFileSystem.Builder	windowsConfiguration(IResolvable 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 Detail

create

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

Parameters:

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

id - - scoped id of the resource. This parameter is required.

Returns:

a new instance of CfnFileSystem.AuditLogConfigurationProperty.Builder.

fileSystemType

@Stability(value=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

subnetIds

@Stability(value=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

backupId

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

The ID of the source backup.

Specifies the backup that you are copying.

Parameters:

backupId - The ID of the source backup. This parameter is required.

Returns:

this

fileSystemTypeVersion

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

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

Valid values are 2.10 and 2.12 :

• 2.10 is supported by the Scratch and Persistent_1 Lustre deployment types.
• 2.12 is supported by all Lustre deployment types. 2.12 is required when setting FSx for Lustre DeploymentType to PERSISTENT_2 .

Default value = 2.10 , except when DeploymentType is set to PERSISTENT_2 , then the default is 2.12 .

If you set FileSystemTypeVersion to 2.10 for a PERSISTENT_2 Lustre deployment type, the CreateFileSystem operation fails.

Parameters:

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

Returns:

this

kmsKeyId

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

The ID of the AWS Key Management Service ( AWS KMS ) key used to encrypt the file system's data for Amazon FSx for Windows File Server file systems, Amazon FSx for NetApp ONTAP file systems, and `PERSISTENT` Amazon FSx for Lustre file systems at rest.

If this ID isn't specified, the Amazon FSx-managed key for your account is used. The scratch Amazon FSx for Lustre file systems are always encrypted at rest using the Amazon FSx-managed key for your account. For more information, see Encrypt in the AWS Key Management Service API Reference .

Parameters:

kmsKeyId - The ID of the AWS Key Management Service ( AWS KMS ) key used to encrypt the file system's data for Amazon FSx for Windows File Server file systems, Amazon FSx for NetApp ONTAP file systems, and `PERSISTENT` Amazon FSx for Lustre file systems at rest. This parameter is required.

Returns:

this

lustreConfiguration

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

The Lustre configuration for the file system being created.

The following parameters are not supported for file systems with the Persistent_2 deployment type. Instead, use CreateDataRepositoryAssociation to create a data repository association to link your Lustre file system to a data repository.

• AutoImportPolicy
• ExportPath
• ImportedChunkSize
• ImportPath

Parameters:

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

Returns:

this

lustreConfiguration

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

The Lustre configuration for the file system being created.

The following parameters are not supported for file systems with the Persistent_2 deployment type. Instead, use CreateDataRepositoryAssociation to create a data repository association to link your Lustre file system to a data repository.

• AutoImportPolicy
• ExportPath
• ImportedChunkSize
• ImportPath

Parameters:

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

Returns:

this

ontapConfiguration

@Stability(value=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

ontapConfiguration

@Stability(value=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

openZfsConfiguration

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

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

Parameters:

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

Returns:

this

openZfsConfiguration

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

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

Parameters:

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

Returns:

this

securityGroupIds

@Stability(value=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.

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

storageCapacity

@Stability(value=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. Do not include StorageCapacity if you are creating a file system from a backup.

For Lustre file systems:

Parameters:

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

Returns:

this

storageType

@Stability(value=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 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

tags

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

The tags to associate with the file system.

For more information, see Tagging your Amazon EC2 resources in the Amazon EC2 User Guide .

Parameters:

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

Returns:

this

windowsConfiguration

@Stability(value=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

windowsConfiguration

@Stability(value=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

build

@Stability(value=Stable)
public CfnFileSystem build()

Specified by:

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