LustreFileSystem L2 construct
The FSx for Lustre File System implementation of IFileSystem.
Example
import { aws_s3 as s3 } from 'aws-cdk-lib';
declare const vpc: ec2.Vpc;
declare const bucket: s3.Bucket;
const lustreConfiguration = {
deploymentType: fsx.LustreDeploymentType.SCRATCH_2,
exportPath: bucket.s3UrlForObject(),
importPath: bucket.s3UrlForObject(),
autoImportPolicy: fsx.LustreAutoImportPolicy.NEW_CHANGED_DELETED,
};
const fs = new fsx.LustreFileSystem(this, "FsxLustreFileSystem", {
vpc: vpc,
vpcSubnet: vpc.privateSubnets[0],
storageCapacityGiB: 1200,
lustreConfiguration,
});
from aws_cdk import aws_s3 as s3
# vpc: ec2.Vpc
# bucket: s3.Bucket
lustre_configuration = {
"deployment_type": fsx.LustreDeploymentType.SCRATCH_2,
"export_path": bucket.s3_url_for_object(),
"import_path": bucket.s3_url_for_object(),
"auto_import_policy": fsx.LustreAutoImportPolicy.NEW_CHANGED_DELETED
}
fs = fsx.LustreFileSystem(self, "FsxLustreFileSystem",
vpc=vpc,
vpc_subnet=vpc.private_subnets[0],
storage_capacity_gi_b=1200,
lustre_configuration=lustre_configuration
)
import software.amazon.awscdk.services.s3.*;
Vpc vpc;
Bucket bucket;
Map<String, Object> lustreConfiguration = Map.of(
"deploymentType", LustreDeploymentType.SCRATCH_2,
"exportPath", bucket.s3UrlForObject(),
"importPath", bucket.s3UrlForObject(),
"autoImportPolicy", LustreAutoImportPolicy.NEW_CHANGED_DELETED);
LustreFileSystem fs = LustreFileSystem.Builder.create(this, "FsxLustreFileSystem")
.vpc(vpc)
.vpcSubnet(vpc.getPrivateSubnets()[0])
.storageCapacityGiB(1200)
.lustreConfiguration(lustreConfiguration)
.build();
// Install: dotnet add package Amazon.CDK.Lib
using Amazon.CDK.AWS.S3;
Vpc vpc;
Bucket bucket;
IDictionary<string, object> lustreConfiguration = new Dictionary<string, object> {
{ "deploymentType", LustreDeploymentType.SCRATCH_2 },
{ "exportPath", bucket.S3UrlForObject() },
{ "importPath", bucket.S3UrlForObject() },
{ "autoImportPolicy", LustreAutoImportPolicy.NEW_CHANGED_DELETED }
};
var fs = new LustreFileSystem(this, "FsxLustreFileSystem", new LustreFileSystemProps {
Vpc = vpc,
VpcSubnet = vpc.PrivateSubnets[0],
StorageCapacityGiB = 1200,
LustreConfiguration = lustreConfiguration
});
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
import "github.com/aws/aws-cdk-go/awscdk"
var vpc Vpc
var bucket Bucket
lustreConfiguration := map[string]interface{}{
"deploymentType": fsx.LustreDeploymentType_SCRATCH_2,
"exportPath": bucket.s3UrlForObject(),
"importPath": bucket.s3UrlForObject(),
"autoImportPolicy": fsx.LustreAutoImportPolicy_NEW_CHANGED_DELETED,
}
fs := fsx.NewLustreFileSystem(this, jsii.String("FsxLustreFileSystem"), &LustreFileSystemProps{
Vpc: vpc,
VpcSubnet: vpc.PrivateSubnets[jsii.Number(0)],
StorageCapacityGiB: jsii.Number(1200),
LustreConfiguration: LustreConfiguration,
})
Initializer
new LustreFileSystem(scope: Construct, id: string, props: LustreFileSystemProps)
LustreFileSystem(scope: Construct, id: str, props: LustreFileSystemProps)
new LustreFileSystem(Construct scope, String id, LustreFileSystemProps props)
new LustreFileSystem(Construct scope, string id, LustreFileSystemProps props)
NewLustreFileSystem(Scope Construct, Id *string, Props LustreFileSystemProps)
Construct Props
Specifies the backup to use if you're creating a file system from an existing backup.
fileSystemTypeVersionFileSystemTypeVersionfile_system_type_versionFileSystemTypeVersionfileSystemTypeVersionFileSystemTypeVersionFileSystemTypeVersionFileSystemTypeVersionFileSystemTypeVersionFileSystemTypeVersion= V_2_10, except for PERSISTENT_2 …#default
Default: V_2_10, except for PERSISTENT_2 deployment type, where it is V_2_12 without metadata configuration mode and V_2_15 with metadata configuration mode.
kmsKeyIKeyRefkms_keyIKeyRefkmsKeyIKeyRefKmsKeyIKeyRefKmsKeyIKeyRef= the aws/fsx default KMS key for …#default
Default: the aws/fsx default KMS key for the AWS account being deployed into.
lustreConfigurationLustreConfigurationlustre_configurationLustreConfigurationlustreConfigurationLustreConfigurationLustreConfigurationLustreConfigurationLustreConfigurationLustreConfigurationrequired#removalPolicyRemovalPolicyremoval_policyRemovalPolicyremovalPolicyRemovalPolicyRemovalPolicyRemovalPolicyRemovalPolicyRemovalPolicy= RemovalPolicy.RETAIN#securityGroupISecurityGroupsecurity_groupISecurityGroupsecurityGroupISecurityGroupSecurityGroupISecurityGroupSecurityGroupISecurityGroup= creates new security group which…#default
Default: creates new security group which allows all outbound traffic.
storageCapacityGiBnumberstorage_capacity_gi_bint | floatstorageCapacityGiBNumberStorageCapacityGiBdoubleStorageCapacityGiB*float64required#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.
storageTypeStorageTypestorage_typeStorageTypestorageTypeStorageTypeStorageTypeStorageTypeStorageTypeStorageType= StorageType.SSD#Properties
connectionsConnectionsconnectionsConnectionsconnectionsConnectionsConnectionsConnectionsConnectionsConnectionsrequired#envResourceEnvironmentenvResourceEnvironmentenvResourceEnvironmentEnvResourceEnvironmentEnvResourceEnvironmentrequired#notes
For resources that are created and managed in a Stack (those created by creating new class instances like new Role(), new Bucket(), etc.), this is always the same as the environment of the stack they belong to.
For referenced resources (those obtained from referencing methods like Role.fromRoleArn(), Bucket.fromBucketName(), etc.), they might be different than the stack they were imported into.
PROPERTY_INJECTION_IDstringproperty_injection_idstrPROPERTY_INJECTION_IDStringPROPERTY_INJECTION_IDstringPROPERTY_INJECTION_ID*stringrequiredstatic#Methods
applyCrossStackReferenceStrength(strength: ReferenceStrength): voiddef apply_cross_stack_reference_strength(self, strength: ReferenceStrength) -> Nonepublic void applyCrossStackReferenceStrength(ReferenceStrength strength)public void ApplyCrossStackReferenceStrength(ReferenceStrength strength)func ApplyCrossStackReferenceStrength(Strength ReferenceStrength)#notes · 1 parameter
When set, any cross-stack reference to this resource will use the specified mechanism instead of the global default determined by the @aws-cdk/core:defaultCrossStackReferences context key. This is useful for selectively weakening specific references to avoid the "deadly embrace" problem without changing the app-wide default.
Parameters
strengthstrengthstrengthstrengthStrength— - The reference strength to use for this resource.
applyRemovalPolicy(policy: RemovalPolicy): voiddef apply_removal_policy(self, policy: RemovalPolicy) -> Nonepublic void applyRemovalPolicy(RemovalPolicy policy)public void ApplyRemovalPolicy(RemovalPolicy policy)func ApplyRemovalPolicy(Policy RemovalPolicy)#notes
The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.
The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).
fromLustreFileSystemAttributes(scope: Construct, id: string, attrs: FileSystemAttributes): IFileSystem@staticmethod def from_lustre_file_system_attributes(scope: Construct, id: str, attrs: FileSystemAttributes) -> IFileSystempublic static IFileSystem fromLustreFileSystemAttributes(Construct scope, String id, FileSystemAttributes attrs)public static IFileSystem FromLustreFileSystemAttributes(Construct scope, string id, FileSystemAttributes attrs)func FromLustreFileSystemAttributes(Scope Construct, Id *string, Attrs FileSystemAttributes) IFileSystemstatic#isConstruct(x: any): boolean@staticmethod def is_construct(x: Any) -> boolpublic static Boolean isConstruct(Object x)public static bool IsConstruct(object x)func IsConstruct(X interface{}) *boolstatic#notes · 1 parameter · returns
Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.
Parameters
xxxxX— Any object.
Returns: true if x is an object created from a class which extends Construct.
isOwnedResource(construct: IConstruct): boolean@staticmethod def is_owned_resource(construct: IConstruct) -> boolpublic static Boolean isOwnedResource(IConstruct construct)public static bool IsOwnedResource(IConstruct construct)func IsOwnedResource(Construct IConstruct) *boolstatic#isResource(construct: IConstruct): boolean@staticmethod def is_resource(construct: IConstruct) -> boolpublic static Boolean isResource(IConstruct construct)public static bool IsResource(IConstruct construct)func IsResource(Construct IConstruct) *boolstatic#toString(): stringdef to_string(self, ) -> strpublic String toString()public string ToString()func ToString() *string#with(...mixins: IMixin[]): IConstructdef with(self, mixins: IMixin) -> IConstructpublic IConstruct with(IMixin mixins)public IConstruct With(IMixin mixins)func With(Mixins IMixin) IConstruct#Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.