AWS API Changes

2022/01/25 - Amazon Elastic File System - 3 new api methods

Changes Use Amazon EFS Replication to replicate your Amazon EFS file system in the AWS Region of your preference.

CreateReplicationConfiguration (new)

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 . The replication configuration specifies the following:

Source file system - an existing EFS file system that you want replicated. The source file system cannot be a destination file system in an existing replication configuration.
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.
- Amazon Web Services Region - The Amazon Web Services Region in which the destination file system is created. EFS Replication is available in all Amazon Web Services Region that Amazon EFS is available in, except the following regions: Asia Pacific (Hong Kong) Europe (Milan), Middle East (Bahrain), Africa (Cape Town), and Asia Pacific (Jakarta).
- Availability zone - If you want the destination file system to use One Zone availability and durability, you must specify the Availability Zone to create the file system in. For more information about EFS storage classes, see Amazon EFS storage classes in the Amazon EFS User Guide .
- Encryption - All destination file systems are created with encryption at rest enabled. You can specify the KMS key that is used to encrypt the destination file system. Your service-managed KMS key for Amazon EFS is used if you don't specify a KMS key. You cannot change this after the file system is created.

The following properties are set by default:

Performance mode - The destination file system's performance mode will match that of the source file system, unless the destination file system uses 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 use the Bursting throughput mode by default. You can modify the throughput mode once the file system is created.

The following properties are turned off by default:

Lifecycle management - EFS lifecycle management and intelligent tiering are not enabled on the destination file system. You can enable EFS lifecycle management and intelligent tiering after the destination file system is created.
Automatic backups - Automatic daily backups not enabled on the destination file system. You can change this setting after the file system is created.

For more information, see Amazon EFS replication .

See also: AWS API Documentation

Request Syntax

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

type SourceFileSystemId

string

param 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.

type Destinations

list

param Destinations

[REQUIRED]

An array of destination configuration objects. Only one destination configuration object is supported.

(dict) --

Describes the destination file system to create in 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) --
  
  Specifies the KMS key you want to use to encrypt the destination file system. If you do not specify a KMS key, EFS uses your default KMS key for Amazon EFS, /aws/elasticfilesystem . This ID can be in one of the following formats:
  - Key ID - A unique identifier of the key, for example 1234abcd-12ab-34cd-56ef-1234567890ab .
  - ARN - An 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 - An ARN for a key alias, for example arn:aws:kms:us-west-2:444455556666:alias/projectKey1 .

rtype

dict

returns

Response Syntax

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

Response Structure

(dict) --
- 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 Amazon EFS file system is located.
- SourceFileSystemArn (string) --
  
  The ARN of the current source file system in the replication configuration.
- OriginalSourceFileSystemArn (string) --
  
  The Amazon Resource Name (ARN) of the original source Amazon EFS file system in the replication configuration.
- CreationTime (datetime) --
  
  Describes when the replication configuration was created.
- Destinations (list) --
  
  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 Amazon EFS 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 successfully completed on the destination file system. Any changes to data on the source file system that occurred prior to this time were successfully replicated to the destination file system. Any changes that occurred after this time might not be fully replicated.

DeleteReplicationConfiguration (new)

Link ¶

Deletes an existing replication configuration. To delete a replication configuration, you must make the request from the Amazon Web Services Region in which the destination file system is located. Deleting a replication configuration ends the replication process. You can write to the destination file system once it's status becomes Writeable .

See also: AWS API Documentation

Request Syntax

client.describe_replication_configurations(
    FileSystemId='string',
    NextToken='string',
    MaxResults=123
)

type FileSystemId

string

param FileSystemId

You can retrieve replication configurations for a specific file system by providing a file system ID.

type NextToken

string

param NextToken

NextToken is present if the response is paginated. You can use NextMarker in a subsequent request to fetch the next page of output.

type MaxResults

integer

param MaxResults

(Optional) You can optionally specify the MaxItems parameter to limit the number of objects returned in a response. The default value is 100.

rtype

dict

returns

Response Syntax

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

Response Structure

(dict) --
- Replications (list) --
  
  The collection of replication configurations returned.
  - (dict) --
    - 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 Amazon EFS file system is located.
    - SourceFileSystemArn (string) --
      
      The ARN of the current source file system in the replication configuration.
    - OriginalSourceFileSystemArn (string) --
      
      The Amazon Resource Name (ARN) of the original source Amazon EFS file system in the replication configuration.
    - CreationTime (datetime) --
      
      Describes when the replication configuration was created.
    - Destinations (list) --
      
      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 Amazon EFS 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 successfully completed on the destination file system. Any changes to data on the source file system that occurred prior to this time were successfully replicated to the destination file system. Any changes that occurred after this time might not be fully replicated.
- NextToken (string) --
  
  You can use the NextToken from the previous response in a subsequent request to fetch the additional descriptions.