Package software.amazon.awscdk.services.efs

Interface CfnFileSystem.ReplicationDestinationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnFileSystem.ReplicationDestinationProperty.Jsii$Proxy

Enclosing class:

CfnFileSystem

@Stability(Stable)
public static interface CfnFileSystem.ReplicationDestinationProperty
extends software.amazon.jsii.JsiiSerializable

Describes the destination file system in the replication configuration.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.efs.*;
 ReplicationDestinationProperty replicationDestinationProperty = ReplicationDestinationProperty.builder()
         .availabilityZoneName("availabilityZoneName")
         .fileSystemId("fileSystemId")
         .kmsKeyId("kmsKeyId")
         .region("region")
         .roleArn("roleArn")
         .status("status")
         .statusMessage("statusMessage")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-efs-filesystem-replicationdestination.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnFileSystem.ReplicationDestinationProperty.Builder	A builder for CfnFileSystem.ReplicationDestinationProperty
static final class	CfnFileSystem.ReplicationDestinationProperty.Jsii$Proxy	An implementation for CfnFileSystem.ReplicationDestinationProperty

Method Summary

Modifier and Type	Method	Description
static CfnFileSystem.ReplicationDestinationProperty.Builder	builder()
default String	getAvailabilityZoneName()	For One Zone file systems, the replication configuration must specify the Availability Zone in which the destination file system is located.
default String	getFileSystemId()	The ID of the destination Amazon EFS file system.
default String	getKmsKeyId()	The ID of an AWS KMS key used to protect the encrypted file system.
default String	getRegion()	The AWS Region in which the destination file system is located.
default String	getRoleArn()	The Amazon Resource Name (ARN) of the current source file system in the replication configuration.
default String	getStatus()	Describes the status of the replication configuration.
default String	getStatusMessage()	Message that provides details about the PAUSED or ERRROR state of the replication destination configuration.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAvailabilityZoneName

@Stability(Stable)
@Nullable
default String getAvailabilityZoneName()

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 .

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-efs-filesystem-replicationdestination.html#cfn-efs-filesystem-replicationdestination-availabilityzonename

getFileSystemId

@Stability(Stable)
@Nullable
default String getFileSystemId()

The ID of the destination Amazon EFS file system.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-efs-filesystem-replicationdestination.html#cfn-efs-filesystem-replicationdestination-filesystemid

getKmsKeyId

@Stability(Stable)
@Nullable
default String getKmsKeyId()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-efs-filesystem-replicationdestination.html#cfn-efs-filesystem-replicationdestination-kmskeyid

getRegion

@Stability(Stable)
@Nullable
default String getRegion()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-efs-filesystem-replicationdestination.html#cfn-efs-filesystem-replicationdestination-region

getRoleArn

@Stability(Stable)
@Nullable
default String getRoleArn()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-efs-filesystem-replicationdestination.html#cfn-efs-filesystem-replicationdestination-rolearn

getStatus

@Stability(Stable)
@Nullable
default String getStatus()

Describes the status of the replication configuration.

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-efs-filesystem-replicationdestination.html#cfn-efs-filesystem-replicationdestination-status

getStatusMessage

@Stability(Stable)
@Nullable
default String getStatusMessage()

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 .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-efs-filesystem-replicationdestination.html#cfn-efs-filesystem-replicationdestination-statusmessage

builder

@Stability(Stable)
static CfnFileSystem.ReplicationDestinationProperty.Builder builder()

Returns:

a CfnFileSystem.ReplicationDestinationProperty.Builder of CfnFileSystem.ReplicationDestinationProperty