CfnDataRepositoryAssociationPropsMixin

class aws_cdk.mixins_preview.aws_fsx.mixins.CfnDataRepositoryAssociationPropsMixin(props, *, strategy=None)

Bases: Mixin

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 .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-fsx-datarepositoryassociation.html
CloudformationResource:: AWS::FSx::DataRepositoryAssociation
Mixin:: true
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview import mixins
from aws_cdk.mixins_preview.aws_fsx import mixins as fsx_mixins

cfn_data_repository_association_props_mixin = fsx_mixins.CfnDataRepositoryAssociationPropsMixin(fsx_mixins.CfnDataRepositoryAssociationMixinProps(
    batch_import_meta_data_on_create=False,
    data_repository_path="dataRepositoryPath",
    file_system_id="fileSystemId",
    file_system_path="fileSystemPath",
    imported_file_chunk_size=123,
    s3=fsx_mixins.CfnDataRepositoryAssociationPropsMixin.S3Property(
        auto_export_policy=fsx_mixins.CfnDataRepositoryAssociationPropsMixin.AutoExportPolicyProperty(
            events=["events"]
        ),
        auto_import_policy=fsx_mixins.CfnDataRepositoryAssociationPropsMixin.AutoImportPolicyProperty(
            events=["events"]
        )
    ),
    tags=[CfnTag(
        key="key",
        value="value"
    )]
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

Create a mixin to apply properties to AWS::FSx::DataRepositoryAssociation.

Parameters:

props (Union[CfnDataRepositoryAssociationMixinProps, Dict[str, Any]]) – L1 properties to apply.
strategy (Optional[PropertyMergeStrategy]) – (experimental) Strategy for merging nested properties. Default: - PropertyMergeStrategy.MERGE

Methods

apply_to(construct)

Apply the mixin properties to the construct.

Parameters:: construct (IConstruct)
Return type:: IConstruct

supports(construct)

Check if this mixin supports the given construct.

Parameters:: construct (IConstruct)
Return type:: bool

Attributes

CFN_PROPERTY_KEYS = ['batchImportMetaDataOnCreate', 'dataRepositoryPath', 'fileSystemId', 'fileSystemPath', 'importedFileChunkSize', 's3', 'tags']

Static Methods

classmethod is_mixin(x)

(experimental) Checks if x is a Mixin.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Mixin.
Stability:: experimental

AutoExportPolicyProperty

class CfnDataRepositoryAssociationPropsMixin.AutoExportPolicyProperty(*, events=None)

Bases: object

Describes a data repository association’s automatic export policy.

The AutoExportPolicy defines the types of updated objects on the file system that will be automatically exported to the data repository. As you create, modify, or delete files, Amazon FSx for Lustre automatically exports the defined changes asynchronously once your application finishes modifying the file.

The AutoExportPolicy is only supported on Amazon FSx for Lustre file systems with a data repository association.

Parameters:: events (Optional[Sequence[str]]) – The AutoExportPolicy can have the following event values:. - NEW - New files and directories are automatically exported to the data repository as they are added to the file system. - CHANGED - Changes to files and directories on the file system are automatically exported to the data repository. - DELETED - Files and directories are automatically deleted on the data repository when they are deleted on the file system. You can define any combination of event types for your AutoExportPolicy .
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-datarepositoryassociation-autoexportpolicy.html
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_fsx import mixins as fsx_mixins

auto_export_policy_property = fsx_mixins.CfnDataRepositoryAssociationPropsMixin.AutoExportPolicyProperty(
    events=["events"]
)

Attributes

events

.

NEW - New files and directories are automatically exported to the data repository as they are added to the file system.
CHANGED - Changes to files and directories on the file system are automatically exported to the data repository.
DELETED - Files and directories are automatically deleted on the data repository when they are deleted on the file system.

You can define any combination of event types for your AutoExportPolicy .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-datarepositoryassociation-autoexportpolicy.html#cfn-fsx-datarepositoryassociation-autoexportpolicy-events
Type:: The AutoExportPolicy can have the following event values

AutoImportPolicyProperty

class CfnDataRepositoryAssociationPropsMixin.AutoImportPolicyProperty(*, events=None)

Bases: object

Describes the data repository association’s automatic import policy.

The AutoImportPolicy defines how Amazon FSx keeps your file metadata and directory listings up to date by importing changes to your Amazon FSx for Lustre file system as you modify objects in a linked S3 bucket.

The AutoImportPolicy is only supported on Amazon FSx for Lustre file systems with a data repository association.

Parameters:: events (Optional[Sequence[str]]) – The AutoImportPolicy can have the following event values:. - NEW - Amazon FSx automatically imports metadata of files added to the linked S3 bucket that do not currently exist in the FSx file system. - CHANGED - Amazon FSx automatically updates file metadata and invalidates existing file content on the file system as files change in the data repository. - DELETED - Amazon FSx automatically deletes files on the file system as corresponding files are deleted in the data repository. You can define any combination of event types for your AutoImportPolicy .
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-datarepositoryassociation-autoimportpolicy.html
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_fsx import mixins as fsx_mixins

auto_import_policy_property = fsx_mixins.CfnDataRepositoryAssociationPropsMixin.AutoImportPolicyProperty(
    events=["events"]
)

Attributes

events

.

NEW - Amazon FSx automatically imports metadata of files added to the linked S3 bucket that do not currently exist in the FSx file system.
CHANGED - Amazon FSx automatically updates file metadata and invalidates existing file content on the file system as files change in the data repository.
DELETED - Amazon FSx automatically deletes files on the file system as corresponding files are deleted in the data repository.

You can define any combination of event types for your AutoImportPolicy .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-datarepositoryassociation-autoimportpolicy.html#cfn-fsx-datarepositoryassociation-autoimportpolicy-events
Type:: The AutoImportPolicy can have the following event values

S3Property

class CfnDataRepositoryAssociationPropsMixin.S3Property(*, auto_export_policy=None, auto_import_policy=None)

Bases: object

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.

Parameters:

auto_export_policy (Union[IResolvable, AutoExportPolicyProperty, Dict[str, Any], None]) – Describes a data repository association’s automatic export policy. The AutoExportPolicy defines the types of updated objects on the file system that will be automatically exported to the data repository. As you create, modify, or delete files, Amazon FSx for Lustre automatically exports the defined changes asynchronously once your application finishes modifying the file. The AutoExportPolicy is only supported on Amazon FSx for Lustre file systems with a data repository association.
auto_import_policy (Union[IResolvable, AutoImportPolicyProperty, Dict[str, Any], None]) – Describes the data repository association’s automatic import policy. The AutoImportPolicy defines how Amazon FSx keeps your file metadata and directory listings up to date by importing changes to your Amazon FSx for Lustre file system as you modify objects in a linked S3 bucket. The AutoImportPolicy is only supported on Amazon FSx for Lustre file systems with a data repository association.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-datarepositoryassociation-s3.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_fsx import mixins as fsx_mixins

s3_property = fsx_mixins.CfnDataRepositoryAssociationPropsMixin.S3Property(
    auto_export_policy=fsx_mixins.CfnDataRepositoryAssociationPropsMixin.AutoExportPolicyProperty(
        events=["events"]
    ),
    auto_import_policy=fsx_mixins.CfnDataRepositoryAssociationPropsMixin.AutoImportPolicyProperty(
        events=["events"]
    )
)

Attributes

auto_export_policy

Describes a data repository association’s automatic export policy.

The AutoExportPolicy defines the types of updated objects on the file system that will be automatically exported to the data repository. As you create, modify, or delete files, Amazon FSx for Lustre automatically exports the defined changes asynchronously once your application finishes modifying the file.

The AutoExportPolicy is only supported on Amazon FSx for Lustre file systems with a data repository association.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-datarepositoryassociation-s3.html#cfn-fsx-datarepositoryassociation-s3-autoexportpolicy

auto_import_policy

Describes the data repository association’s automatic import policy.

The AutoImportPolicy defines how Amazon FSx keeps your file metadata and directory listings up to date by importing changes to your Amazon FSx for Lustre file system as you modify objects in a linked S3 bucket.

The AutoImportPolicy is only supported on Amazon FSx for Lustre file systems with a data repository association.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-datarepositoryassociation-s3.html#cfn-fsx-datarepositoryassociation-s3-autoimportpolicy