aws-cdk-lib.aws_efs.ReplicationConfiguration

ReplicationConfiguration Class

EFS Replication Configuration.

Source

aws-efs/lib/efs-file-system.ts

Type last changed

v2.234.0 · 8 Jan 2026

Example

declare const vpc: ec2.Vpc;

// auto generate a regional replication destination file system
new efs.FileSystem(this, 'RegionalReplicationFileSystem', {
  vpc,
  replicationConfiguration: efs.ReplicationConfiguration.regionalFileSystem('us-west-2'),
});

// auto generate a one zone replication destination file system
new efs.FileSystem(this, 'OneZoneReplicationFileSystem', {
  vpc,
  replicationConfiguration: efs.ReplicationConfiguration.oneZoneFileSystem('us-east-1', 'us-east-1a'),
});

const destinationFileSystem = new efs.FileSystem(this, 'DestinationFileSystem', {
  vpc,
  // set as the read-only file system for use as a replication destination
  replicationOverwriteProtection: efs.ReplicationOverwriteProtection.DISABLED,
});
// specify the replication destination file system
new efs.FileSystem(this, 'ReplicationFileSystem', {
  vpc,
  replicationConfiguration: efs.ReplicationConfiguration.existingFileSystem(destinationFileSystem),
});

Initializer

new ReplicationConfiguration(options: ReplicationConfigurationProps)

ReplicationConfiguration(options: ReplicationConfigurationProps)

new ReplicationConfiguration(ReplicationConfigurationProps options)

new ReplicationConfiguration(ReplicationConfigurationProps options)

NewReplicationConfiguration(Options ReplicationConfigurationProps)

Properties

availabilityZone?may be undefinedstringavailability_zone?may be undefinedstravailabilityZone?may be undefinedStringAvailabilityZone?may be undefinedstringAvailabilityZone?may be undefined*string#

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.

destinationFileSystem?may be undefinedIFileSystemdestination_file_system?may be undefinedIFileSystemdestinationFileSystem?may be undefinedIFileSystemDestinationFileSystem?may be undefinedIFileSystemDestinationFileSystem?may be undefinedIFileSystem#

The existing destination file system for the replication.

kmsKey?may be undefinedIKeykms_key?may be undefinedIKeykmsKey?may be undefinedIKeyKmsKey?may be undefinedIKeyKmsKey?may be undefinedIKey#

AWS KMS key used to protect the encrypted file system.

region?may be undefinedstringregion?may be undefinedstrregion?may be undefinedStringRegion?may be undefinedstringRegion?may be undefined*string#

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

Methods

existingFileSystem(destinationFileSystem: IFileSystemRef): ReplicationConfiguration // chainable@staticmethod def existing_file_system(destination_file_system: IFileSystemRef) -> ReplicationConfigurationpublic static ReplicationConfiguration existingFileSystem(IFileSystemRef destinationFileSystem)public static ReplicationConfiguration ExistingFileSystem(IFileSystemRef destinationFileSystem)func ExistingFileSystem(DestinationFileSystem IFileSystemRef) ReplicationConfigurationstatic#

Specify the existing destination file system for the replication.

1 parameter

Parameters

• destinationFileSystemdestination_file_systemdestinationFileSystemdestinationFileSystemDestinationFileSystem — The existing destination file system for the replication.

oneZoneFileSystem(region: string, availabilityZone: string, kmsKey?: IKey): ReplicationConfiguration // chainable@staticmethod def one_zone_file_system(region: str, availability_zone: str, kms_key: typing.Optional[IKey] = None) -> ReplicationConfigurationpublic static ReplicationConfiguration oneZoneFileSystem(String region, String availabilityZone, IKey kmsKey)public static ReplicationConfiguration OneZoneFileSystem(string region, string availabilityZone, IKey? kmsKey = null)func OneZoneFileSystem(Region *string, AvailabilityZone *string, KmsKey IKey) ReplicationConfigurationstatic#

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

3 parameters

Parameters

• regionregionregionregionRegion — The AWS Region in which the specified availability zone belongs to.
• availabilityZoneavailability_zoneavailabilityZoneavailabilityZoneAvailabilityZone — The availability zone name of the destination file system.
• kmsKeykms_keykmsKeykmsKeyKmsKey — AWS KMS key used to protect the encrypted file system.

regionalFileSystem(region?: string, kmsKey?: IKey): ReplicationConfiguration // chainable@staticmethod def regional_file_system(region: typing.Optional[str] = None, kms_key: typing.Optional[IKey] = None) -> ReplicationConfigurationpublic static ReplicationConfiguration regionalFileSystem(String region, IKey kmsKey)public static ReplicationConfiguration RegionalFileSystem(string? region = null, IKey? kmsKey = null)func RegionalFileSystem(Region *string, KmsKey IKey) ReplicationConfigurationstatic#

Create a new regional destination file system for the replication.

2 parameters

Parameters

• regionregionregionregionRegion — The AWS Region in which the destination file system is located.
• kmsKeykms_keykmsKeykmsKeyKmsKey — AWS KMS key used to protect the encrypted file system.