class CfnDataRepositoryAssociation (construct)
Language | Type name |
---|---|
![]() | Amazon.CDK.AWS.FSx.CfnDataRepositoryAssociation |
![]() | github.com/aws/aws-cdk-go/awscdk/v2/awsfsx#CfnDataRepositoryAssociation |
![]() | software.amazon.awscdk.services.fsx.CfnDataRepositoryAssociation |
![]() | aws_cdk.aws_fsx.CfnDataRepositoryAssociation |
![]() | aws-cdk-lib » aws_fsx » CfnDataRepositoryAssociation |
Implements
IConstruct
, IDependable
, IInspectable
, ITaggable
Creates an Amazon FSx for Lustre data repository association (DRA).
A data repository association is a link between a directory on the file system and an Amazon S3 bucket or prefix. You can have a maximum of 8 data repository associations on a file system. Data repository associations are supported on all FSx for Lustre 2.12 and newer file systems, excluding scratch_1
deployment type.
Each data repository association must have a unique Amazon FSx file system directory and a unique S3 bucket or prefix associated with it. You can configure a data repository association for automatic import only, for automatic export only, or for both. To learn more about linking a data repository to your file system, see Linking your file system to an S3 bucket .
Example
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_fsx as fsx } from 'aws-cdk-lib';
const cfnDataRepositoryAssociation = new fsx.CfnDataRepositoryAssociation(this, 'MyCfnDataRepositoryAssociation', {
dataRepositoryPath: 'dataRepositoryPath',
fileSystemId: 'fileSystemId',
fileSystemPath: 'fileSystemPath',
// the properties below are optional
batchImportMetaDataOnCreate: false,
importedFileChunkSize: 123,
s3: {
autoExportPolicy: {
events: ['events'],
},
autoImportPolicy: {
events: ['events'],
},
},
tags: [{
key: 'key',
value: 'value',
}],
});
Initializer
new CfnDataRepositoryAssociation(scope: Construct, id: string, props: CfnDataRepositoryAssociationProps)
Parameters
- scope
Construct
— Scope in which this resource is defined. - id
string
— Construct identifier for this resource (unique in its scope). - props
Cfn
— Resource properties.Data Repository Association Props
Construct Props
Name | Type | Description |
---|---|---|
data | string | The path to the Amazon S3 data repository that will be linked to the file system. |
file | string | The ID of the file system on which the data repository association is configured. |
file | string | A path on the Amazon FSx for Lustre file system that points to a high-level directory (such as /ns1/ ) or subdirectory (such as /ns1/subdir/ ) that will be mapped 1-1 with DataRepositoryPath . |
batch | boolean | IResolvable | A boolean flag indicating whether an import data repository task to import metadata should run after the data repository association is created. |
imported | number | For files imported from a data repository, this value determines the stripe count and maximum amount of data per file (in MiB) stored on a single physical disk. |
s3? | IResolvable | S3 | The configuration for an Amazon S3 data repository linked to an Amazon FSx Lustre file system with a data repository association. |
tags? | Cfn [] | A list of Tag values, with a maximum of 50 elements. |
dataRepositoryPath
Type:
string
The path to the Amazon S3 data repository that will be linked to the file system.
The path can be an S3 bucket or prefix in the format s3://myBucket/myPrefix/
. This path specifies where in the S3 data repository files will be imported from or exported to.
fileSystemId
Type:
string
The ID of the file system on which the data repository association is configured.
fileSystemPath
Type:
string
A path on the Amazon FSx for Lustre file system that points to a high-level directory (such as /ns1/
) or subdirectory (such as /ns1/subdir/
) that will be mapped 1-1 with DataRepositoryPath
.
The leading forward slash in the name is required. Two data repository associations cannot have overlapping file system paths. For example, if a data repository is associated with file system path /ns1/
, then you cannot link another data repository with file system path /ns1/ns2
.
This path specifies where in your file system files will be exported from or imported to. This file system directory can be linked to only one Amazon S3 bucket, and no other S3 bucket can be linked to the directory.
If you specify only a forward slash (
/
) as the file system path, you can link only one data repository to the file system. You can only specify "/" as the file system path for the first data repository associated with a file system.
batchImportMetaDataOnCreate?
Type:
boolean |
IResolvable
(optional)
A boolean flag indicating whether an import data repository task to import metadata should run after the data repository association is created.
The task runs if this flag is set to true
.
importedFileChunkSize?
Type:
number
(optional)
For files imported from a data repository, this value determines the stripe count and maximum amount of data per file (in MiB) stored on a single physical disk.
The maximum number of disks that a single file can be striped across is limited by the total number of disks that make up the file system or cache.
The default chunk size is 1,024 MiB (1 GiB) and can go as high as 512,000 MiB (500 GiB). Amazon S3 objects have a maximum size of 5 TB.
s3?
Type:
IResolvable
|
S3
(optional)
The configuration for an Amazon S3 data repository linked to an Amazon FSx Lustre file system with a data repository association.
The configuration defines which file events (new, changed, or deleted files or directories) are automatically imported from the linked data repository to the file system or automatically exported from the file system to the data repository.
tags?
Type:
Cfn
[]
(optional)
A list of Tag
values, with a maximum of 50 elements.
Properties
Name | Type | Description |
---|---|---|
attr | string | Returns the data repository association's system generated Association ID. |
attr | string | Returns the data repository association's Amazon Resource Name (ARN). |
cfn | ICfn | Options for this resource, such as condition, update policy etc. |
cfn | { [string]: any } | |
cfn | string | AWS resource type. |
creation | string[] | |
data | string | The path to the Amazon S3 data repository that will be linked to the file system. |
file | string | The ID of the file system on which the data repository association is configured. |
file | string | A path on the Amazon FSx for Lustre file system that points to a high-level directory (such as /ns1/ ) or subdirectory (such as /ns1/subdir/ ) that will be mapped 1-1 with DataRepositoryPath . |
logical | string | The logical ID for this CloudFormation stack element. |
node | Node | The tree node. |
ref | string | Return a string that will be resolved to a CloudFormation { Ref } for this element. |
stack | Stack | The stack in which this element is defined. |
tags | Tag | Tag Manager which manages the tags for this resource. |
batch | boolean | IResolvable | A boolean flag indicating whether an import data repository task to import metadata should run after the data repository association is created. |
imported | number | For files imported from a data repository, this value determines the stripe count and maximum amount of data per file (in MiB) stored on a single physical disk. |
s3? | IResolvable | S3 | The configuration for an Amazon S3 data repository linked to an Amazon FSx Lustre file system with a data repository association. |
tags | Cfn [] | A list of Tag values, with a maximum of 50 elements. |
static CFN_RESOURCE_TYPE_NAME | string | The CloudFormation resource type name for this resource class. |
attrAssociationId
Type:
string
Returns the data repository association's system generated Association ID.
Example: dra-abcdef0123456789d
attrResourceArn
Type:
string
Returns the data repository association's Amazon Resource Name (ARN).
Example: arn:aws:fsx:us-east-1:111122223333:association/fs-abc012345def6789a/dra-abcdef0123456789b
cfnOptions
Type:
ICfn
Options for this resource, such as condition, update policy etc.
cfnProperties
Type:
{ [string]: any }
cfnResourceType
Type:
string
AWS resource type.
creationStack
Type:
string[]
dataRepositoryPath
Type:
string
The path to the Amazon S3 data repository that will be linked to the file system.
fileSystemId
Type:
string
The ID of the file system on which the data repository association is configured.
fileSystemPath
Type:
string
A path on the Amazon FSx for Lustre file system that points to a high-level directory (such as /ns1/
) or subdirectory (such as /ns1/subdir/
) that will be mapped 1-1 with DataRepositoryPath
.
logicalId
Type:
string
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)
.
node
Type:
Node
The tree node.
ref
Type:
string
Return a string that will be resolved to a CloudFormation { Ref }
for this element.
If, by any chance, the intrinsic reference of a resource is not a string, you could
coerce it to an IResolvable through Lazy.any({ produce: resource.ref })
.
stack
Type:
Stack
The stack in which this element is defined.
CfnElements must be defined within a stack scope (directly or indirectly).
tags
Type:
Tag
Tag Manager which manages the tags for this resource.
batchImportMetaDataOnCreate?
Type:
boolean |
IResolvable
(optional)
A boolean flag indicating whether an import data repository task to import metadata should run after the data repository association is created.
importedFileChunkSize?
Type:
number
(optional)
For files imported from a data repository, this value determines the stripe count and maximum amount of data per file (in MiB) stored on a single physical disk.
s3?
Type:
IResolvable
|
S3
(optional)
The configuration for an Amazon S3 data repository linked to an Amazon FSx Lustre file system with a data repository association.
tagsRaw?
Type:
Cfn
[]
(optional)
A list of Tag
values, with a maximum of 50 elements.
static CFN_RESOURCE_TYPE_NAME
Type:
string
The CloudFormation resource type name for this resource class.
Methods
Name | Description |
---|---|
add | Syntactic sugar for addOverride(path, undefined) . |
add | Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. |
add | Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. |
add | Add a value to the CloudFormation Resource Metadata. |
add | Adds an override to the synthesized CloudFormation resource. |
add | Adds an override that deletes the value of a property from the resource definition. |
add | Adds an override to a resource property. |
apply | Sets the deletion policy of the resource based on the removal policy specified. |
get | Returns a token for an runtime attribute of this resource. |
get | Retrieve a value value from the CloudFormation Resource Metadata. |
inspect(inspector) | Examines the CloudFormation resource and discloses attributes. |
obtain | Retrieves an array of resources this resource depends on. |
obtain | Get a shallow copy of dependencies between this resource and other resources in the same stack. |
override | Overrides the auto-generated logical ID with a specific ID. |
remove | Indicates that this resource no longer depends on another resource. |
replace | Replaces one dependency with another. |
to | Returns a string representation of this construct. |
protected render |
addDeletionOverride(path)
public addDeletionOverride(path: string): void
Parameters
- path
string
— The path of the value to delete.
Syntactic sugar for addOverride(path, undefined)
.
addDependency(target)
public addDependency(target: CfnResource): void
Parameters
- target
Cfn
Resource
Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.
addDependsOn(target)
public addDependsOn(target: CfnResource): void
⚠️ Deprecated: use addDependency
Parameters
- target
Cfn
Resource
Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
addMetadata(key, value)
public addMetadata(key: string, value: any): void
Parameters
- key
string
- value
any
Add a value to the CloudFormation Resource Metadata.
Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.)
addOverride(path, value)
public addOverride(path: string, value: any): void
Parameters
- path
string
— - The path of the property, you can use dot notation to override values in complex types. - value
any
— - The value.
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
).
If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.
To include a literal .
in the property name, prefix with a \
. In most
programming languages you will need to write this as "\\."
because the
\
itself will need to be escaped.
For example,
cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');
would add the overrides
"Properties": {
"GlobalSecondaryIndexes": [
{
"Projection": {
"NonKeyAttributes": [ "myattribute" ]
...
}
...
},
{
"ProjectionType": "INCLUDE"
...
},
]
...
}
The value
argument to addOverride
will not be processed or translated
in any way. Pass raw JSON values in here with the correct capitalization
for CloudFormation. If you pass CDK classes or structs, they will be
rendered with lowercased key names, and CloudFormation will reject the
template.
addPropertyDeletionOverride(propertyPath)
public addPropertyDeletionOverride(propertyPath: string): void
Parameters
- propertyPath
string
— The path to the property.
Adds an override that deletes the value of a property from the resource definition.
addPropertyOverride(propertyPath, value)
public addPropertyOverride(propertyPath: string, value: any): void
Parameters
- propertyPath
string
— The path of the property. - value
any
— The value.
Adds an override to a resource property.
Syntactic sugar for addOverride("Properties.<...>", value)
.
applyRemovalPolicy(policy?, options?)
public applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): void
Parameters
- policy
Removal
Policy - options
Removal
Policy Options
Sets the deletion policy of the resource based on the removal policy specified.
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
). In some
cases, a snapshot can be taken of the resource prior to deletion
(RemovalPolicy.SNAPSHOT
). A list of resources that support this policy
can be found in the following link:
getAtt(attributeName, typeHint?)
public getAtt(attributeName: string, typeHint?: ResolutionTypeHint): Reference
Parameters
- attributeName
string
— The name of the attribute. - typeHint
Resolution
Type Hint
Returns
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.
getMetadata(key)
public getMetadata(key: string): any
Parameters
- key
string
Returns
any
Retrieve a value value from the CloudFormation Resource Metadata.
Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.)
inspect(inspector)
public inspect(inspector: TreeInspector): void
Parameters
- inspector
Tree
— tree inspector to collect and process attributes.Inspector
Examines the CloudFormation resource and discloses attributes.
obtainDependencies()
public obtainDependencies(): Stack | CfnResource[]
Returns
Stack
|
Cfn
Resource []
Retrieves an array of resources this resource depends on.
This assembles dependencies on resources across stacks (including nested stacks) automatically.
obtainResourceDependencies()
public obtainResourceDependencies(): CfnResource[]
Returns
Get a shallow copy of dependencies between this resource and other resources in the same stack.
overrideLogicalId(newLogicalId)
public overrideLogicalId(newLogicalId: string): void
Parameters
- newLogicalId
string
— The new logical ID to use for this stack element.
Overrides the auto-generated logical ID with a specific ID.
removeDependency(target)
public removeDependency(target: CfnResource): void
Parameters
- target
Cfn
Resource
Indicates that this resource no longer depends on another resource.
This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.
replaceDependency(target, newTarget)
public replaceDependency(target: CfnResource, newTarget: CfnResource): void
Parameters
- target
Cfn
— The dependency to replace.Resource - newTarget
Cfn
— The new dependency to add.Resource
Replaces one dependency with another.
toString()
public toString(): string
Returns
string
Returns a string representation of this construct.
protected renderProperties(props)
protected renderProperties(props: { [string]: any }): { [string]: any }
Parameters
- props
{ [string]: any }
Returns
{ [string]: any }