FileSystemProps

class aws_cdk.aws_fsx.FileSystemProps(*, storage_capacity_gib, vpc, backup_id=None, kms_key=None, removal_policy=None, security_group=None, storage_type=None)

Bases: object

Properties for 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, 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 (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.

  • storage_type (Optional[StorageType]) – The storage type for the file system that you’re creating. Default: StorageType.SSD

See:

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-fsx-filesystem.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk as cdk
from aws_cdk import aws_ec2 as ec2
from aws_cdk import aws_fsx as fsx
from aws_cdk import aws_kms as kms

# key: kms.Key
# security_group: ec2.SecurityGroup
# vpc: ec2.Vpc

file_system_props = fsx.FileSystemProps(
    storage_capacity_gi_b=123,
    vpc=vpc,

    # the properties below are optional
    backup_id="backupId",
    kms_key=key,
    removal_policy=cdk.RemovalPolicy.DESTROY,
    security_group=security_group,
    storage_type=fsx.StorageType.SSD
)

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.

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, 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.

storage_type

The storage type for the file system that you’re creating.

Default:

StorageType.SSD

See:

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-fsx-filesystem.html#cfn-fsx-filesystem-storagetype

vpc

The VPC to launch the file system in.