Interface IFileSystemProps

Properties for the FSx file system.

Namespace: Amazon.CDK.AWS.FSx
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public interface IFileSystemProps
Syntax (vb)
Public Interface IFileSystemProps
Remarks

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

ExampleMetadata: fixture=_generated

Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK;
using Amazon.CDK.AWS.EC2;
using Amazon.CDK.AWS.FSx;
using Amazon.CDK.AWS.KMS;

Key key;
SecurityGroup securityGroup;
Vpc vpc;

var fileSystemProps = new FileSystemProps {
    StorageCapacityGiB = 123,
    Vpc = vpc,

    // the properties below are optional
    BackupId = "backupId",
    KmsKey = key,
    RemovalPolicy = RemovalPolicy.DESTROY,
    SecurityGroup = securityGroup,
    StorageType = StorageType.SSD
};

Synopsis

Properties

BackupId

The ID of the backup.
KmsKey

The KMS key used for encryption to protect your data at rest.
RemovalPolicy

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

Security Group to assign to this file system.
StorageCapacityGiB

The storage capacity of the file system being created.
StorageType

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

The VPC to launch the file system in.

Properties

BackupId

The ID of the backup.

virtual string BackupId { get; }
Property Value

System.String

Remarks

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

Default: - no backup will be used.

KmsKey

The KMS key used for encryption to protect your data at rest.

virtual IKey KmsKey { get; }
Property Value

IKey

Remarks

Default: - the aws/fsx default KMS key for the AWS account being deployed into.

RemovalPolicy

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

virtual Nullable<RemovalPolicy> RemovalPolicy { get; }
Property Value

System.Nullable<RemovalPolicy>

Remarks

Default: RemovalPolicy.RETAIN

SecurityGroup

Security Group to assign to this file system.

virtual ISecurityGroup SecurityGroup { get; }
Property Value

ISecurityGroup

Remarks

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

StorageCapacityGiB

The storage capacity of the file system being created.

double StorageCapacityGiB { get; }
Property Value

System.Double

Remarks

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.

StorageType

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

virtual Nullable<StorageType> StorageType { get; }
Property Value

System.Nullable<StorageType>

Remarks

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.

IVpc Vpc { get; }
Property Value

IVpc