Create Replication Configuration

efs_create_replication_configuration

R Documentation

Creates a replication configuration that replicates an existing EFS file system to a new, read-only file system¶

Description¶

Creates a replication configuration that replicates an existing EFS file system to a new, read-only file system. For more information, see Amazon EFS replication in the Amazon EFS User Guide. The replication configuration specifies the following:

Source file system – The EFS file system that you want replicated. The source file system cannot be a destination file system in an existing replication configuration.
Amazon Web Services Region – The Amazon Web Services Region in which the destination file system is created. Amazon EFS replication is available in all Amazon Web Services Regions in which EFS is available. The Region must be enabled. For more information, see Managing Amazon Web Services Regions in the Amazon Web Services General Reference Reference Guide.
Destination file system configuration – The configuration of the destination file system to which the source file system will be replicated. There can only be one destination file system in a replication configuration.

Parameters for the replication configuration include:
- File system ID – The ID of the destination file system for the replication. If no ID is provided, then EFS creates a new file system with the default settings. For existing file systems, the file system's replication overwrite protection must be disabled. For more information, see Replicating to an existing file system.
- Availability Zone – If you want the destination file system to use One Zone storage, you must specify the Availability Zone to create the file system in. For more information, see EFS file system types in the Amazon EFS User Guide.
- Encryption – All destination file systems are created with encryption at rest enabled. You can specify the Key Management Service (KMS) key that is used to encrypt the destination file system. If you don't specify a KMS key, your service-managed KMS key for Amazon EFS is used.
  
  After the file system is created, you cannot change the KMS key.

After the file system is created, you cannot change the KMS key.

For new destination file systems, the following properties are set by default:

Performance mode - The destination file system's performance mode matches that of the source file system, unless the destination file system uses EFS One Zone storage. In that case, the General Purpose performance mode is used. The performance mode cannot be changed.
Throughput mode - The destination file system's throughput mode matches that of the source file system. After the file system is created, you can modify the throughput mode.
Lifecycle management – Lifecycle management is not enabled on the destination file system. After the destination file system is created, you can enable lifecycle management.
Automatic backups – Automatic daily backups are enabled on the destination file system. After the file system is created, you can change this setting.

For more information, see Amazon EFS replication in the Amazon EFS User Guide.

Usage¶

efs_create_replication_configuration(SourceFileSystemId, Destinations)

Arguments¶

SourceFileSystemId: [required] Specifies the Amazon EFS file system that you want to replicate. This file system cannot already be a source or destination file system in another replication configuration.
Destinations: [required] An array of destination configuration objects. Only one destination configuration object is supported.

Value¶

A list with the following syntax:

list(
  SourceFileSystemId = "string",
  SourceFileSystemRegion = "string",
  SourceFileSystemArn = "string",
  OriginalSourceFileSystemArn = "string",
  CreationTime = as.POSIXct(
    "2015-01-01"
  ),
  Destinations = list(
    list(
      Status = "ENABLED"|"ENABLING"|"DELETING"|"ERROR"|"PAUSED"|"PAUSING",
      FileSystemId = "string",
      Region = "string",
      LastReplicatedTimestamp = as.POSIXct(
        "2015-01-01"
      )
    )
  )
)

Request syntax¶

svc$create_replication_configuration(
  SourceFileSystemId = "string",
  Destinations = list(
    list(
      Region = "string",
      AvailabilityZoneName = "string",
      KmsKeyId = "string",
      FileSystemId = "string"
    )
  )
)