CfnFileSystemPropsMixin

class aws_cdk.mixins_preview.aws_efs.mixins.CfnFileSystemPropsMixin(props, *, strategy=None)

Bases: Mixin

The AWS::EFS::FileSystem resource creates a new, empty file system in Amazon Elastic File System ( Amazon EFS ).

You must create a mount target ( AWS::EFS::MountTarget ) to mount your EFS file system on an Amazon EC2 or other AWS cloud compute resource.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-efs-filesystem.html
CloudformationResource:: AWS::EFS::FileSystem
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_efs import mixins as efs_mixins

# file_system_policy: Any

cfn_file_system_props_mixin = efs_mixins.CfnFileSystemPropsMixin(efs_mixins.CfnFileSystemMixinProps(
    availability_zone_name="availabilityZoneName",
    backup_policy=efs_mixins.CfnFileSystemPropsMixin.BackupPolicyProperty(
        status="status"
    ),
    bypass_policy_lockout_safety_check=False,
    encrypted=False,
    file_system_policy=file_system_policy,
    file_system_protection=efs_mixins.CfnFileSystemPropsMixin.FileSystemProtectionProperty(
        replication_overwrite_protection="replicationOverwriteProtection"
    ),
    file_system_tags=[efs_mixins.CfnFileSystemPropsMixin.ElasticFileSystemTagProperty(
        key="key",
        value="value"
    )],
    kms_key_id="kmsKeyId",
    lifecycle_policies=[efs_mixins.CfnFileSystemPropsMixin.LifecyclePolicyProperty(
        transition_to_archive="transitionToArchive",
        transition_to_ia="transitionToIa",
        transition_to_primary_storage_class="transitionToPrimaryStorageClass"
    )],
    performance_mode="performanceMode",
    provisioned_throughput_in_mibps=123,
    replication_configuration=efs_mixins.CfnFileSystemPropsMixin.ReplicationConfigurationProperty(
        destinations=[efs_mixins.CfnFileSystemPropsMixin.ReplicationDestinationProperty(
            availability_zone_name="availabilityZoneName",
            file_system_id="fileSystemId",
            kms_key_id="kmsKeyId",
            region="region",
            role_arn="roleArn",
            status="status",
            status_message="statusMessage"
        )]
    ),
    throughput_mode="throughputMode"
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

Create a mixin to apply properties to AWS::EFS::FileSystem.

Parameters:

props (Union[CfnFileSystemMixinProps, 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 = ['availabilityZoneName', 'backupPolicy', 'bypassPolicyLockoutSafetyCheck', 'encrypted', 'fileSystemPolicy', 'fileSystemProtection', 'fileSystemTags', 'kmsKeyId', 'lifecyclePolicies', 'performanceMode', 'provisionedThroughputInMibps', 'replicationConfiguration', 'throughputMode']

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

BackupPolicyProperty

class CfnFileSystemPropsMixin.BackupPolicyProperty(*, status=None)

Bases: object

The backup policy turns automatic backups for the file system on or off.

Parameters:: status (Optional[str]) – Set the backup policy status for the file system. - ``ENABLED`` - Turns automatic backups on for the file system. - ``DISABLED`` - Turns automatic backups off for the file system.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-efs-filesystem-backuppolicy.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_efs import mixins as efs_mixins

backup_policy_property = efs_mixins.CfnFileSystemPropsMixin.BackupPolicyProperty(
    status="status"
)

Attributes

status

Set the backup policy status for the file system.

``ENABLED`` - Turns automatic backups on for the file system.
``DISABLED`` - Turns automatic backups off for the file system.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-efs-filesystem-backuppolicy.html#cfn-efs-filesystem-backuppolicy-status

ElasticFileSystemTagProperty

class CfnFileSystemPropsMixin.ElasticFileSystemTagProperty(*, key=None, value=None)

Bases: object

A tag is a key-value pair attached to a file system.

Allowed characters in the Key and Value properties are letters, white space, and numbers that can be represented in UTF-8, and the following characters: + - = . _ : /

Parameters:

key (Optional[str]) – The tag key (String). The key can’t start with aws: .
value (Optional[str]) – The value of the tag key.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-efs-filesystem-elasticfilesystemtag.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_efs import mixins as efs_mixins

elastic_file_system_tag_property = efs_mixins.CfnFileSystemPropsMixin.ElasticFileSystemTagProperty(
    key="key",
    value="value"
)

Attributes

key

The tag key (String).

The key can’t start with aws: .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-efs-filesystem-elasticfilesystemtag.html#cfn-efs-filesystem-elasticfilesystemtag-key

value

The value of the tag key.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-efs-filesystem-elasticfilesystemtag.html#cfn-efs-filesystem-elasticfilesystemtag-value

FileSystemProtectionProperty

class CfnFileSystemPropsMixin.FileSystemProtectionProperty(*, replication_overwrite_protection=None)

Bases: object

Describes the protection on the file system.

Parameters:: replication_overwrite_protection (Optional[str]) – The status of the file system’s replication overwrite protection. - ENABLED – The file system cannot be used as the destination file system in a replication configuration. The file system is writeable. Replication overwrite protection is ENABLED by default. - DISABLED – The file system can be used as the destination file system in a replication configuration. The file system is read-only and can only be modified by EFS replication. - REPLICATING – The file system is being used as the destination file system in a replication configuration. The file system is read-only and is modified only by EFS replication. If the replication configuration is deleted, the file system’s replication overwrite protection is re-enabled, the file system becomes writeable.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-efs-filesystem-filesystemprotection.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_efs import mixins as efs_mixins

file_system_protection_property = efs_mixins.CfnFileSystemPropsMixin.FileSystemProtectionProperty(
    replication_overwrite_protection="replicationOverwriteProtection"
)

Attributes

replication_overwrite_protection

The status of the file system’s replication overwrite protection.

ENABLED – The file system cannot be used as the destination file system in a replication configuration. The file system is writeable. Replication overwrite protection is ENABLED by default.
DISABLED – The file system can be used as the destination file system in a replication configuration. The file system is read-only and can only be modified by EFS replication.
REPLICATING – The file system is being used as the destination file system in a replication configuration. The file system is read-only and is modified only by EFS replication.

If the replication configuration is deleted, the file system’s replication overwrite protection is re-enabled, the file system becomes writeable.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-efs-filesystem-filesystemprotection.html#cfn-efs-filesystem-filesystemprotection-replicationoverwriteprotection

LifecyclePolicyProperty

class CfnFileSystemPropsMixin.LifecyclePolicyProperty(*, transition_to_archive=None, transition_to_ia=None, transition_to_primary_storage_class=None)

Bases: object

Describes a policy used by Lifecycle management that specifies when to transition files into and out of the EFS storage classes.

For more information, see Managing file system storage . .. epigraph:

- Each ``LifecyclePolicy`` object can have only a single transition. This means that in a request body, ``LifecyclePolicies`` must be structured as an array of ``LifecyclePolicy`` objects, one object for each transition, ``TransitionToIA`` , ``TransitionToArchive`` , ``TransitionToPrimaryStorageClass`` .
- See the AWS::EFS::FileSystem examples for the correct ``LifecyclePolicy`` structure. Do not use the syntax shown on this page.

Parameters:

transition_to_archive (Optional[str]) – The number of days after files were last accessed in primary storage (the Standard storage class) at which to move them to Archive storage. Metadata operations such as listing the contents of a directory don’t count as file access events.
transition_to_ia (Optional[str]) – The number of days after files were last accessed in primary storage (the Standard storage class) at which to move them to Infrequent Access (IA) storage. Metadata operations such as listing the contents of a directory don’t count as file access events.
transition_to_primary_storage_class (Optional[str]) – Whether to move files back to primary (Standard) storage after they are accessed in IA or Archive storage. Metadata operations such as listing the contents of a directory don’t count as file access events.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-efs-filesystem-lifecyclepolicy.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_efs import mixins as efs_mixins

lifecycle_policy_property = efs_mixins.CfnFileSystemPropsMixin.LifecyclePolicyProperty(
    transition_to_archive="transitionToArchive",
    transition_to_ia="transitionToIa",
    transition_to_primary_storage_class="transitionToPrimaryStorageClass"
)

Attributes

transition_to_archive

The number of days after files were last accessed in primary storage (the Standard storage class) at which to move them to Archive storage.

Metadata operations such as listing the contents of a directory don’t count as file access events.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-efs-filesystem-lifecyclepolicy.html#cfn-efs-filesystem-lifecyclepolicy-transitiontoarchive

transition_to_ia

The number of days after files were last accessed in primary storage (the Standard storage class) at which to move them to Infrequent Access (IA) storage.

Metadata operations such as listing the contents of a directory don’t count as file access events.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-efs-filesystem-lifecyclepolicy.html#cfn-efs-filesystem-lifecyclepolicy-transitiontoia

transition_to_primary_storage_class

Whether to move files back to primary (Standard) storage after they are accessed in IA or Archive storage.

Metadata operations such as listing the contents of a directory don’t count as file access events.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-efs-filesystem-lifecyclepolicy.html#cfn-efs-filesystem-lifecyclepolicy-transitiontoprimarystorageclass

ReplicationConfigurationProperty

class CfnFileSystemPropsMixin.ReplicationConfigurationProperty(*, destinations=None)

Bases: object

Describes the replication configuration for a specific file system.

Parameters:: destinations (Union[IResolvable, Sequence[Union[IResolvable, ReplicationDestinationProperty, Dict[str, Any]]], None]) – An array of destination objects. Only one destination object is supported.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-efs-filesystem-replicationconfiguration.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_efs import mixins as efs_mixins

replication_configuration_property = efs_mixins.CfnFileSystemPropsMixin.ReplicationConfigurationProperty(
    destinations=[efs_mixins.CfnFileSystemPropsMixin.ReplicationDestinationProperty(
        availability_zone_name="availabilityZoneName",
        file_system_id="fileSystemId",
        kms_key_id="kmsKeyId",
        region="region",
        role_arn="roleArn",
        status="status",
        status_message="statusMessage"
    )]
)

Attributes

destinations

An array of destination objects.

Only one destination object is supported.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-efs-filesystem-replicationconfiguration.html#cfn-efs-filesystem-replicationconfiguration-destinations

ReplicationDestinationProperty

class CfnFileSystemPropsMixin.ReplicationDestinationProperty(*, availability_zone_name=None, file_system_id=None, kms_key_id=None, region=None, role_arn=None, status=None, status_message=None)

Bases: object

Describes the destination file system in the replication configuration.

Parameters:

availability_zone_name (Optional[str]) – For One Zone file systems, the replication configuration must specify the Availability Zone in which the destination file system is located. Use the format us-east-1a to specify the Availability Zone. For more information about One Zone file systems, see EFS file system types in the Amazon EFS User Guide . .. epigraph:: One Zone file system type is not available in all Availability Zones in AWS Regions where Amazon EFS is available.
file_system_id (Optional[str]) – The ID of the destination Amazon EFS file system.
kms_key_id (Optional[str]) – The ID of an AWS KMS key used to protect the encrypted file system.
region (Optional[str]) – The AWS Region in which the destination file system is located. .. epigraph:: For One Zone file systems, the replication configuration must specify the AWS Region in which the destination file system is located.
role_arn (Optional[str]) – The Amazon Resource Name (ARN) of the current source file system in the replication configuration.
status (Optional[str]) – Describes the status of the replication configuration. For more information about replication status, see Viewing replication details in the Amazon EFS User Guide .
status_message (Optional[str]) –
Message that provides details about the PAUSED or ERRROR state of the replication destination configuration. For more information about replication status messages, see Viewing replication details in the Amazon EFS User Guide .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-efs-filesystem-replicationdestination.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_efs import mixins as efs_mixins

replication_destination_property = efs_mixins.CfnFileSystemPropsMixin.ReplicationDestinationProperty(
    availability_zone_name="availabilityZoneName",
    file_system_id="fileSystemId",
    kms_key_id="kmsKeyId",
    region="region",
    role_arn="roleArn",
    status="status",
    status_message="statusMessage"
)

Attributes

availability_zone_name

For One Zone file systems, the replication configuration must specify the Availability Zone in which the destination file system is located.

Use the format us-east-1a to specify the Availability Zone. For more information about One Zone file systems, see EFS file system types in the Amazon EFS User Guide . .. epigraph:

One Zone file system type is not available in all Availability Zones in AWS Regions where Amazon EFS is available.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-efs-filesystem-replicationdestination.html#cfn-efs-filesystem-replicationdestination-availabilityzonename

file_system_id

The ID of the destination Amazon EFS file system.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-efs-filesystem-replicationdestination.html#cfn-efs-filesystem-replicationdestination-filesystemid

kms_key_id

The ID of an AWS KMS key used to protect the encrypted file system.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-efs-filesystem-replicationdestination.html#cfn-efs-filesystem-replicationdestination-kmskeyid

region

The AWS Region in which the destination file system is located.

For One Zone file systems, the replication configuration must specify the AWS Region in which the destination file system is located.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-efs-filesystem-replicationdestination.html#cfn-efs-filesystem-replicationdestination-region

role_arn

The Amazon Resource Name (ARN) of the current source file system in the replication configuration.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-efs-filesystem-replicationdestination.html#cfn-efs-filesystem-replicationdestination-rolearn

status

Describes the status of the replication configuration.

For more information about replication status, see Viewing replication details in the Amazon EFS User Guide .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-efs-filesystem-replicationdestination.html#cfn-efs-filesystem-replicationdestination-status

status_message

Message that provides details about the PAUSED or ERRROR state of the replication destination configuration.

For more information about replication status messages, see Viewing replication details in the Amazon EFS User Guide .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-efs-filesystem-replicationdestination.html#cfn-efs-filesystem-replicationdestination-statusmessage