LustreFileSystemProps

class aws_cdk.aws_fsx.LustreFileSystemProps(*, storage_capacity_gib, vpc, backup_id=None, kms_key=None, removal_policy=None, security_group=None, lustre_configuration, vpc_subnet)

Bases: FileSystemProps

Properties specific to the Lustre version of the FSx file system.

Parameters:
  • storage_capacity_gib (Union[int, float]) – 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.

  • vpc (IVpc) – The VPC to launch the file system in.

  • backup_id (Optional[str]) – 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.

  • kms_key (Optional[IKey]) – 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.

  • removal_policy (Optional[RemovalPolicy]) – Policy to apply when the file system is removed from the stack. Default: RemovalPolicy.RETAIN

  • security_group (Optional[ISecurityGroup]) – Security Group to assign to this file system. Default: - creates new security group which allows all outbound traffic.

  • lustre_configuration (Union[LustreConfiguration, Dict[str, Any]]) – Additional configuration for FSx specific to Lustre.

  • vpc_subnet (ISubnet) – The subnet that the file system will be accessible from.

ExampleMetadata:

infused

Example:

from aws_cdk import aws_s3 as s3

# vpc: ec2.Vpc
# bucket: s3.Bucket


lustre_configuration = {
    "deployment_type": fsx.LustreDeploymentType.SCRATCH_2,
    "export_path": bucket.s3_url_for_object(),
    "import_path": bucket.s3_url_for_object(),
    "auto_import_policy": fsx.LustreAutoImportPolicy.NEW_CHANGED_DELETED
}

fs = fsx.LustreFileSystem(self, "FsxLustreFileSystem",
    vpc=vpc,
    vpc_subnet=vpc.private_subnets[0],
    storage_capacity_gi_b=1200,
    lustre_configuration=lustre_configuration
)

Attributes

backup_id

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.

kms_key

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.

lustre_configuration

Additional configuration for FSx specific to Lustre.

removal_policy

Policy to apply when the file system is removed from the stack.

Default:

RemovalPolicy.RETAIN

security_group

Security Group to assign to this file system.

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

storage_capacity_gib

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.

vpc

The VPC to launch the file system in.

vpc_subnet

The subnet that the file system will be accessible from.