Amazon Elastic File System

2024/11/19 - Amazon Elastic File System - 3 updated api methods

Changes  Add support for the new parameters in EFS replication APIs

CreateReplicationConfiguration (updated) Link ¶
Changes (request, response)
Request 
{'Destinations': {'RoleArn': 'string'}}
Response 
{'Destinations': {'OwnerId': 'string',
                  'RoleArn': 'string',
                  'StatusMessage': 'string'},
 'SourceFileSystemOwnerId': 'string'}

Creates a replication configuration to either a new or existing EFS 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 to replicate.

  • Destination file system – The destination file system to which the source file system is replicated. There can only be one destination file system in a replication configuration.

This operation requires permissions for the elasticfilesystem:CreateReplicationConfiguration action. Additionally, other permissions are required depending on how you are replicating file systems. For more information, see Required permissions for replication in the Amazon EFS User Guide.

See also: AWS API Documentation

Request Syntax

client.create_replication_configuration(
    SourceFileSystemId='string',
    Destinations=[
        {
            'Region': 'string',
            'AvailabilityZoneName': 'string',
            'KmsKeyId': 'string',
            'FileSystemId': 'string',
            'RoleArn': '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 new or existing destination file system for the replication configuration.

    • If you want to replicate to a new file system, do not specify the File System ID for the destination file system. Amazon EFS creates a new, empty file system. For One Zone storage, specify the Availability Zone to create the file system in. To use an Key Management Service key other than the default KMS key, then specify it. For more information, see Configuring replication to new Amazon EFS file system in the Amazon EFS User Guide.

    • If you want to replicate to an existing file system that's in the same account as the source file system, then you need to provide the ID or Amazon Resource Name (ARN) of the file system to which to replicate. The file system's replication overwrite protection must be disabled. For more information, see Replicating to an existing file system in the Amazon EFS User Guide.

    • If you are replicating the file system to a file system that's in a different account than the source file system (cross-account replication), you need to provide the ARN for the file system and the IAM role that allows Amazon EFS to perform replication on the destination account. The file system's replication overwrite protection must be disabled. For more information, see Replicating across Amazon Web Services accounts in the Amazon EFS User Guide.

    • 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. The Region must be enabled for the Amazon Web Services account that owns the source file system. For more information, see Managing Amazon Web Services Regions in the Amazon Web Services General Reference Reference Guide.

    • 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 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 or ARN of the file system to use for the destination. For cross-account replication, this must be an ARN. The file system's replication overwrite replication must be disabled. If no ID or ARN is specified, then a new file system is created.

    • RoleArn (string) --

      Amazon Resource Name (ARN) of the IAM role in the source account that allows Amazon EFS to perform replication on its behalf. This is optional for same-account replication and required for cross-account replication.

rtype:

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),
            'OwnerId': 'string',
            'StatusMessage': 'string',
            'RoleArn': 'string'
        },
    ],
    'SourceFileSystemOwnerId': 'string'
}

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 replication configuration. For more information about replication status, see Viewing replication details in the Amazon EFS User Guide.

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

        • OwnerId (string) --

          ID of the Amazon Web Services account in which the destination file system resides.

        • StatusMessage (string) --

          Message that provides details about the PAUSED or ERRROR state of the replication destination configuration. For more information about replication status messages, see Viewing replication details in the Amazon EFS User Guide.

        • RoleArn (string) --

          Amazon Resource Name (ARN) of the IAM role in the source account that allows Amazon EFS to perform replication on its behalf. This is optional for same-account replication and required for cross-account replication.

    • SourceFileSystemOwnerId (string) --

      ID of the Amazon Web Services account in which the source file system resides.

DeleteReplicationConfiguration (updated) Link ¶
Changes (request) 
{'DeletionMode': 'ALL_CONFIGURATIONS | LOCAL_CONFIGURATION_ONLY'}

Deletes a replication configuration. Deleting a replication configuration ends the replication process. After a replication configuration is deleted, the destination file system becomes Writeable and its replication overwrite protection is re-enabled. For more information, see Delete a replication configuration.

This operation requires permissions for the elasticfilesystem:DeleteReplicationConfiguration action.

See also: AWS API Documentation

Request Syntax

client.delete_replication_configuration(
    SourceFileSystemId='string',
    DeletionMode='ALL_CONFIGURATIONS'|'LOCAL_CONFIGURATION_ONLY'
)
type SourceFileSystemId:

string

param SourceFileSystemId:

[REQUIRED]

The ID of the source file system in the replication configuration.

type DeletionMode:

string

param DeletionMode:

When replicating across Amazon Web Services accounts or across Amazon Web Services Regions, Amazon EFS deletes the replication configuration from both the source and destination account or Region ( ALL_CONFIGURATIONS) by default. If there's a configuration or permissions issue that prevents Amazon EFS from deleting the replication configuration from both sides, you can use the LOCAL_CONFIGURATION_ONLY mode to delete the replication configuration from only the local side (the account or Region from which the delete is performed).

returns:

None

DescribeReplicationConfigurations (updated) Link ¶
Changes (response) 
{'Replications': {'Destinations': {'OwnerId': 'string',
                                   'RoleArn': 'string',
                                   'StatusMessage': 'string'},
                  'SourceFileSystemOwnerId': 'string'}}

Retrieves the replication configuration for a specific file system. If a file system is not specified, all of the replication configurations for the Amazon Web Services account in an Amazon Web Services Region are retrieved.

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 the replication configuration for a specific file system by providing its file system ID. For cross-account,cross-region replication, an account can only describe the replication configuration for a file system in its own Region.

type NextToken:

string

param NextToken:

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

type MaxResults:

integer

param MaxResults:

(Optional) To limit the number of objects returned in a response, you can specify the MaxItems parameter. 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'|'PAUSED'|'PAUSING',
                    'FileSystemId': 'string',
                    'Region': 'string',
                    'LastReplicatedTimestamp': datetime(2015, 1, 1),
                    'OwnerId': 'string',
                    'StatusMessage': 'string',
                    'RoleArn': 'string'
                },
            ],
            'SourceFileSystemOwnerId': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • Replications (list) --

      The collection of replication configurations that is returned.

      • (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 replication configuration. For more information about replication status, see Viewing replication details in the Amazon EFS User Guide.

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

            • OwnerId (string) --

              ID of the Amazon Web Services account in which the destination file system resides.

            • StatusMessage (string) --

              Message that provides details about the PAUSED or ERRROR state of the replication destination configuration. For more information about replication status messages, see Viewing replication details in the Amazon EFS User Guide.

            • RoleArn (string) --

              Amazon Resource Name (ARN) of the IAM role in the source account that allows Amazon EFS to perform replication on its behalf. This is optional for same-account replication and required for cross-account replication.

        • SourceFileSystemOwnerId (string) --

          ID of the Amazon Web Services account in which the source file system resides.

    • NextToken (string) --

      You can use the NextToken from the previous response in a subsequent request to fetch the additional descriptions.