aws-cdk-lib.aws_fsx.FileSystemBase

class FileSystemBase

LanguageType name
.NETAmazon.CDK.AWS.FSx.FileSystemBase
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsfsx#FileSystemBase
Javasoftware.amazon.awscdk.services.fsx.FileSystemBase
Pythonaws_cdk.aws_fsx.FileSystemBase
TypeScript (source)aws-cdk-lib » aws_fsx » FileSystemBase

Implements IConstruct, IDependable, IResource, IFileSystem, IConnectable

Extends Resource

Implemented by LustreFileSystem

A new or imported FSx file system.

Initializer

new FileSystemBase(scope: Construct, id: string, props?: ResourceProps)

Parameters

  • scope Construct
  • id string
  • props ResourceProps

Properties

NameTypeDescription
connectionsConnectionsThe security groups/rules used to allow network connections to the file system.
dnsNamestringThe DNS name assigned to this file system.
envResourceEnvironmentThe environment this resource belongs to.
fileSystemIdstringThe ID of the file system, assigned by Amazon FSx.
nodeNodeThe tree node.
stackStackThe stack in which this resource is defined.

connections

Type: Connections

The security groups/rules used to allow network connections to the file system.


dnsName

Type: string

The DNS name assigned to this file system.


env

Type: ResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.


fileSystemId

Type: string

The ID of the file system, assigned by Amazon FSx.


node

Type: Node

The tree node.


stack

Type: Stack

The stack in which this resource is defined.

Methods

NameDescription
applyRemovalPolicy(policy)Apply the given removal policy to this resource.
toString()Returns a string representation of this construct.

applyRemovalPolicy(policy)

public applyRemovalPolicy(policy: RemovalPolicy): void

Parameters

  • policy RemovalPolicy

Apply the given removal policy to this resource.

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


toString()

public toString(): string

Returns

  • string

Returns a string representation of this construct.