Class FileSystemProps
Properties for the FSx file system.
Inheritance
Implements
Namespace: Amazon.CDK.AWS.FSx
Assembly: Amazon.CDK.AWS.FSx.dll
Syntax (csharp)
public class FileSystemProps : Object, IFileSystemProps
Syntax (vb)
Public Class FileSystemProps
Inherits Object
Implements 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.AWS.EC2;
using Amazon.CDK.AWS.FSx;
using Amazon.CDK.AWS.KMS;
using Amazon.CDK;
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
};
Synopsis
Constructors
FileSystemProps() |
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. |
Vpc | The VPC to launch the file system in. |
Constructors
FileSystemProps()
public FileSystemProps()
Properties
BackupId
The ID of the backup.
public string BackupId { get; set; }
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.
public IKey KmsKey { get; set; }
Property Value
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.
public Nullable<RemovalPolicy> RemovalPolicy { get; set; }
Property Value
System.Nullable<RemovalPolicy>
Remarks
Default: RemovalPolicy.RETAIN
SecurityGroup
Security Group to assign to this file system.
public ISecurityGroup SecurityGroup { get; set; }
Property Value
Remarks
Default: - creates new security group which allows all outbound traffic.
StorageCapacityGiB
The storage capacity of the file system being created.
public double StorageCapacityGiB { get; set; }
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 and PERSISTENT_1 types, valid values are 1,200, 2,400, then continuing in increments of 2,400 GiB.