Package software.amazon.awscdk.services.fsx

Class CfnDataRepositoryAssociation

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.fsx.CfnDataRepositoryAssociation
All Implemented Interfaces:
IInspectable, ITaggable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.104.0 (build e79254c)", date="2024-11-22T02:24:02.211Z") @Stability(Stable) public class CfnDataRepositoryAssociation extends CfnResource implements 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 software.amazon.awscdk.services.fsx.*;
 CfnDataRepositoryAssociation cfnDataRepositoryAssociation = CfnDataRepositoryAssociation.Builder.create(this, "MyCfnDataRepositoryAssociation")
         .dataRepositoryPath("dataRepositoryPath")
         .fileSystemId("fileSystemId")
         .fileSystemPath("fileSystemPath")
         // the properties below are optional
         .batchImportMetaDataOnCreate(false)
         .importedFileChunkSize(123)
         .s3(S3Property.builder()
                 .autoExportPolicy(AutoExportPolicyProperty.builder()
                         .events(List.of("events"))
                         .build())
                 .autoImportPolicy(AutoImportPolicyProperty.builder()
                         .events(List.of("events"))
                         .build())
                 .build())
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();

See Also:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnDataRepositoryAssociation

      protected CfnDataRepositoryAssociation(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnDataRepositoryAssociation

      protected CfnDataRepositoryAssociation(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnDataRepositoryAssociation

      @Stability(Stable) public CfnDataRepositoryAssociation(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnDataRepositoryAssociationProps props)
      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrAssociationId

      @Stability(Stable) @NotNull public String getAttrAssociationId()
      Returns the data repository association's system generated Association ID.

      Example: dra-abcdef0123456789d

    • getAttrResourceArn

      @Stability(Stable) @NotNull public String getAttrResourceArn()
      Returns the data repository association's Amazon Resource Name (ARN).

      Example: arn:aws:fsx:us-east-1:111122223333:association/fs-abc012345def6789a/dra-abcdef0123456789b

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getTags in interface ITaggable

    • getDataRepositoryPath

      @Stability(Stable) @NotNull public String getDataRepositoryPath()
      The path to the Amazon S3 data repository that will be linked to the file system.

    • setDataRepositoryPath

      @Stability(Stable) public void setDataRepositoryPath(@NotNull String value)
      The path to the Amazon S3 data repository that will be linked to the file system.

    • getFileSystemId

      @Stability(Stable) @NotNull public String getFileSystemId()
      The ID of the file system on which the data repository association is configured.

    • setFileSystemId

      @Stability(Stable) public void setFileSystemId(@NotNull String value)
      The ID of the file system on which the data repository association is configured.

    • getFileSystemPath

      @Stability(Stable) @NotNull public String getFileSystemPath()
      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 .

    • setFileSystemPath

      @Stability(Stable) public void setFileSystemPath(@NotNull String value)
      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 .

    • getBatchImportMetaDataOnCreate

      @Stability(Stable) @Nullable public Object getBatchImportMetaDataOnCreate()
      A boolean flag indicating whether an import data repository task to import metadata should run after the data repository association is created.

    • setBatchImportMetaDataOnCreate

      @Stability(Stable) public void setBatchImportMetaDataOnCreate(@Nullable Boolean value)
      A boolean flag indicating whether an import data repository task to import metadata should run after the data repository association is created.

    • setBatchImportMetaDataOnCreate

      @Stability(Stable) public void setBatchImportMetaDataOnCreate(@Nullable IResolvable value)
      A boolean flag indicating whether an import data repository task to import metadata should run after the data repository association is created.

    • getImportedFileChunkSize

      @Stability(Stable) @Nullable public Number getImportedFileChunkSize()
      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.

    • setImportedFileChunkSize

      @Stability(Stable) public void setImportedFileChunkSize(@Nullable Number value)
      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.

    • getS3

      @Stability(Stable) @Nullable public Object getS3()
      The configuration for an Amazon S3 data repository linked to an Amazon FSx Lustre file system with a data repository association.

    • setS3

      @Stability(Stable) public void setS3(@Nullable IResolvable value)
      The configuration for an Amazon S3 data repository linked to an Amazon FSx Lustre file system with a data repository association.

    • setS3

      @Stability(Stable) public void setS3(@Nullable CfnDataRepositoryAssociation.S3Property value)
      The configuration for an Amazon S3 data repository linked to an Amazon FSx Lustre file system with a data repository association.

    • getTagsRaw

      @Stability(Stable) @Nullable public List<CfnTag> getTagsRaw()
      A list of Tag values, with a maximum of 50 elements.

    • setTagsRaw

      @Stability(Stable) public void setTagsRaw(@Nullable List<CfnTag> value)
      A list of Tag values, with a maximum of 50 elements.