AWS CDK Reference

Appearance

v2.275.0

ReplicationDestinationProperty Struct ​

Describes the destination file system in the replication configuration.

Source
Generated code
Type last changed
v2.169.0 · 21 Nov 2024

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_efs as efs } from 'aws-cdk-lib';
const replicationDestinationProperty: efs.CfnFileSystem.ReplicationDestinationProperty = {
  availabilityZoneName: 'availabilityZoneName',
  fileSystemId: 'fileSystemId',
  kmsKeyId: 'kmsKeyId',
  region: 'region',
  roleArn: 'roleArn',
  status: 'status',
  statusMessage: 'statusMessage',
};

Properties ​

availabilityZoneNameoptionalstringavailability_zone_nameoptionalstravailabilityZoneNameoptionalStringAvailabilityZoneNameoptionalstringAvailabilityZoneNameoptional*string#
For One Zone file systems, the replication configuration must specify the Availability Zone in which the destination file system is located.
notes

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 .

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

fileSystemIdoptionalstringfile_system_idoptionalstrfileSystemIdoptionalStringFileSystemIdoptionalstringFileSystemIdoptional*string#
The ID of the destination Amazon EFS file system.
kmsKeyIdoptionalstringkms_key_idoptionalstrkmsKeyIdoptionalStringKmsKeyIdoptionalstringKmsKeyIdoptional*string#
The ID of an AWS KMS key used to protect the encrypted file system.
regionoptionalstringregionoptionalstrregionoptionalStringRegionoptionalstringRegionoptional*string#
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.

roleArnoptionalstringrole_arnoptionalstrroleArnoptionalStringRoleArnoptionalstringRoleArnoptional*string#
The Amazon Resource Name (ARN) of the current source file system in the replication configuration.
statusoptionalstringstatusoptionalstrstatusoptionalStringStatusoptionalstringStatusoptional*string#
Describes the status of the replication configuration.

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

statusMessageoptionalstringstatus_messageoptionalstrstatusMessageoptionalStringStatusMessageoptionalstringStatusMessageoptional*string#
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 .