AWS CDK Reference

Appearance

v2.275.0

FileSystemProps Struct ​

Properties for the FSx file system.

Source
aws-fsx/lib/file-system.ts
Type last changed
v2.224.0 · 13 Nov 2025

Example ​

ts
// 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 interfaces_kms } from 'aws-cdk-lib/interfaces';

declare const keyRef: interfaces_kms.IKeyRef;
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: keyRef,
  removalPolicy: cdk.RemovalPolicy.DESTROY,
  securityGroup: securityGroup,
  storageType: fsx.StorageType.SSD,
};

Properties ​

backupIdoptionalstringbackup_idoptionalstrbackupIdoptionalStringBackupIdoptionalstringBackupIdoptional*string#
The ID of the backup.

Default: no backup will be used.

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

kmsKeyoptionalIKeyRefkms_keyoptionalIKeyRefkmsKeyoptionalIKeyRefKmsKeyoptionalIKeyRefKmsKeyoptionalIKeyRef#
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.

removalPolicyoptionalRemovalPolicyremoval_policyoptionalRemovalPolicyremovalPolicyoptionalRemovalPolicyRemovalPolicyoptionalRemovalPolicyRemovalPolicyoptionalRemovalPolicy= RemovalPolicy.RETAIN#
Policy to apply when the file system is removed from the stack.
securityGroupoptionalISecurityGroupsecurity_groupoptionalISecurityGroupsecurityGroupoptionalISecurityGroupSecurityGroupoptionalISecurityGroupSecurityGroupoptionalISecurityGroup#
Security Group to assign to this file system.

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

storageCapacityGiBnumberstorage_capacity_gi_bint | floatstorageCapacityGiBNumberStorageCapacityGiBdoubleStorageCapacityGiB*float64required#
The storage capacity of the file system being created.
notes

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.

storageTypeoptionalStorageTypestorage_typeoptionalStorageTypestorageTypeoptionalStorageTypeStorageTypeoptionalStorageTypeStorageTypeoptionalStorageType= StorageType.SSD#
The storage type for the file system that you're creating.
vpcIVpcvpcIVpcvpcIVpcVpcIVpcVpcIVpcrequired#
The VPC to launch the file system in.