Class FileSystemProps.Builder

java.lang.Object
software.amazon.awscdk.services.fsx.FileSystemProps.Builder
All Implemented Interfaces:
software.amazon.jsii.Builder<FileSystemProps>
Enclosing interface:
FileSystemProps

@Stability(Stable) public static final class FileSystemProps.Builder extends Object implements software.amazon.jsii.Builder<FileSystemProps>
A builder for FileSystemProps
  • Constructor Details

    • Builder

      public Builder()
  • Method Details

    • storageCapacityGiB

      @Stability(Stable) public FileSystemProps.Builder storageCapacityGiB(Number storageCapacityGiB)
      Parameters:
      storageCapacityGiB - The storage capacity of the file system being created. This parameter is required. 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.
      Returns:
      this
    • vpc

      @Stability(Stable) public FileSystemProps.Builder vpc(IVpc vpc)
      Sets the value of FileSystemProps.getVpc()
      Parameters:
      vpc - The VPC to launch the file system in. This parameter is required.
      Returns:
      this
    • backupId

      @Stability(Stable) public FileSystemProps.Builder backupId(String backupId)
      Parameters:
      backupId - The ID of the backup. Specifies the backup to use if you're creating a file system from an existing backup.
      Returns:
      this
    • kmsKey

      @Stability(Stable) public FileSystemProps.Builder kmsKey(IKey kmsKey)
      Sets the value of FileSystemProps.getKmsKey()
      Parameters:
      kmsKey - The KMS key used for encryption to protect your data at rest.
      Returns:
      this
    • removalPolicy

      @Stability(Stable) public FileSystemProps.Builder removalPolicy(RemovalPolicy removalPolicy)
      Parameters:
      removalPolicy - Policy to apply when the file system is removed from the stack.
      Returns:
      this
    • securityGroup

      @Stability(Stable) public FileSystemProps.Builder securityGroup(ISecurityGroup securityGroup)
      Parameters:
      securityGroup - Security Group to assign to this file system.
      Returns:
      this
    • storageType

      @Stability(Stable) public FileSystemProps.Builder storageType(StorageType storageType)
      Parameters:
      storageType - The storage type for the file system that you're creating.
      Returns:
      this
    • build

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