DocDB / Client / modify_db_cluster_snapshot_attribute

modify_db_cluster_snapshot_attribute

DocDB.Client.modify_db_cluster_snapshot_attribute(**kwargs)

Adds an attribute and values to, or removes an attribute and values from, a manual cluster snapshot.

To share a manual cluster snapshot with other Amazon Web Services accounts, specify restore as the AttributeName, and use the ValuesToAdd parameter to add a list of IDs of the Amazon Web Services accounts that are authorized to restore the manual cluster snapshot. Use the value all to make the manual cluster snapshot public, which means that it can be copied or restored by all Amazon Web Services accounts. Do not add the all value for any manual cluster snapshots that contain private information that you don’t want available to all Amazon Web Services accounts. If a manual cluster snapshot is encrypted, it can be shared, but only by specifying a list of authorized Amazon Web Services account IDs for the ValuesToAdd parameter. You can’t use all as a value for that parameter in this case.

See also: AWS API Documentation

Request Syntax

response = client.modify_db_cluster_snapshot_attribute(
    DBClusterSnapshotIdentifier='string',
    AttributeName='string',
    ValuesToAdd=[
        'string',
    ],
    ValuesToRemove=[
        'string',
    ]
)

Parameters:

• DBClusterSnapshotIdentifier (string) –

  [REQUIRED]

  The identifier for the cluster snapshot to modify the attributes for.

• AttributeName (string) –

  [REQUIRED]

  The name of the cluster snapshot attribute to modify.

  To manage authorization for other Amazon Web Services accounts to copy or restore a manual cluster snapshot, set this value to restore.

• ValuesToAdd (list) –

  A list of cluster snapshot attributes to add to the attribute specified by AttributeName.

  To authorize other Amazon Web Services accounts to copy or restore a manual cluster snapshot, set this list to include one or more Amazon Web Services account IDs. To make the manual cluster snapshot restorable by any Amazon Web Services account, set it to all. Do not add the all value for any manual cluster snapshots that contain private information that you don’t want to be available to all Amazon Web Services accounts.

  • (string) –

• ValuesToRemove (list) –

  A list of cluster snapshot attributes to remove from the attribute specified by AttributeName.

  To remove authorization for other Amazon Web Services accounts to copy or restore a manual cluster snapshot, set this list to include one or more Amazon Web Services account identifiers. To remove authorization for any Amazon Web Services account to copy or restore the cluster snapshot, set it to all . If you specify all, an Amazon Web Services account whose account ID is explicitly added to the restore attribute can still copy or restore a manual cluster snapshot.

  • (string) –

Return type:

dict

Returns:

Response Syntax

{
    'DBClusterSnapshotAttributesResult': {
        'DBClusterSnapshotIdentifier': 'string',
        'DBClusterSnapshotAttributes': [
            {
                'AttributeName': 'string',
                'AttributeValues': [
                    'string',
                ]
            },
        ]
    }
}

Response Structure

• (dict) –

  • DBClusterSnapshotAttributesResult (dict) –

    Detailed information about the attributes that are associated with a cluster snapshot.

    • DBClusterSnapshotIdentifier (string) –

      The identifier of the cluster snapshot that the attributes apply to.

    • DBClusterSnapshotAttributes (list) –

      The list of attributes and values for the cluster snapshot.

      • (dict) –

        Contains the name and values of a manual cluster snapshot attribute.

        Manual cluster snapshot attributes are used to authorize other Amazon Web Services accounts to restore a manual cluster snapshot.

        • AttributeName (string) –

          The name of the manual cluster snapshot attribute.

          The attribute named restore refers to the list of Amazon Web Services accounts that have permission to copy or restore the manual cluster snapshot.

        • AttributeValues (list) –

          The values for the manual cluster snapshot attribute.

          If the AttributeName field is set to restore, then this element returns a list of IDs of the Amazon Web Services accounts that are authorized to copy or restore the manual cluster snapshot. If a value of all is in the list, then the manual cluster snapshot is public and available for any Amazon Web Services account to copy or restore.

          • (string) –

Exceptions

• DocDB.Client.exceptions.DBClusterSnapshotNotFoundFault

• DocDB.Client.exceptions.InvalidDBClusterSnapshotStateFault

• DocDB.Client.exceptions.SharedSnapshotQuotaExceededFault