AWS::EFS::FileSystem ReplicationDestination

Describes the destination file system in the replication configuration.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{
  "AvailabilityZoneName" : String,
  "FileSystemId" : String,
  "KmsKeyId" : String,
  "Region" : String,
  "RoleArn" : String,
  "Status" : String,
  "StatusMessage" : String
}

YAML

  AvailabilityZoneName: String
  FileSystemId: String
  KmsKeyId: String
  Region: String
  RoleArn: String
  Status: String
  StatusMessage: String

Properties

AvailabilityZoneName

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.

Note

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

Required: No

Type: String

Pattern: .+

Minimum: 1

Maximum: 64

Update requires: No interruption

FileSystemId

The ID of the destination Amazon EFS file system.

Required: No

Type: String

Pattern: ^(arn:aws[-a-z]*:elasticfilesystem:[0-9a-z-:]+:file-system/fs-[0-9a-f]{8,40}|fs-[0-9a-f]{8,40})$

Update requires: No interruption

KmsKeyId

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

Required: No

Type: String

Pattern: ^([0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}|mrk-[0-9a-f]{32}|alias/[a-zA-Z0-9/_-]+|(arn:aws[-a-z]*:kms:[a-z0-9-]+:\d{12}:((key/[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})|(key/mrk-[0-9a-f]{32})|(alias/[a-zA-Z0-9/_-]+))))$

Maximum: 2048

Update requires: No interruption

Region

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

Note

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

Required: No

Type: String

Pattern: ^[a-z]{2}-((iso[a-z]{0,1}-)|(gov-)){0,1}[a-z]+-{0,1}[0-9]{0,1}$

Minimum: 1

Maximum: 64

Update requires: No interruption

RoleArn

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

Required: No

Type: String

Update requires: No interruption

Status

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

Required: No

Type: String

Allowed values: ENABLED | ENABLING | DELETING | ERROR | PAUSED | PAUSING

Update requires: No interruption

StatusMessage

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.

Required: No

Type: String

Update requires: No interruption