ReplicationConfiguration

class aws_cdk.aws_efs.ReplicationConfiguration(*, availability_zone=None, destination_file_system=None, kms_key=None, region=None)

Bases: object

EFS Replication Configuration.

ExampleMetadata:: infused

Example:

# vpc: ec2.Vpc


# auto generate a regional replication destination file system
efs.FileSystem(self, "RegionalReplicationFileSystem",
    vpc=vpc,
    replication_configuration=efs.ReplicationConfiguration.regional_file_system("us-west-2")
)

# auto generate a one zone replication destination file system
efs.FileSystem(self, "OneZoneReplicationFileSystem",
    vpc=vpc,
    replication_configuration=efs.ReplicationConfiguration.one_zone_file_system("us-east-1", "us-east-1a")
)

destination_file_system = efs.FileSystem(self, "DestinationFileSystem",
    vpc=vpc,
    # set as the read-only file system for use as a replication destination
    replication_overwrite_protection=efs.ReplicationOverwriteProtection.DISABLED
)
# specify the replication destination file system
efs.FileSystem(self, "ReplicationFileSystem",
    vpc=vpc,
    replication_configuration=efs.ReplicationConfiguration.existing_file_system(destination_file_system)
)

Parameters:

availability_zone (Optional[str]) – The availability zone name of the destination file system. One zone file system is used as the destination file system when this property is set. Default: - no availability zone is set
destination_file_system (Optional[IFileSystem]) – The existing destination file system for the replication. Default: - None
kms_key (Optional[IKey]) – AWS KMS key used to protect the encrypted file system. Default: - use service-managed KMS key for Amazon EFS
region (Optional[str]) – The AWS Region in which the destination file system is located. Default: - the region of the stack

Attributes

availability_zone

The availability zone name of the destination file system.

One zone file system is used as the destination file system when this property is set.

destination_file_system: The existing destination file system for the replication.

kms_key: AWS KMS key used to protect the encrypted file system.

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

Static Methods

classmethod existing_file_system(destination_file_system)

Specify the existing destination file system for the replication.

Parameters:: destination_file_system (IFileSystem) – The existing destination file system for the replication.
Return type:: ReplicationConfiguration

classmethod one_zone_file_system(region, availability_zone, kms_key=None)

Create a new one zone destination file system for the replication.

Parameters:

region (str) – The AWS Region in which the specified availability zone belongs to.
availability_zone (str) – The availability zone name of the destination file system.
kms_key (Optional[IKey]) – AWS KMS key used to protect the encrypted file system. Default is service-managed KMS key for Amazon EFS.

Return type:

ReplicationConfiguration

classmethod regional_file_system(region=None, kms_key=None)

Create a new regional destination file system for the replication.

Parameters:

region (Optional[str]) – The AWS Region in which the destination file system is located. Default is the region of the stack.
kms_key (Optional[IKey]) – AWS KMS key used to protect the encrypted file system. Default is service-managed KMS key for Amazon EFS.

Return type:

ReplicationConfiguration