Class CfnDataRepositoryAssociation
A CloudFormation AWS::FSx::DataRepositoryAssociation
.
Inheritance
Inherited Members
Namespace: Amazon.CDK.AWS.FSx
Assembly: Amazon.CDK.AWS.FSx.dll
Syntax (csharp)
public class CfnDataRepositoryAssociation : CfnResource, IConstruct, IDependable, IInspectable
Syntax (vb)
Public Class CfnDataRepositoryAssociation
Inherits CfnResource
Implements IConstruct, IDependable, IInspectable
Remarks
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 .
CloudformationResource: AWS::FSx::DataRepositoryAssociation
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.FSx;
var cfnDataRepositoryAssociation = new CfnDataRepositoryAssociation(this, "MyCfnDataRepositoryAssociation", new CfnDataRepositoryAssociationProps {
DataRepositoryPath = "dataRepositoryPath",
FileSystemId = "fileSystemId",
FileSystemPath = "fileSystemPath",
// the properties below are optional
BatchImportMetaDataOnCreate = false,
ImportedFileChunkSize = 123,
S3 = new S3Property {
AutoExportPolicy = new AutoExportPolicyProperty {
Events = new [] { "events" }
},
AutoImportPolicy = new AutoImportPolicyProperty {
Events = new [] { "events" }
}
},
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} }
});
Synopsis
Constructors
CfnDataRepositoryAssociation(Construct, String, ICfnDataRepositoryAssociationProps) | Create a new |
CfnDataRepositoryAssociation(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnDataRepositoryAssociation(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
Properties
AttrAssociationId | Returns the data repository association's system generated Association ID. |
AttrResourceArn | Returns the data repository association's Amazon Resource Name (ARN). |
BatchImportMetaDataOnCreate | A boolean flag indicating whether an import data repository task to import metadata should run after the data repository association is created. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
DataRepositoryPath | The path to the Amazon S3 data repository that will be linked to the file system. |
FileSystemId | The ID of the file system on which the data repository association is configured. |
FileSystemPath | A path on the Amazon FSx for Lustre file system that points to a high-level directory (such as |
ImportedFileChunkSize | 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 | The configuration for an Amazon S3 data repository linked to an Amazon FSx Lustre file system with a data repository association. |
Tags | An array of key-value pairs to apply to this resource. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnDataRepositoryAssociation(Construct, String, ICfnDataRepositoryAssociationProps)
Create a new AWS::FSx::DataRepositoryAssociation
.
public CfnDataRepositoryAssociation(Construct scope, string id, ICfnDataRepositoryAssociationProps props)
Parameters
- scope Construct
- scope in which this resource is defined.
- id System.String
- scoped id of the resource.
- props ICfnDataRepositoryAssociationProps
- resource properties.
CfnDataRepositoryAssociation(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnDataRepositoryAssociation(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnDataRepositoryAssociation(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnDataRepositoryAssociation(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
Properties
AttrAssociationId
Returns the data repository association's system generated Association ID.
public virtual string AttrAssociationId { get; }
Property Value
System.String
Remarks
Example: dra-abcdef0123456789d
CloudformationAttribute: AssociationId
AttrResourceArn
Returns the data repository association's Amazon Resource Name (ARN).
public virtual string AttrResourceArn { get; }
Property Value
System.String
Remarks
Example: arn:aws:fsx:us-east-1:111122223333:association/fs-abc012345def6789a/dra-abcdef0123456789b
CloudformationAttribute: ResourceARN
BatchImportMetaDataOnCreate
A boolean flag indicating whether an import data repository task to import metadata should run after the data repository association is created.
public virtual object BatchImportMetaDataOnCreate { get; set; }
Property Value
System.Object
Remarks
The task runs if this flag is set to true
.
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
DataRepositoryPath
The path to the Amazon S3 data repository that will be linked to the file system.
public virtual string DataRepositoryPath { get; set; }
Property Value
System.String
Remarks
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
The ID of the file system on which the data repository association is configured.
public virtual string FileSystemId { get; set; }
Property Value
System.String
Remarks
FileSystemPath
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
.
public virtual string FileSystemPath { get; set; }
Property Value
System.String
Remarks
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.
ImportedFileChunkSize
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.
public virtual Nullable<double> ImportedFileChunkSize { get; set; }
Property Value
System.Nullable<System.Double>
Remarks
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
The configuration for an Amazon S3 data repository linked to an Amazon FSx Lustre file system with a data repository association.
public virtual object S3 { get; set; }
Property Value
System.Object
Remarks
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
An array of key-value pairs to apply to this resource.
public virtual TagManager Tags { get; }
Property Value
Remarks
Methods
Inspect(TreeInspector)
Examines the CloudFormation resource and discloses attributes.
public virtual void Inspect(TreeInspector inspector)
Parameters
- inspector TreeInspector
- tree inspector to collect and process attributes.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>