FileSystemProps Struct
Properties for the FSx file system.
| Source | aws-fsx/lib/file-system.ts |
|---|---|
| Type last changed |
Example
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as cdk from 'aws-cdk-lib';
import { aws_ec2 as ec2 } from 'aws-cdk-lib';
import { aws_fsx as fsx } from 'aws-cdk-lib';
import { aws_kms as interfaces_kms } from 'aws-cdk-lib/interfaces';
declare const keyRef: interfaces_kms.IKeyRef;
declare const securityGroup: ec2.SecurityGroup;
declare const vpc: ec2.Vpc;
const fileSystemProps: fsx.FileSystemProps = {
storageCapacityGiB: 123,
vpc: vpc,
// the properties below are optional
backupId: 'backupId',
kmsKey: keyRef,
removalPolicy: cdk.RemovalPolicy.DESTROY,
securityGroup: securityGroup,
storageType: fsx.StorageType.SSD,
};
# 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.interfaces import aws_kms as interfaces_kms
# key_ref: interfaces_kms.IKeyRef
# 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_ref,
removal_policy=cdk.RemovalPolicy.DESTROY,
security_group=security_group,
storage_type=fsx.StorageType.SSD
)
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.*;
import software.amazon.awscdk.services.ec2.*;
import software.amazon.awscdk.services.fsx.*;
import software.amazon.awscdk.interfaces.kms.*;
IKeyRef keyRef;
SecurityGroup securityGroup;
Vpc vpc;
FileSystemProps fileSystemProps = FileSystemProps.builder()
.storageCapacityGiB(123)
.vpc(vpc)
// the properties below are optional
.backupId("backupId")
.kmsKey(keyRef)
.removalPolicy(RemovalPolicy.DESTROY)
.securityGroup(securityGroup)
.storageType(StorageType.SSD)
.build();
// Install: dotnet add package Amazon.CDK.Lib
// 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.Interfaces.KMS;
IKeyRef keyRef;
SecurityGroup securityGroup;
Vpc vpc;
var fileSystemProps = new FileSystemProps {
StorageCapacityGiB = 123,
Vpc = vpc,
// the properties below are optional
BackupId = "backupId",
KmsKey = keyRef,
RemovalPolicy = RemovalPolicy.DESTROY,
SecurityGroup = securityGroup,
StorageType = StorageType.SSD
};
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import cdk "github.com/aws/aws-cdk-go/awscdk"
import "github.com/aws/aws-cdk-go/awscdk"
import "github.com/aws/aws-cdk-go/awscdk"
import "github.com/aws/aws-cdk-go/awscdk"
var keyRef IKeyRef
var securityGroup SecurityGroup
var vpc Vpc
fileSystemProps := &FileSystemProps{
StorageCapacityGiB: jsii.Number(123),
Vpc: vpc,
// the properties below are optional
BackupId: jsii.String("backupId"),
KmsKey: keyRef,
RemovalPolicy: cdk.RemovalPolicy_DESTROY,
SecurityGroup: securityGroup,
StorageType: awscdk.Aws_fsx.StorageType_SSD,
}
Properties
backupIdoptionalstringbackup_idoptionalstrbackupIdoptionalStringBackupIdoptionalstringBackupIdoptional*string #Default: no backup will be used.
Specifies the backup to use if you're creating a file system from an existing backup.
kmsKeyoptionalIKeyRefkms_keyoptionalIKeyRefkmsKeyoptionalIKeyRefKmsKeyoptionalIKeyRefKmsKeyoptionalIKeyRef #Default: the aws/fsx default KMS key for the AWS account being deployed into.
removalPolicyoptionalRemovalPolicyremoval_policyoptionalRemovalPolicyremovalPolicyoptionalRemovalPolicyRemovalPolicyoptionalRemovalPolicyRemovalPolicyoptionalRemovalPolicy = RemovalPolicy.RETAIN #securityGroupoptionalISecurityGroupsecurity_groupoptionalISecurityGroupsecurityGroupoptionalISecurityGroupSecurityGroupoptionalISecurityGroupSecurityGroupoptionalISecurityGroup #Default: creates new security group which allows all outbound traffic.
storageCapacityGiBnumberstorage_capacity_gi_bint | floatstorageCapacityGiBNumberStorageCapacityGiBdoubleStorageCapacityGiB*float64 required #notes
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.
storageTypeoptionalStorageTypestorage_typeoptionalStorageTypestorageTypeoptionalStorageTypeStorageTypeoptionalStorageTypeStorageTypeoptionalStorageType = StorageType.SSD #