FileSystemProps¶

class aws_cdk.aws_fsx.FileSystemProps(*, storage_capacity_gib, vpc, backup_id=None, kms_key=None, removal_policy=None, security_group=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 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.

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.aws_ec2 as ec2
import aws_cdk.aws_fsx as fsx
import aws_cdk.aws_kms as kms
import aws_cdk.core as cdk

# 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
)

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.

Return type

Optional[str]

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.

Return type

Optional[IKey]

removal_policy¶

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

Default: RemovalPolicy.RETAIN
Return type: Optional[RemovalPolicy]

security_group¶

Security Group to assign to this file system.

Default

creates new security group which allows all outbound traffic.

Return type

Optional[ISecurityGroup]

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.

Return type: Union[int, float]

vpc¶

The VPC to launch the file system in.

Return type: IVpc