Package software.amazon.awscdk.services.efs

Class ReplicationConfiguration

java.lang.Object
software.amazon.jsii.JsiiObject
software.amazon.awscdk.services.efs.ReplicationConfiguration
All Implemented Interfaces:
software.amazon.jsii.JsiiSerializable
@Generated(value="jsii-pacmak/1.104.0 (build e79254c)", date="2025-01-07T10:36:06.487Z") @Stability(Stable) public abstract class ReplicationConfiguration extends software.amazon.jsii.JsiiObject
EFS Replication Configuration.

Example: 

 Vpc vpc;
 // auto generate a regional replication destination file system
 // auto generate a regional replication destination file system
 FileSystem.Builder.create(this, "RegionalReplicationFileSystem")
         .vpc(vpc)
         .replicationConfiguration(ReplicationConfiguration.regionalFileSystem("us-west-2"))
         .build();
 // auto generate a one zone replication destination file system
 // auto generate a one zone replication destination file system
 FileSystem.Builder.create(this, "OneZoneReplicationFileSystem")
         .vpc(vpc)
         .replicationConfiguration(ReplicationConfiguration.oneZoneFileSystem("us-east-1", "us-east-1a"))
         .build();
 FileSystem destinationFileSystem = FileSystem.Builder.create(this, "DestinationFileSystem")
         .vpc(vpc)
         // set as the read-only file system for use as a replication destination
         .replicationOverwriteProtection(ReplicationOverwriteProtection.DISABLED)
         .build();
 // specify the replication destination file system
 // specify the replication destination file system
 FileSystem.Builder.create(this, "ReplicationFileSystem")
         .vpc(vpc)
         .replicationConfiguration(ReplicationConfiguration.existingFileSystem(destinationFileSystem))
         .build();

  • Constructor Details

    • ReplicationConfiguration

      protected ReplicationConfiguration(software.amazon.jsii.JsiiObjectRef objRef)

    • ReplicationConfiguration

      protected ReplicationConfiguration(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • ReplicationConfiguration

      @Stability(Stable) protected ReplicationConfiguration(@NotNull ReplicationConfigurationProps options)
      Parameters:
      options - This parameter is required.

  • Method Details

    • existingFileSystem

      @Stability(Stable) @NotNull public static ReplicationConfiguration existingFileSystem(@NotNull IFileSystem destinationFileSystem)
      Specify the existing destination file system for the replication.

      Parameters:
      destinationFileSystem - The existing destination file system for the replication. This parameter is required.

    • oneZoneFileSystem

      @Stability(Stable) @NotNull public static ReplicationConfiguration oneZoneFileSystem(@NotNull String region, @NotNull String availabilityZone, @Nullable IKey kmsKey)
      Create a new one zone destination file system for the replication.

      Parameters:
      region - The AWS Region in which the specified availability zone belongs to. This parameter is required.
      availabilityZone - The availability zone name of the destination file system. This parameter is required.
      kmsKey - AWS KMS key used to protect the encrypted file system.

    • oneZoneFileSystem

      @Stability(Stable) @NotNull public static ReplicationConfiguration oneZoneFileSystem(@NotNull String region, @NotNull String availabilityZone)
      Create a new one zone destination file system for the replication.

      Parameters:
      region - The AWS Region in which the specified availability zone belongs to. This parameter is required.
      availabilityZone - The availability zone name of the destination file system. This parameter is required.

    • regionalFileSystem

      @Stability(Stable) @NotNull public static ReplicationConfiguration regionalFileSystem(@Nullable String region, @Nullable IKey kmsKey)
      Create a new regional destination file system for the replication.

      Parameters:
      region - The AWS Region in which the destination file system is located.
      kmsKey - AWS KMS key used to protect the encrypted file system.

    • regionalFileSystem

      @Stability(Stable) @NotNull public static ReplicationConfiguration regionalFileSystem(@Nullable String region)
      Create a new regional destination file system for the replication.

      Parameters:
      region - The AWS Region in which the destination file system is located.

    • regionalFileSystem

      @Stability(Stable) @NotNull public static ReplicationConfiguration regionalFileSystem()
      Create a new regional destination file system for the replication.

    • getAvailabilityZone

      @Stability(Stable) @Nullable public String getAvailabilityZone()
      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.

    • getDestinationFileSystem

      @Stability(Stable) @Nullable public IFileSystem getDestinationFileSystem()
      The existing destination file system for the replication.

    • getKmsKey

      @Stability(Stable) @Nullable public IKey getKmsKey()
      AWS KMS key used to protect the encrypted file system.

    • getRegion

      @Stability(Stable) @Nullable public String getRegion()
      The AWS Region in which the destination file system is located.