software.amazon.awscdk.services.fsx

Class CfnFileSystemProps.Builder

java.lang.Object

software.amazon.awscdk.services.fsx.CfnFileSystemProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnFileSystemProps>

Enclosing interface:

CfnFileSystemProps

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

A builder for CfnFileSystemProps

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
CfnFileSystemProps.Builder	backupId(String backupId) Sets the value of CfnFileSystemProps.getBackupId()
CfnFileSystemProps	build() Builds the configured instance.
CfnFileSystemProps.Builder	fileSystemType(String fileSystemType) Sets the value of CfnFileSystemProps.getFileSystemType()
CfnFileSystemProps.Builder	fileSystemTypeVersion(String fileSystemTypeVersion) Sets the value of CfnFileSystemProps.getFileSystemTypeVersion()
CfnFileSystemProps.Builder	kmsKeyId(String kmsKeyId) Sets the value of CfnFileSystemProps.getKmsKeyId()
CfnFileSystemProps.Builder	lustreConfiguration(CfnFileSystem.LustreConfigurationProperty lustreConfiguration) Sets the value of CfnFileSystemProps.getLustreConfiguration()
CfnFileSystemProps.Builder	lustreConfiguration(IResolvable lustreConfiguration) Sets the value of CfnFileSystemProps.getLustreConfiguration()
CfnFileSystemProps.Builder	ontapConfiguration(CfnFileSystem.OntapConfigurationProperty ontapConfiguration) Sets the value of CfnFileSystemProps.getOntapConfiguration()
CfnFileSystemProps.Builder	ontapConfiguration(IResolvable ontapConfiguration) Sets the value of CfnFileSystemProps.getOntapConfiguration()
CfnFileSystemProps.Builder	openZfsConfiguration(CfnFileSystem.OpenZFSConfigurationProperty openZfsConfiguration) Sets the value of CfnFileSystemProps.getOpenZfsConfiguration()
CfnFileSystemProps.Builder	openZfsConfiguration(IResolvable openZfsConfiguration) Sets the value of CfnFileSystemProps.getOpenZfsConfiguration()
CfnFileSystemProps.Builder	securityGroupIds(List<String> securityGroupIds) Sets the value of CfnFileSystemProps.getSecurityGroupIds()
CfnFileSystemProps.Builder	storageCapacity(Number storageCapacity) Sets the value of CfnFileSystemProps.getStorageCapacity()
CfnFileSystemProps.Builder	storageType(String storageType) Sets the value of CfnFileSystemProps.getStorageType()
CfnFileSystemProps.Builder	subnetIds(List<String> subnetIds) Sets the value of CfnFileSystemProps.getSubnetIds()
CfnFileSystemProps.Builder	tags(List<? extends CfnTag> tags) Sets the value of CfnFileSystemProps.getTags()
CfnFileSystemProps.Builder	windowsConfiguration(CfnFileSystem.WindowsConfigurationProperty windowsConfiguration) Sets the value of CfnFileSystemProps.getWindowsConfiguration()
CfnFileSystemProps.Builder	windowsConfiguration(IResolvable windowsConfiguration) Sets the value of CfnFileSystemProps.getWindowsConfiguration()

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

fileSystemType

@Stability(value=Stable)
public CfnFileSystemProps.Builder fileSystemType(String fileSystemType)

Sets the value of CfnFileSystemProps.getFileSystemType()

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 CfnFileSystemProps.Builder subnetIds(List<String> subnetIds)

Sets the value of CfnFileSystemProps.getSubnetIds()

Parameters:

subnetIds - Specifies the IDs of the subnets that the file system will be accessible from. This parameter is required. 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.

Returns:

this

backupId

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

Sets the value of CfnFileSystemProps.getBackupId()

Parameters:

backupId - The ID of the source backup. Specifies the backup that you are copying.

Returns:

this

fileSystemTypeVersion

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

Sets the value of CfnFileSystemProps.getFileSystemTypeVersion()

Parameters:

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.

Returns:

this

kmsKeyId

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

Sets the value of CfnFileSystemProps.getKmsKeyId()

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

Returns:

this

lustreConfiguration

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

Sets the value of CfnFileSystemProps.getLustreConfiguration()

Parameters:

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

Returns:

this

lustreConfiguration

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

Sets the value of CfnFileSystemProps.getLustreConfiguration()

Parameters:

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

Returns:

this

ontapConfiguration

@Stability(value=Stable)
public CfnFileSystemProps.Builder ontapConfiguration(CfnFileSystem.OntapConfigurationProperty ontapConfiguration)

Sets the value of CfnFileSystemProps.getOntapConfiguration()

Parameters:

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

Returns:

this

ontapConfiguration

@Stability(value=Stable)
public CfnFileSystemProps.Builder ontapConfiguration(IResolvable ontapConfiguration)

Sets the value of CfnFileSystemProps.getOntapConfiguration()

Parameters:

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

Returns:

this

openZfsConfiguration

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

Sets the value of CfnFileSystemProps.getOpenZfsConfiguration()

Parameters:

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

Returns:

this

openZfsConfiguration

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

Sets the value of CfnFileSystemProps.getOpenZfsConfiguration()

Parameters:

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

Returns:

this

securityGroupIds

@Stability(value=Stable)
public CfnFileSystemProps.Builder securityGroupIds(List<String> securityGroupIds)

Sets the value of CfnFileSystemProps.getSecurityGroupIds()

Parameters:

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.

Returns:

this

storageCapacity

@Stability(value=Stable)
public CfnFileSystemProps.Builder storageCapacity(Number storageCapacity)

Sets the value of CfnFileSystemProps.getStorageCapacity()

Parameters:

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:

Returns:

this

storageType

@Stability(value=Stable)
public CfnFileSystemProps.Builder storageType(String storageType)

Sets the value of CfnFileSystemProps.getStorageType()

Parameters:

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 .

Returns:

this

tags

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

Sets the value of CfnFileSystemProps.getTags()

Parameters:

tags - The tags to associate with the file system. For more information, see Tagging your Amazon EC2 resources in the Amazon EC2 User Guide .

Returns:

this

windowsConfiguration

@Stability(value=Stable)
public CfnFileSystemProps.Builder windowsConfiguration(CfnFileSystem.WindowsConfigurationProperty windowsConfiguration)

Sets the value of CfnFileSystemProps.getWindowsConfiguration()

Parameters:

windowsConfiguration - The configuration object for the Microsoft Windows file system you are creating. This value is required if FileSystemType is set to WINDOWS .

Returns:

this

windowsConfiguration

@Stability(value=Stable)
public CfnFileSystemProps.Builder windowsConfiguration(IResolvable windowsConfiguration)

Sets the value of CfnFileSystemProps.getWindowsConfiguration()

Parameters:

windowsConfiguration - The configuration object for the Microsoft Windows file system you are creating. This value is required if FileSystemType is set to WINDOWS .

Returns:

this

build

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

Builds the configured instance.

Specified by:

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

Returns:

a new instance of CfnFileSystemProps

Throws:

NullPointerException - if any required attribute was not provided