Package software.amazon.awscdk.services.fsx

Class LustreFileSystem.Builder

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

  • Method Details

    • create

      @Stability(Stable) public static LustreFileSystem.Builder create(software.constructs.Construct scope, String id)
      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      Returns:
      a new instance of LustreFileSystem.Builder.

    • storageCapacityGiB

      @Stability(Stable) public LustreFileSystem.Builder storageCapacityGiB(Number storageCapacityGiB)
      The storage capacity of the file system being created.

      For Windows file systems, valid values are 32 GiB to 65,536 GiB. For SCRATCH_1 deployment types, valid values are 1,200, 2,400, 3,600, then continuing in increments of 3,600 GiB. 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.

      Parameters:
      storageCapacityGiB - The storage capacity of the file system being created. This parameter is required.
      Returns:
      this

    • vpc

      @Stability(Stable) public LustreFileSystem.Builder vpc(IVpc vpc)
      The VPC to launch the file system in.

      Parameters:
      vpc - The VPC to launch the file system in. This parameter is required.
      Returns:
      this

    • backupId

      @Stability(Stable) public LustreFileSystem.Builder backupId(String backupId)
      The ID of the backup.

      Specifies the backup to use if you're creating a file system from an existing backup.

      Default: - no backup will be used.

      Parameters:
      backupId - The ID of the backup. This parameter is required.
      Returns:
      this

    • kmsKey

      @Stability(Stable) public LustreFileSystem.Builder kmsKey(IKey kmsKey)
      The KMS key used for encryption to protect your data at rest.

      Default: - the aws/fsx default KMS key for the AWS account being deployed into.

      Parameters:
      kmsKey - The KMS key used for encryption to protect your data at rest. This parameter is required.
      Returns:
      this

    • removalPolicy

      @Stability(Stable) public LustreFileSystem.Builder removalPolicy(RemovalPolicy removalPolicy)
      Policy to apply when the file system is removed from the stack.

      Default: RemovalPolicy.RETAIN

      Parameters:
      removalPolicy - Policy to apply when the file system is removed from the stack. This parameter is required.
      Returns:
      this

    • securityGroup

      @Stability(Stable) public LustreFileSystem.Builder securityGroup(ISecurityGroup securityGroup)
      Security Group to assign to this file system.

      Default: - creates new security group which allows all outbound traffic.

      Parameters:
      securityGroup - Security Group to assign to this file system. This parameter is required.
      Returns:
      this

    • storageType

      @Stability(Stable) public LustreFileSystem.Builder storageType(StorageType storageType)
      The storage type for the file system that you're creating.

      Default: StorageType.SSD

      Parameters:
      storageType - The storage type for the file system that you're creating. This parameter is required.
      Returns:
      this
      See Also:

    • lustreConfiguration

      @Stability(Stable) public LustreFileSystem.Builder lustreConfiguration(LustreConfiguration lustreConfiguration)
      Additional configuration for FSx specific to Lustre.

      Parameters:
      lustreConfiguration - Additional configuration for FSx specific to Lustre. This parameter is required.
      Returns:
      this

    • vpcSubnet

      @Stability(Stable) public LustreFileSystem.Builder vpcSubnet(ISubnet vpcSubnet)
      The subnet that the file system will be accessible from.

      Parameters:
      vpcSubnet - The subnet that the file system will be accessible from. This parameter is required.
      Returns:
      this

    • fileSystemTypeVersion

      @Stability(Stable) public LustreFileSystem.Builder fileSystemTypeVersion(FileSystemTypeVersion fileSystemTypeVersion)
      The Lustre version for the file system.

      Default: - V_2_10, except for PERSISTENT_2 deployment type, where it is V_2_12 without metadata configuration mode and V_2_15 with metadata configuration mode.

      Parameters:
      fileSystemTypeVersion - The Lustre version for the file system. This parameter is required.
      Returns:
      this
      See Also:

    • build

      @Stability(Stable) public LustreFileSystem build()
      Specified by:
      build in interface software.amazon.jsii.Builder<LustreFileSystem>
      Returns:
      a newly built instance of LustreFileSystem.