Class CfnDataRepositoryAssociation

Creates an Amazon FSx for Lustre data repository association (DRA).

Inheritance

System.Object

CfnElement

CfnRefElement

CfnResource

CfnDataRepositoryAssociation

Implements

IInspectable

ITaggable

Inherited Members

CfnResource.IsCfnResource(Object)

CfnResource.AddDeletionOverride(String)

CfnResource.AddDependency(CfnResource)

CfnResource.AddDependsOn(CfnResource)

CfnResource.AddMetadata(String, Object)

CfnResource.AddOverride(String, Object)

CfnResource.AddPropertyDeletionOverride(String)

CfnResource.AddPropertyOverride(String, Object)

CfnResource.ApplyRemovalPolicy(Nullable<RemovalPolicy>, IRemovalPolicyOptions)

CfnResource.GetAtt(String, Nullable<ResolutionTypeHint>)

CfnResource.GetMetadata(String)

CfnResource.ObtainDependencies()

CfnResource.ObtainResourceDependencies()

CfnResource.RemoveDependency(CfnResource)

CfnResource.ReplaceDependency(CfnResource, CfnResource)

CfnResource.ShouldSynthesize()

CfnResource.ToString()

CfnResource.ValidateProperties(Object)

CfnResource.CfnOptions

CfnResource.CfnResourceType

CfnResource.UpdatedProperites

CfnResource.UpdatedProperties

CfnRefElement.Ref

CfnElement.IsCfnElement(Object)

CfnElement.OverrideLogicalId(String)

CfnElement.CreationStack

CfnElement.LogicalId

CfnElement.Stack

Namespace: Amazon.CDK.AWS.FSx

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnDataRepositoryAssociation : CfnResource, IInspectable, ITaggable

Syntax (vb)

Public Class CfnDataRepositoryAssociation
    Inherits CfnResource
    Implements IInspectable, ITaggable

Remarks

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 .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-fsx-datarepositoryassociation.html

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(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
CfnDataRepositoryAssociation(Construct, String, ICfnDataRepositoryAssociationProps)

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 `/ns1/` ) or subdirectory (such as `/ns1/subdir/` ) that will be mapped 1-1 with `DataRepositoryPath` .
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	Tag Manager which manages the tags for this resource.
TagsRaw	A list of `Tag` values, with a maximum of 50 elements.

Methods

Inspect(TreeInspector)	Examines the CloudFormation resource and discloses attributes.
RenderProperties(IDictionary<String, Object>)

Constructors

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

CfnDataRepositoryAssociation(Construct, String, ICfnDataRepositoryAssociationProps)

public CfnDataRepositoryAssociation(Construct scope, string id, ICfnDataRepositoryAssociationProps props)

Parameters

scope Constructs.Construct: Scope in which this resource is defined.
id System.String: Construct identifier for this resource (unique in its scope).
props ICfnDataRepositoryAssociationProps: Resource properties.

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

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

CfnResource.CfnProperties

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

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

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

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>

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

TagsRaw

A list of Tag values, with a maximum of 50 elements.

public virtual ICfnTag[] TagsRaw { get; set; }

Property Value

ICfnTag[]

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>

Overrides

CfnResource.RenderProperties(IDictionary<String, Object>)

Implements

IInspectable

ITaggable