Class ReplicationConfiguration

EFS Replication Configuration.

Inheritance

ReplicationConfiguration

Namespace: Amazon.CDK.AWS.EFS

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public abstract class ReplicationConfiguration : DeputyBase

Syntax (vb)

Public MustInherit Class ReplicationConfiguration Inherits DeputyBase

Remarks

ExampleMetadata: infused

Examples

Vpc vpc;


            // auto generate a regional replication destination file system
            // auto generate a regional replication destination file system
            new FileSystem(this, "RegionalReplicationFileSystem", new FileSystemProps {
                Vpc = vpc,
                ReplicationConfiguration = ReplicationConfiguration.RegionalFileSystem("us-west-2")
            });

            // auto generate a one zone replication destination file system
            // auto generate a one zone replication destination file system
            new FileSystem(this, "OneZoneReplicationFileSystem", new FileSystemProps {
                Vpc = vpc,
                ReplicationConfiguration = ReplicationConfiguration.OneZoneFileSystem("us-east-1", "us-east-1a")
            });

            var destinationFileSystem = new FileSystem(this, "DestinationFileSystem", new FileSystemProps {
                Vpc = vpc,
                // set as the read-only file system for use as a replication destination
                ReplicationOverwriteProtection = ReplicationOverwriteProtection.DISABLED
            });
            // specify the replication destination file system
            // specify the replication destination file system
            new FileSystem(this, "ReplicationFileSystem", new FileSystemProps {
                Vpc = vpc,
                ReplicationConfiguration = ReplicationConfiguration.ExistingFileSystem(destinationFileSystem)
            });

Synopsis

Constructors

ReplicationConfiguration(IReplicationConfigurationProps)

EFS Replication Configuration.

Properties

AvailabilityZone	The availability zone name of the destination file system.
DestinationFileSystem	The existing destination file system for the replication.
KmsKey	AWS KMS key used to protect the encrypted file system.
Region	The AWS Region in which the destination file system is located.

Methods

ExistingFileSystem(IFileSystemRef)	Specify the existing destination file system for the replication.
OneZoneFileSystem(string, string, IKey?)	Create a new one zone destination file system for the replication.
RegionalFileSystem(string?, IKey?)	Create a new regional destination file system for the replication.

Constructors

ReplicationConfiguration(IReplicationConfigurationProps)

EFS Replication Configuration.

protected ReplicationConfiguration(IReplicationConfigurationProps options)

Parameters

options IReplicationConfigurationProps

Remarks

ExampleMetadata: infused

Examples

Vpc vpc;


            // auto generate a regional replication destination file system
            // auto generate a regional replication destination file system
            new FileSystem(this, "RegionalReplicationFileSystem", new FileSystemProps {
                Vpc = vpc,
                ReplicationConfiguration = ReplicationConfiguration.RegionalFileSystem("us-west-2")
            });

            // auto generate a one zone replication destination file system
            // auto generate a one zone replication destination file system
            new FileSystem(this, "OneZoneReplicationFileSystem", new FileSystemProps {
                Vpc = vpc,
                ReplicationConfiguration = ReplicationConfiguration.OneZoneFileSystem("us-east-1", "us-east-1a")
            });

            var destinationFileSystem = new FileSystem(this, "DestinationFileSystem", new FileSystemProps {
                Vpc = vpc,
                // set as the read-only file system for use as a replication destination
                ReplicationOverwriteProtection = ReplicationOverwriteProtection.DISABLED
            });
            // specify the replication destination file system
            // specify the replication destination file system
            new FileSystem(this, "ReplicationFileSystem", new FileSystemProps {
                Vpc = vpc,
                ReplicationConfiguration = ReplicationConfiguration.ExistingFileSystem(destinationFileSystem)
            });

Properties

AvailabilityZone

The availability zone name of the destination file system.

public virtual string? AvailabilityZone { get; }

Property Value

string

Remarks

One zone file system is used as the destination file system when this property is set.

DestinationFileSystem

The existing destination file system for the replication.

public virtual IFileSystem? DestinationFileSystem { get; }

Property Value

IFileSystem

Remarks

ExampleMetadata: infused

KmsKey

AWS KMS key used to protect the encrypted file system.

public virtual IKey? KmsKey { get; }

Property Value

IKey

Remarks

ExampleMetadata: infused

Region

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

public virtual string? Region { get; }

Property Value

string

Remarks

ExampleMetadata: infused

Methods

ExistingFileSystem(IFileSystemRef)

Specify the existing destination file system for the replication.

public static ReplicationConfiguration ExistingFileSystem(IFileSystemRef destinationFileSystem)

Parameters

destinationFileSystem IFileSystemRef: The existing destination file system for the replication.

Returns

ReplicationConfiguration

Remarks

ExampleMetadata: infused

OneZoneFileSystem(string, string, IKey?)

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

public static ReplicationConfiguration OneZoneFileSystem(string region, string availabilityZone, IKey? kmsKey = null)

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

Remarks

ExampleMetadata: infused

RegionalFileSystem(string?, IKey?)

Create a new regional destination file system for the replication.

public static ReplicationConfiguration RegionalFileSystem(string? region = null, IKey? kmsKey = null)

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

Remarks

ExampleMetadata: infused