Interface FileSystemProps
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Subinterfaces:
LustreFileSystemProps
- All Known Implementing Classes:
FileSystemProps.Jsii$Proxy
,LustreFileSystemProps.Jsii$Proxy
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) .storageType(StorageType.SSD) .build();
- See Also:
-
Nested Class Summary
Modifier and TypeInterfaceDescriptionstatic final class
A builder forFileSystemProps
static final class
An implementation forFileSystemProps
-
Method Summary
Modifier and TypeMethodDescriptionstatic FileSystemProps.Builder
builder()
default String
The ID of the backup.default IKey
The KMS key used for encryption to protect your data at rest.default RemovalPolicy
Policy to apply when the file system is removed from the stack.default ISecurityGroup
Security Group to assign to this file system.The storage capacity of the file system being created.default StorageType
The storage type for the file system that you're creating.getVpc()
The VPC to launch the file system in.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
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, 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.
-
getVpc
The VPC to launch the file system in. -
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
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
Policy to apply when the file system is removed from the stack.Default: RemovalPolicy.RETAIN
-
getSecurityGroup
Security Group to assign to this file system.Default: - creates new security group which allows all outbound traffic.
-
getStorageType
The storage type for the file system that you're creating.Default: StorageType.SSD
- See Also:
-
builder
- Returns:
- a
FileSystemProps.Builder
ofFileSystemProps
-