Package software.amazon.awscdk.services.fsx

Class CfnDataRepositoryAssociation

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.core.Construct
software.amazon.awscdk.core.CfnElement
software.amazon.awscdk.core.CfnRefElement
software.amazon.awscdk.core.CfnResource
software.amazon.awscdk.services.fsx.CfnDataRepositoryAssociation
All Implemented Interfaces:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:40.186Z") @Stability(Stable) public class CfnDataRepositoryAssociation extends CfnResource implements IInspectable
A CloudFormation AWS::FSx::DataRepositoryAssociation.

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();

  • 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 Construct scope, @NotNull String id, @NotNull CfnDataRepositoryAssociationProps props)
      Create a new AWS::FSx::DataRepositoryAssociation.

      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      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()
      An array of key-value pairs to apply to this resource.

      For more information, see Tag .

    • getDataRepositoryPath

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

    • 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.

      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.

    • 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 .

      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.

    • 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 .

      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.

    • 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.

      The task runs if this flag is set to true .

    • 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.

      The task runs if this flag is set to true .

    • 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.

      The task runs if this flag is set to true .

    • 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.

      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.

    • 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.

      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.

    • 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.

      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.

    • 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.

      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.

    • 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.

      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.