EFS / Client / create_replication_configuration

create_replication_configuration#

EFS.Client.create_replication_configuration(**kwargs)#

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.
Note
After the file system is created, you cannot change the KMS key.

Note

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.

Request Syntax

response = client.create_replication_configuration(
    SourceFileSystemId='string',
    Destinations=[
        {
            'Region': 'string',
            'AvailabilityZoneName': 'string',
            'KmsKeyId': 'string',
            'FileSystemId': 'string'
        },
    ]
)

Parameters:

SourceFileSystemId (string) –
[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 (list) –
[REQUIRED]

An array of destination configuration objects. Only one destination configuration object is supported.
- (dict) –
  
  Describes the new or existing destination file system for the replication configuration.
  - Region (string) –
    
    To create a file system that uses Regional storage, specify the Amazon Web Services Region in which to create the destination file system.
  - AvailabilityZoneName (string) –
    
    To create a file system that uses One Zone storage, specify the name of the Availability Zone in which to create the destination file system.
  - KmsKeyId (string) –
    
    Specify the Key Management Service (KMS) key that you want to use to encrypt the destination file system. If you do not specify a KMS key, Amazon EFS uses your default KMS key for Amazon EFS, /aws/elasticfilesystem. This ID can be in one of the following formats:
    - Key ID - The unique identifier of the key, for example 1234abcd-12ab-34cd-56ef-1234567890ab.
    - ARN - The Amazon Resource Name (ARN) for the key, for example arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab.
    - Key alias - A previously created display name for a key, for example alias/projectKey1.
    - Key alias ARN - The ARN for a key alias, for example arn:aws:kms:us-west-2:444455556666:alias/projectKey1.
  - FileSystemId (string) –
    
    The ID of the file system to use for the destination. The file system’s replication overwrite replication must be disabled. If you do not provide an ID, then EFS creates a new file system for the replication destination.

Return type:

dict

Returns:

Response Syntax

{
    'SourceFileSystemId': 'string',
    'SourceFileSystemRegion': 'string',
    'SourceFileSystemArn': 'string',
    'OriginalSourceFileSystemArn': 'string',
    'CreationTime': datetime(2015, 1, 1),
    'Destinations': [
        {
            'Status': 'ENABLED'|'ENABLING'|'DELETING'|'ERROR'|'PAUSED'|'PAUSING',
            'FileSystemId': 'string',
            'Region': 'string',
            'LastReplicatedTimestamp': datetime(2015, 1, 1)
        },
    ]
}

Response Structure

(dict) –

Describes the replication configuration for a specific file system.
- SourceFileSystemId (string) –
  
  The ID of the source Amazon EFS file system that is being replicated.
- SourceFileSystemRegion (string) –
  
  The Amazon Web Services Region in which the source EFS file system is located.
- SourceFileSystemArn (string) –
  
  The Amazon Resource Name (ARN) of the current source file system in the replication configuration.
- OriginalSourceFileSystemArn (string) –
  
  The Amazon Resource Name (ARN) of the original source EFS file system in the replication configuration.
- CreationTime (datetime) –
  
  Describes when the replication configuration was created.
- Destinations (list) –
  
  An array of destination objects. Only one destination object is supported.
  - (dict) –
    
    Describes the destination file system in the replication configuration.
    - Status (string) –
      
      Describes the status of the destination EFS file system.
      - The Paused state occurs as a result of opting out of the source or destination Region after the replication configuration was created. To resume replication for the file system, you need to again opt in to the Amazon Web Services Region. For more information, see Managing Amazon Web Services Regions in the Amazon Web Services General Reference Guide.
      - The Error state occurs when either the source or the destination file system (or both) is in a failed state and is unrecoverable. For more information, see Monitoring replication status in the Amazon EFS User Guide. You must delete the replication configuration, and then restore the most recent backup of the failed file system (either the source or the destination) to a new file system.
    - FileSystemId (string) –
      
      The ID of the destination Amazon EFS file system.
    - Region (string) –
      
      The Amazon Web Services Region in which the destination file system is located.
    - LastReplicatedTimestamp (datetime) –
      
      The time when the most recent sync was successfully completed on the destination file system. Any changes to data on the source file system that occurred before this time have been successfully replicated to the destination file system. Any changes that occurred after this time might not be fully replicated.

Exceptions

EFS.Client.exceptions.BadRequest
EFS.Client.exceptions.IncorrectFileSystemLifeCycleState
EFS.Client.exceptions.ValidationException
EFS.Client.exceptions.ReplicationNotFound
EFS.Client.exceptions.FileSystemNotFound
EFS.Client.exceptions.UnsupportedAvailabilityZone
EFS.Client.exceptions.FileSystemLimitExceeded
EFS.Client.exceptions.InsufficientThroughputCapacity
EFS.Client.exceptions.ThroughputLimitExceeded
EFS.Client.exceptions.ConflictException
EFS.Client.exceptions.InternalServerError