class ReplicationConfiguration

Language	Type name
.NET	Amazon.CDK.AWS.EFS.ReplicationConfiguration
Go	github.com/aws/aws-cdk-go/awscdk/v2/awsefs#ReplicationConfiguration
Java	software.amazon.awscdk.services.efs.ReplicationConfiguration
Python	aws_cdk.aws_efs.ReplicationConfiguration
TypeScript (source)	aws-cdk-lib » aws_efs » ReplicationConfiguration

EFS Replication Configuration.

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)

Parameters

• options ReplicationConfigurationProps

Properties

Name	Type	Description
availabilityZone?	string	The availability zone name of the destination file system.
destinationFileSystem?	IFileSystem	The existing destination file system for the replication.
kmsKey?	IKey	AWS KMS key used to protect the encrypted file system.
region?	string	The AWS Region in which the destination file system is located.

---

availabilityZone?

Type: string (optional)

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?

Type: IFileSystem (optional)

The existing destination file system for the replication.

---

kmsKey?

Type: IKey (optional)

AWS KMS key used to protect the encrypted file system.

---

region?

Type: string (optional)

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

Methods

Name	Description
static existingFileSystem(destinationFileSystem)	Specify the existing destination file system for the replication.
static oneZoneFileSystem(region, availabilityZone, kmsKey?)	Create a new one zone destination file system for the replication.
static regionalFileSystem(region?, kmsKey?)	Create a new regional destination file system for the replication.

---

static existingFileSystem(destinationFileSystem)

public static existingFileSystem(destinationFileSystem: IFileSystem): ReplicationConfiguration

Parameters

• destinationFileSystem IFileSystem — The existing destination file system for the replication.

Returns

• ReplicationConfiguration

Specify the existing destination file system for the replication.

---

static oneZoneFileSystem(region, availabilityZone, kmsKey?)

public static oneZoneFileSystem(region: string, availabilityZone: string, kmsKey?: IKey): ReplicationConfiguration

Parameters

• region string — The AWS Region in which the specified availability zone belongs to.
• availabilityZone string — The availability zone name of the destination file system.
• kmsKey IKey — AWS KMS key used to protect the encrypted file system.

Returns

• ReplicationConfiguration

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

---

static regionalFileSystem(region?, kmsKey?)

public static regionalFileSystem(region?: string, kmsKey?: IKey): ReplicationConfiguration

Parameters

• region string — The AWS Region in which the destination file system is located.
• kmsKey IKey — AWS KMS key used to protect the encrypted file system.

Returns

• ReplicationConfiguration

Create a new regional destination file system for the replication.