Interface FileSystemProps

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Subinterfaces:
LustreFileSystemProps
All Known Implementing Classes:
FileSystemProps.Jsii$Proxy, LustreFileSystemProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.98.0 (build 00b106d)", date="2024-05-17T05:10:11.581Z") @Stability(Stable) public interface FileSystemProps extends software.amazon.jsii.JsiiSerializable
Properties for the FSx file system.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.*;
 import software.amazon.awscdk.services.ec2.*;
 import software.amazon.awscdk.services.fsx.*;
 import software.amazon.awscdk.services.kms.*;
 Key key;
 SecurityGroup securityGroup;
 Vpc vpc;
 FileSystemProps fileSystemProps = FileSystemProps.builder()
         .storageCapacityGiB(123)
         .vpc(vpc)
         // the properties below are optional
         .backupId("backupId")
         .kmsKey(key)
         .removalPolicy(RemovalPolicy.DESTROY)
         .securityGroup(securityGroup)
         .build();
 

See Also:
  • Method Details

    • getStorageCapacityGiB

      @Stability(Stable) @NotNull Number getStorageCapacityGiB()
      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 and PERSISTENT_1 types, valid values are 1,200, 2,400, then continuing in increments of 2,400 GiB.

    • getVpc

      @Stability(Stable) @NotNull IVpc getVpc()
      The VPC to launch the file system in.
    • getBackupId

      @Stability(Stable) @Nullable default String getBackupId()
      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.

    • getKmsKey

      @Stability(Stable) @Nullable default IKey getKmsKey()
      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.

    • getRemovalPolicy

      @Stability(Stable) @Nullable default RemovalPolicy getRemovalPolicy()
      Policy to apply when the file system is removed from the stack.

      Default: RemovalPolicy.RETAIN

    • getSecurityGroup

      @Stability(Stable) @Nullable default ISecurityGroup getSecurityGroup()
      Security Group to assign to this file system.

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

    • builder

      @Stability(Stable) static FileSystemProps.Builder builder()
      Returns:
      a FileSystemProps.Builder of FileSystemProps