CfnFileSystemProps.Builder (software.amazon.awscdk:aws-cdk-lib 2.42.1 API)

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

Constructors
Constructor and Description
`Builder()`

Method Summary

All Methods Instance Methods Concrete Methods
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 file system backup that you are using to create a file system. For more information, see CreateFileSystemFromBackup .
    
    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 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
    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 Lustre Persistent_2 deployment type.
    
    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 Lustre Persistent_2 deployment type.
    
    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 Amazon FSx for 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 Amazon FSx for 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.
    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 storage capacity that you can configure is from 1024 GiB up to 196,608 GiB (192 TiB).
    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).
    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).
    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_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 .
    Returns:
    
    this
  - tags
```
@Stability(value=Stable)
public CfnFileSystemProps.Builder tags(List<? extends CfnTag> tags)
```
    Sets the value of CfnFileSystemProps.getTags()
    
    Parameters:
    
    tags - An array of key-value pairs to apply to this resource. For more information, see Tag .
    
    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

Class CfnFileSystemProps.Builder

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Builder

Method Detail

fileSystemType

subnetIds

backupId

fileSystemTypeVersion

kmsKeyId

lustreConfiguration

lustreConfiguration

ontapConfiguration

ontapConfiguration

openZfsConfiguration

openZfsConfiguration

securityGroupIds

storageCapacity

storageType

tags

windowsConfiguration

windowsConfiguration

build