interface FileSystemProps
Language | Type name |
---|---|
![]() | Amazon.CDK.AWS.FSx.FileSystemProps |
![]() | github.com/aws/aws-cdk-go/awscdk/v2/awsfsx#FileSystemProps |
![]() | software.amazon.awscdk.services.fsx.FileSystemProps |
![]() | aws_cdk.aws_fsx.FileSystemProps |
![]() | aws-cdk-lib » aws_fsx » FileSystemProps |
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 * as cdk from 'aws-cdk-lib';
import { aws_ec2 as ec2 } from 'aws-cdk-lib';
import { aws_fsx as fsx } from 'aws-cdk-lib';
import { aws_kms as kms } from 'aws-cdk-lib';
declare const key: kms.Key;
declare const securityGroup: ec2.SecurityGroup;
declare const vpc: ec2.Vpc;
const fileSystemProps: fsx.FileSystemProps = {
storageCapacityGiB: 123,
vpc: vpc,
// the properties below are optional
backupId: 'backupId',
kmsKey: key,
removalPolicy: cdk.RemovalPolicy.DESTROY,
securityGroup: securityGroup,
storageType: fsx.StorageType.SSD,
};
Properties
Name | Type | Description |
---|---|---|
storage | number | The storage capacity of the file system being created. |
vpc | IVpc | The VPC to launch the file system in. |
backup | string | The ID of the backup. |
kms | IKey | The KMS key used for encryption to protect your data at rest. |
removal | Removal | Policy to apply when the file system is removed from the stack. |
security | ISecurity | Security Group to assign to this file system. |
storage | Storage | The storage type for the file system that you're creating. |
storageCapacityGiB
Type:
number
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.
vpc
Type:
IVpc
The VPC to launch the file system in.
backupId?
Type:
string
(optional, default: no backup will be used.)
The ID of the backup.
Specifies the backup to use if you're creating a file system from an existing backup.
kmsKey?
Type:
IKey
(optional, default: the aws/fsx default KMS key for the AWS account being deployed into.)
The KMS key used for encryption to protect your data at rest.
removalPolicy?
Type:
Removal
(optional, default: RemovalPolicy.RETAIN)
Policy to apply when the file system is removed from the stack.
securityGroup?
Type:
ISecurity
(optional, default: creates new security group which allows all outbound traffic.)
Security Group to assign to this file system.
storageType?
Type:
Storage
(optional, default: StorageType.SSD)
The storage type for the file system that you're creating.