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

Class CfnFileSystemMixinProps.Builder

java.lang.Object
software.amazon.awscdk.cfnpropertymixins.services.fsx.CfnFileSystemMixinProps.Builder
All Implemented Interfaces:
software.amazon.jsii.Builder<CfnFileSystemMixinProps>
Enclosing interface:
CfnFileSystemMixinProps
@Stability(Stable) public static final class CfnFileSystemMixinProps.Builder extends Object implements software.amazon.jsii.Builder<CfnFileSystemMixinProps>
A builder for CfnFileSystemMixinProps

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • backupId

      @Stability(Stable) public CfnFileSystemMixinProps.Builder backupId(String backupId)
      Sets the value of CfnFileSystemMixinProps.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

    • fileSystemType

      @Stability(Stable) public CfnFileSystemMixinProps.Builder fileSystemType(String fileSystemType)
      Sets the value of CfnFileSystemMixinProps.getFileSystemType()
      Parameters:
      fileSystemType - The type of Amazon FSx file system, which can be LUSTRE , WINDOWS , ONTAP , or OPENZFS .
      Returns:
      this

    • fileSystemTypeVersion

      @Stability(Stable) public CfnFileSystemMixinProps.Builder fileSystemTypeVersion(String fileSystemTypeVersion)
      Sets the value of CfnFileSystemMixinProps.getFileSystemTypeVersion()
      Parameters:
      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.
      Returns:
      this

    • kmsKeyId

      @Stability(Stable) public CfnFileSystemMixinProps.Builder kmsKeyId(String kmsKeyId)
      Sets the value of CfnFileSystemMixinProps.getKmsKeyId()
      Parameters:
      kmsKeyId - The ID of the AWS Key Management Service ( AWS ) 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 key for your account.

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

      If this ID isn't specified, the Amazon FSx-managed key for your account is used. For more information, see Encrypt in the AWS Key Management Service API Reference .

      Returns:
      this

    • lustreConfiguration

      @Stability(Stable) public CfnFileSystemMixinProps.Builder lustreConfiguration(IResolvable lustreConfiguration)
      Sets the value of CfnFileSystemMixinProps.getLustreConfiguration()
      Parameters:
      lustreConfiguration - The Lustre configuration for the file system being created. This configuration is required if the FileSystemType is set to LUSTRE .

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

      • AutoImportPolicy
      • ExportPath
      • ImportedChunkSize
      • ImportPath

      Returns:
      this

    • lustreConfiguration

      @Stability(Stable) public CfnFileSystemMixinProps.Builder lustreConfiguration(CfnFileSystemPropsMixin.LustreConfigurationProperty lustreConfiguration)
      Sets the value of CfnFileSystemMixinProps.getLustreConfiguration()
      Parameters:
      lustreConfiguration - The Lustre configuration for the file system being created. This configuration is required if the FileSystemType is set to LUSTRE .

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

      • AutoImportPolicy
      • ExportPath
      • ImportedChunkSize
      • ImportPath

      Returns:
      this

    • networkType

      @Stability(Stable) public CfnFileSystemMixinProps.Builder networkType(String networkType)
      Sets the value of CfnFileSystemMixinProps.getNetworkType()
      Parameters:
      networkType - The network type of the file system.
      Returns:
      this

    • ontapConfiguration

      @Stability(Stable) public CfnFileSystemMixinProps.Builder ontapConfiguration(IResolvable ontapConfiguration)
      Sets the value of CfnFileSystemMixinProps.getOntapConfiguration()
      Parameters:
      ontapConfiguration - The ONTAP configuration properties of the FSx for ONTAP file system that you are creating. This configuration is required if the FileSystemType is set to ONTAP .
      Returns:
      this

    • ontapConfiguration

      @Stability(Stable) public CfnFileSystemMixinProps.Builder ontapConfiguration(CfnFileSystemPropsMixin.OntapConfigurationProperty ontapConfiguration)
      Sets the value of CfnFileSystemMixinProps.getOntapConfiguration()
      Parameters:
      ontapConfiguration - The ONTAP configuration properties of the FSx for ONTAP file system that you are creating. This configuration is required if the FileSystemType is set to ONTAP .
      Returns:
      this

    • openZfsConfiguration

      @Stability(Stable) public CfnFileSystemMixinProps.Builder openZfsConfiguration(IResolvable openZfsConfiguration)
      Sets the value of CfnFileSystemMixinProps.getOpenZfsConfiguration()
      Parameters:
      openZfsConfiguration - The Amazon FSx for OpenZFS configuration properties for the file system that you are creating. This configuration is required if the FileSystemType is set to OPENZFS .
      Returns:
      this

    • openZfsConfiguration

      @Stability(Stable) public CfnFileSystemMixinProps.Builder openZfsConfiguration(CfnFileSystemPropsMixin.OpenZFSConfigurationProperty openZfsConfiguration)
      Sets the value of CfnFileSystemMixinProps.getOpenZfsConfiguration()
      Parameters:
      openZfsConfiguration - The Amazon FSx for OpenZFS configuration properties for the file system that you are creating. This configuration is required if the FileSystemType is set to OPENZFS .
      Returns:
      this

    • securityGroupIds

      @Stability(Stable) public CfnFileSystemMixinProps.Builder securityGroupIds(List<String> securityGroupIds)
      Sets the value of CfnFileSystemMixinProps.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.

      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.

      Returns:
      this

    • storageCapacity

      @Stability(Stable) public CfnFileSystemMixinProps.Builder storageCapacity(Number storageCapacity)
      Sets the value of CfnFileSystemMixinProps.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. 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).
      Returns:
      this

    • storageType

      @Stability(Stable) public CfnFileSystemMixinProps.Builder storageType(String storageType)
      Sets the value of CfnFileSystemMixinProps.getStorageType()
      Parameters:
      storageType - Sets the storage class for the file system that you're creating. Valid values are SSD , HDD , and INTELLIGENT_TIERING .

      • 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, which is supported on SINGLE_AZ_2 and MULTI_AZ_1 Windows file system deployment types, and on PERSISTENT_1 Lustre file system deployment types.
      • Set to INTELLIGENT_TIERING to use fully elastic, intelligently-tiered storage. Intelligent-Tiering is only available for OpenZFS file systems with the Multi-AZ deployment type and for Lustre file systems with the Persistent_2 deployment type.

      Default value is SSD . For more information, see Storage type options in the FSx for Windows File Server User Guide , FSx for Lustre storage classes in the FSx for Lustre User Guide , and Working with Intelligent-Tiering in the Amazon FSx for OpenZFS User Guide .

      Returns:
      this

    • subnetIds

      @Stability(Stable) public CfnFileSystemMixinProps.Builder subnetIds(List<String> subnetIds)
      Sets the value of CfnFileSystemMixinProps.getSubnetIds()
      Parameters:
      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.

      Returns:
      this

    • tags

      @Stability(Stable) public CfnFileSystemMixinProps.Builder tags(List<? extends CfnTag> tags)
      Sets the value of CfnFileSystemMixinProps.getTags()
      Parameters:
      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 .
      Returns:
      this

    • windowsConfiguration

      @Stability(Stable) public CfnFileSystemMixinProps.Builder windowsConfiguration(IResolvable windowsConfiguration)
      Sets the value of CfnFileSystemMixinProps.getWindowsConfiguration()
      Parameters:
      windowsConfiguration - The configuration object for the Microsoft Windows file system you are creating. This configuration is required if FileSystemType is set to WINDOWS .
      Returns:
      this

    • windowsConfiguration

      @Stability(Stable) public CfnFileSystemMixinProps.Builder windowsConfiguration(CfnFileSystemPropsMixin.WindowsConfigurationProperty windowsConfiguration)
      Sets the value of CfnFileSystemMixinProps.getWindowsConfiguration()
      Parameters:
      windowsConfiguration - The configuration object for the Microsoft Windows file system you are creating. This configuration is required if FileSystemType is set to WINDOWS .
      Returns:
      this

    • build

      @Stability(Stable) public CfnFileSystemMixinProps build()
      Builds the configured instance.
      Specified by:
      build in interface software.amazon.jsii.Builder<CfnFileSystemMixinProps>
      Returns:
      a new instance of CfnFileSystemMixinProps
      Throws:
      NullPointerException - if any required attribute was not provided