@Generated(value="jsii-pacmak/1.73.0 (build 6faeda3)", date="2023-01-25T18:29:04.285Z") public class CfnDataRepositoryAssociation extends CfnResource implements IInspectable
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 only for file systems with the Persistent_2
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();
Modifier and Type | Class and Description |
---|---|
static interface |
CfnDataRepositoryAssociation.AutoExportPolicyProperty
Describes a data repository association's automatic export policy.
|
static interface |
CfnDataRepositoryAssociation.AutoImportPolicyProperty
Describes the data repository association's automatic import policy.
|
static class |
CfnDataRepositoryAssociation.Builder
A fluent builder for
CfnDataRepositoryAssociation . |
static interface |
CfnDataRepositoryAssociation.S3Property
The configuration for an Amazon S3 data repository linked to an Amazon FSx Lustre file system with a data repository association.
|
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
IConstruct.Jsii$Default
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
|
Modifier | Constructor and Description |
---|---|
|
CfnDataRepositoryAssociation(Construct scope,
java.lang.String id,
CfnDataRepositoryAssociationProps props)
Create a new `AWS::FSx::DataRepositoryAssociation`.
|
protected |
CfnDataRepositoryAssociation(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) |
protected |
CfnDataRepositoryAssociation(software.amazon.jsii.JsiiObjectRef objRef) |
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getAttrAssociationId()
Returns the data repository association's system generated Association ID.
|
java.lang.String |
getAttrResourceArn()
Returns the data repository association's Amazon Resource Name (ARN).
|
java.lang.Object |
getBatchImportMetaDataOnCreate()
A boolean flag indicating whether an import data repository task to import metadata should run after the data repository association is created.
|
protected java.util.Map<java.lang.String,java.lang.Object> |
getCfnProperties() |
java.lang.String |
getDataRepositoryPath()
The path to the Amazon S3 data repository that will be linked to the file system.
|
java.lang.String |
getFileSystemId()
The ID of the file system on which the data repository association is configured.
|
java.lang.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` .
|
java.lang.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.
|
java.lang.Object |
getS3()
The configuration for an Amazon S3 data repository linked to an Amazon FSx Lustre file system with a data repository association.
|
TagManager |
getTags()
An array of key-value pairs to apply to this resource.
|
void |
inspect(TreeInspector inspector)
Examines the CloudFormation resource and discloses attributes.
|
protected java.util.Map<java.lang.String,java.lang.Object> |
renderProperties(java.util.Map<java.lang.String,java.lang.Object> props) |
void |
setBatchImportMetaDataOnCreate(java.lang.Boolean value)
A boolean flag indicating whether an import data repository task to import metadata should run after the data repository association is created.
|
void |
setBatchImportMetaDataOnCreate(IResolvable value)
A boolean flag indicating whether an import data repository task to import metadata should run after the data repository association is created.
|
void |
setDataRepositoryPath(java.lang.String value)
The path to the Amazon S3 data repository that will be linked to the file system.
|
void |
setFileSystemId(java.lang.String value)
The ID of the file system on which the data repository association is configured.
|
void |
setFileSystemPath(java.lang.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` .
|
void |
setImportedFileChunkSize(java.lang.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.
|
void |
setS3(CfnDataRepositoryAssociation.S3Property value)
The configuration for an Amazon S3 data repository linked to an Amazon FSx Lustre file system with a data repository association.
|
void |
setS3(IResolvable value)
The configuration for an Amazon S3 data repository linked to an Amazon FSx Lustre file system with a data repository association.
|
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties
getRef
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId
getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate
public static final java.lang.String CFN_RESOURCE_TYPE_NAME
protected CfnDataRepositoryAssociation(software.amazon.jsii.JsiiObjectRef objRef)
protected CfnDataRepositoryAssociation(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
public CfnDataRepositoryAssociation(Construct scope, java.lang.String id, CfnDataRepositoryAssociationProps props)
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.public void inspect(TreeInspector inspector)
inspect
in interface IInspectable
inspector
- - tree inspector to collect and process attributes. This parameter is required.protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
renderProperties
in class CfnResource
props
- This parameter is required.public java.lang.String getAttrAssociationId()
Example: dra-abcdef0123456789d
public java.lang.String getAttrResourceArn()
Example: arn:aws:fsx:us-east-1:111122223333:association/fs-abc012345def6789a/dra-abcdef0123456789b
protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()
getCfnProperties
in class CfnResource
public TagManager getTags()
For more information, see Tag .
public java.lang.String getDataRepositoryPath()
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.
public void setDataRepositoryPath(java.lang.String value)
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.
public java.lang.String getFileSystemId()
public void setFileSystemId(java.lang.String value)
public java.lang.String getFileSystemPath()
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.
public void setFileSystemPath(java.lang.String value)
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.
public java.lang.Object getBatchImportMetaDataOnCreate()
The task runs if this flag is set to true
.
public void setBatchImportMetaDataOnCreate(java.lang.Boolean value)
The task runs if this flag is set to true
.
public void setBatchImportMetaDataOnCreate(IResolvable value)
The task runs if this flag is set to true
.
public java.lang.Number getImportedFileChunkSize()
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.
public void setImportedFileChunkSize(java.lang.Number value)
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.
public java.lang.Object getS3()
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.
public void setS3(IResolvable value)
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.
public void setS3(CfnDataRepositoryAssociation.S3Property value)
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.