EFS / Client / update_file_system_protection

update_file_system_protection

EFS.Client.update_file_system_protection(**kwargs)

Updates protection on the file system.

This operation requires permissions for the elasticfilesystem:UpdateFileSystemProtection action.

See also: AWS API Documentation

Request Syntax

response = client.update_file_system_protection(
    FileSystemId='string',
    ReplicationOverwriteProtection='ENABLED'|'DISABLED'|'REPLICATING'
)
Parameters:

  • FileSystemId (string) –

    [REQUIRED]

    The ID of the file system to update.

  • ReplicationOverwriteProtection (string) –

    The status of the file system’s replication overwrite protection.

    • ENABLED – The file system cannot be used as the destination file system in a replication configuration. The file system is writeable. Replication overwrite protection is ENABLED by default.

    • DISABLED – The file system can be used as the destination file system in a replication configuration. The file system is read-only and can only be modified by EFS replication.

    • REPLICATING – The file system is being used as the destination file system in a replication configuration. The file system is read-only and is only modified only by EFS replication.

    If the replication configuration is deleted, the file system’s replication overwrite protection is re-enabled and the file system becomes writeable.

Return type:

dict

Returns:

Response Syntax

{
    'ReplicationOverwriteProtection': 'ENABLED'|'DISABLED'|'REPLICATING'
}

Response Structure

  • (dict) –

    Describes the protection on a file system.

    • ReplicationOverwriteProtection (string) –

      The status of the file system’s replication overwrite protection.

      • ENABLED – The file system cannot be used as the destination file system in a replication configuration. The file system is writeable. Replication overwrite protection is ENABLED by default.

      • DISABLED – The file system can be used as the destination file system in a replication configuration. The file system is read-only and can only be modified by EFS replication.

      • REPLICATING – The file system is being used as the destination file system in a replication configuration. The file system is read-only and is modified only by EFS replication.

      If the replication configuration is deleted, the file system’s replication overwrite protection is re-enabled, the file system becomes writeable.

Exceptions