This documentation is for the developer preview release of the AWS CDK. Do not use this version of the AWS CDK in production. Subsequent releases of the AWS CDK will likely include breaking changes.

@aws-cdk/aws-fsx

AWS::FSx Construct Library

This module is part of the AWS Cloud Development Kit project.

import fsx = require('@aws-cdk/aws-fsx');

Reference

View in Nuget

csproj:

<PackageReference Include="Amazon.CDK.AWS.FSx" Version="0.28.0" />

dotnet:

dotnet add package Amazon.CDK.AWS.FSx --version 0.28.0

packages.config:

<package id="Amazon.CDK.AWS.FSx" version="0.28.0" />

View in Maven Central

Apache Buildr:

'software.amazon.awscdk:fsx:jar:0.28.0'

Apache Ivy:

<dependency groupId="software.amazon.awscdk" name="fsx" rev="0.28.0"/>

Apache Maven:

<dependency>
  <groupId>software.amazon.awscdk</groupId>
  <artifactId>fsx</artifactId>
  <version>0.28.0</version>
</dependency>

Gradle / Grails:

compile 'software.amazon.awscdk:fsx:0.28.0'

Groovy Grape:

@Grapes(
@Grab(group='software.amazon.awscdk', module='fsx', version='0.28.0')
)

View in NPM

npm:

$ npm i @aws-cdk/aws-fsx@0.28.0

package.json:

{
  "@aws-cdk/aws-fsx": "^0.28.0"
}

yarn:

$ yarn add @aws-cdk/aws-fsx@0.28.0

View in NPM

npm:

$ npm i @aws-cdk/aws-fsx@0.28.0

package.json:

{
  "@aws-cdk/aws-fsx": "^0.28.0"
}

yarn:

$ yarn add @aws-cdk/aws-fsx@0.28.0

CfnFileSystem

class @aws-cdk/aws-fsx.CfnFileSystem(scope, id[, props])

Language-specific names:

using Amazon.CDK.AWS.FSx;
import software.amazon.awscdk.services.fsx.CfnFileSystem;
const { CfnFileSystem } = require('@aws-cdk/aws-fsx');
import { CfnFileSystem } from '@aws-cdk/aws-fsx';

A CloudFormation AWS::FSx::FileSystem

Extends:

@aws-cdk/cdk.CfnResource

Parameters:
renderProperties(properties) → string => any

Overrides @aws-cdk/cdk.CfnResource.renderProperties()

Protected method

Parameters:properties (any) –
Return type:string => any
resourceTypeName

The CloudFormation resource type name for this resource class.

Type:string (readonly) (static)
fileSystemId
Type:string (readonly)
propertyOverrides
Type:CfnFileSystemProps (readonly)
class LustreConfigurationProperty

Language-specific names:

using Amazon.CDK.AWS.FSx;
import software.amazon.awscdk.services.fsx.CfnFileSystem.LustreConfigurationProperty;
// CfnFileSystem.LustreConfigurationProperty is an interface
import { CfnFileSystem.LustreConfigurationProperty } from '@aws-cdk/aws-fsx';
exportPath

CfnFileSystem.LustreConfigurationProperty.ExportPath

Type:string (optional) (readonly)
importedFileChunkSize

CfnFileSystem.LustreConfigurationProperty.ImportedFileChunkSize

Type:number or @aws-cdk/cdk.Token (optional) (readonly)
importPath

CfnFileSystem.LustreConfigurationProperty.ImportPath

Type:string (optional) (readonly)
weeklyMaintenanceStartTime

CfnFileSystem.LustreConfigurationProperty.WeeklyMaintenanceStartTime

Type:string (optional) (readonly)
class TagEntryProperty

Language-specific names:

using Amazon.CDK.AWS.FSx;
import software.amazon.awscdk.services.fsx.CfnFileSystem.TagEntryProperty;
// CfnFileSystem.TagEntryProperty is an interface
import { CfnFileSystem.TagEntryProperty } from '@aws-cdk/aws-fsx';
key

CfnFileSystem.TagEntryProperty.Key

Type:string (readonly)
value

CfnFileSystem.TagEntryProperty.Value

Type:string (readonly)
class WindowsConfigurationProperty

Language-specific names:

using Amazon.CDK.AWS.FSx;
import software.amazon.awscdk.services.fsx.CfnFileSystem.WindowsConfigurationProperty;
// CfnFileSystem.WindowsConfigurationProperty is an interface
import { CfnFileSystem.WindowsConfigurationProperty } from '@aws-cdk/aws-fsx';
activeDirectoryId

CfnFileSystem.WindowsConfigurationProperty.ActiveDirectoryId

Type:string (optional) (readonly)
automaticBackupRetentionDays

CfnFileSystem.WindowsConfigurationProperty.AutomaticBackupRetentionDays

Type:number or @aws-cdk/cdk.Token (optional) (readonly)
copyTagsToBackups

CfnFileSystem.WindowsConfigurationProperty.CopyTagsToBackups

Type:boolean or @aws-cdk/cdk.Token (optional) (readonly)
dailyAutomaticBackupStartTime

CfnFileSystem.WindowsConfigurationProperty.DailyAutomaticBackupStartTime

Type:string (optional) (readonly)
throughputCapacity

CfnFileSystem.WindowsConfigurationProperty.ThroughputCapacity

Type:number or @aws-cdk/cdk.Token (optional) (readonly)
weeklyMaintenanceStartTime

CfnFileSystem.WindowsConfigurationProperty.WeeklyMaintenanceStartTime

Type:string (optional) (readonly)
overrideLogicalId(newLogicalId)

Inherited from @aws-cdk/cdk.CfnElement

Overrides the auto-generated logical ID with a specific ID.

Parameters:newLogicalId (string) – The new logical ID to use for this stack element.
prepare()

Inherited from @aws-cdk/cdk.CfnElement

Automatically detect references in this CfnElement

Protected method

creationStackTrace

Inherited from @aws-cdk/cdk.CfnElement

Type:string[] (readonly)
logicalId

Inherited from @aws-cdk/cdk.CfnElement

The logical ID for this CloudFormation stack element. The logical ID of the element

is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

Type:string (readonly)
stackPath

Inherited from @aws-cdk/cdk.CfnElement

Return the path with respect to the stack

Type:string (readonly)
ref

Inherited from @aws-cdk/cdk.CfnRefElement

Returns a token to a CloudFormation { Ref } that references this entity based on it’s logical ID.

Type:string (readonly)
referenceToken

Inherited from @aws-cdk/cdk.CfnRefElement

Return a token that will CloudFormation { Ref } this stack element

Protected property

Type:@aws-cdk/cdk.Token (readonly)
addDeletionOverride(path)

Inherited from @aws-cdk/cdk.CfnResource

Syntactic sugar for addOverride(path, undefined).

Parameters:path (string) – The path of the value to delete
addDependsOn(resource)

Inherited from @aws-cdk/cdk.CfnResource

Indicates that this resource depends on another resource and cannot be provisioned

unless the other resource has been successfully provisioned.

Parameters:resource (@aws-cdk/cdk.CfnResource) –
addOverride(path, value)

Inherited from @aws-cdk/cdk.CfnResource

Adds an override to the synthesized CloudFormation resource. To add a

property override, either use addPropertyOverride or prefix path with

“Properties.” (i.e. Properties.TopicName).

Parameters:
  • path (string) – The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.
  • value (any) – The value. Could be primitive or complex.
addPropertyDeletionOverride(propertyPath)

Inherited from @aws-cdk/cdk.CfnResource

Adds an override that deletes the value of a property from the resource definition.

Parameters:propertyPath (string) – The path to the property.
addPropertyOverride(propertyPath, value)

Inherited from @aws-cdk/cdk.CfnResource

Adds an override to a resource property.

Syntactic sugar for addOverride(“Properties.<…>”, value).

Parameters:
  • propertyPath (string) – The path of the property
  • value (any) – The value
getAtt(attributeName) → @aws-cdk/cdk.CfnReference

Inherited from @aws-cdk/cdk.CfnResource

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility

in case there is no generated attribute.

Parameters:attributeName (string) – The name of the attribute.
Return type:@aws-cdk/cdk.CfnReference
options

Inherited from @aws-cdk/cdk.CfnResource

Options for this resource, such as condition, update policy etc.

Type:@aws-cdk/cdk.IResourceOptions (readonly)
properties

Inherited from @aws-cdk/cdk.CfnResource

AWS resource properties.

This object is rendered via a call to “renderProperties(this.properties)”.

Protected property

Type:any (readonly)
resourceType

Inherited from @aws-cdk/cdk.CfnResource

AWS resource type.

Type:string (readonly)
untypedPropertyOverrides

Inherited from @aws-cdk/cdk.CfnResource

AWS resource property overrides.

During synthesis, the method “renderProperties(this.overrides)” is called

with this object, and merged on top of the output of

“renderProperties(this.properties)”.

Derived classes should expose a strongly-typed version of this object as

a public property called propertyOverrides.

Protected property

Type:any (readonly)
toString() → string

Inherited from @aws-cdk/cdk.Construct

Returns a string representation of this construct.

Return type:string
validate() → string[]

Inherited from @aws-cdk/cdk.Construct

Validate the current construct.

This method can be implemented by derived constructs in order to perform

validation logic. It is called on all constructs before synthesis.

Protected method

Returns:An array of validation error messages, or an empty array if there the construct is valid.
Return type:string[]
dependencyRoots

Inherited from @aws-cdk/cdk.Construct

The set of constructs that form the root of this dependable

All resources under all returned constructs are included in the ordering

dependency.

Type:@aws-cdk/cdk.IConstruct[] (readonly)
node

Inherited from @aws-cdk/cdk.Construct

Construct node.

Type:@aws-cdk/cdk.ConstructNode (readonly)

CfnFileSystemProps (interface)

class @aws-cdk/aws-fsx.CfnFileSystemProps

Language-specific names:

using Amazon.CDK.AWS.FSx;
import software.amazon.awscdk.services.fsx.CfnFileSystemProps;
// CfnFileSystemProps is an interface
import { CfnFileSystemProps } from '@aws-cdk/aws-fsx';

Properties for defining a AWS::FSx::FileSystem

backupId

AWS::FSx::FileSystem.BackupId

Type:string (optional) (readonly)
fileSystemType

AWS::FSx::FileSystem.FileSystemType

Type:string (optional) (readonly)
kmsKeyId

AWS::FSx::FileSystem.KmsKeyId

Type:string (optional) (readonly)
lustreConfiguration

AWS::FSx::FileSystem.LustreConfiguration

Type:LustreConfigurationProperty or @aws-cdk/cdk.Token (optional) (readonly)
securityGroupIds

AWS::FSx::FileSystem.SecurityGroupIds

Type:string[] (optional) (readonly)
storageCapacity

AWS::FSx::FileSystem.StorageCapacity

Type:number or @aws-cdk/cdk.Token (optional) (readonly)
subnetIds

AWS::FSx::FileSystem.SubnetIds

Type:string[] (optional) (readonly)
tags

AWS::FSx::FileSystem.Tags

Type:TagEntryProperty[] (optional) (readonly)
windowsConfiguration

AWS::FSx::FileSystem.WindowsConfiguration

Type:@aws-cdk/cdk.Token or WindowsConfigurationProperty (optional) (readonly)