ModifyDBClusterSnapshotAttribute
Adds an attribute and values to, or removes an attribute and values from, a manual DB cluster snapshot.
To share a manual DB cluster snapshot with other Amazon accounts, specify
restore
as the AttributeName
and use the ValuesToAdd
parameter to add a list of IDs of the Amazon accounts that are authorized to restore the manual
DB cluster snapshot. Use the value all
to make the manual DB cluster snapshot
public, which means that it can be copied or restored by all Amazon accounts. Do not add the
all
value for any manual DB cluster snapshots that contain private information
that you don't want available to all Amazon accounts. If a manual DB cluster snapshot is
encrypted, it can be shared, but only by specifying a list of authorized Amazon account IDs for
the ValuesToAdd
parameter. You can't use all
as a value for that
parameter in this case.
To view which Amazon accounts have access to copy or restore a manual DB cluster snapshot, or whether a manual DB cluster snapshot public or private, use the DescribeDBClusterSnapshotAttributes API action.
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
- AttributeName
-
The name of the DB cluster snapshot attribute to modify.
To manage authorization for other Amazon accounts to copy or restore a manual DB cluster snapshot, set this value to
restore
.Type: String
Required: Yes
- DBClusterSnapshotIdentifier
-
The identifier for the DB cluster snapshot to modify the attributes for.
Type: String
Required: Yes
- ValuesToAdd.AttributeValue.N
-
A list of DB cluster snapshot attributes to add to the attribute specified by
AttributeName
.To authorize other Amazon accounts to copy or restore a manual DB cluster snapshot, set this list to include one or more Amazon account IDs, or
all
to make the manual DB cluster snapshot restorable by any Amazon account. Do not add theall
value for any manual DB cluster snapshots that contain private information that you don't want available to all Amazon accounts.Type: Array of strings
Required: No
- ValuesToRemove.AttributeValue.N
-
A list of DB cluster snapshot attributes to remove from the attribute specified by
AttributeName
.To remove authorization for other Amazon accounts to copy or restore a manual DB cluster snapshot, set this list to include one or more Amazon account identifiers, or
all
to remove authorization for any Amazon account to copy or restore the DB cluster snapshot. If you specifyall
, an Amazon account whose account ID is explicitly added to therestore
attribute can still copy or restore a manual DB cluster snapshot.Type: Array of strings
Required: No
Response Elements
The following element is returned by the service.
- DBClusterSnapshotAttributesResult
-
Contains the results of a successful call to the DescribeDBClusterSnapshotAttributes API action.
Manual DB cluster snapshot attributes are used to authorize other Amazon accounts to copy or restore a manual DB cluster snapshot. For more information, see the ModifyDBClusterSnapshotAttribute API action.
Type: DBClusterSnapshotAttributesResult object
Errors
For information about the errors that are common to all actions, see Common Errors.
- DBClusterSnapshotNotFoundFault
-
DBClusterSnapshotIdentifier does not refer to an existing DB cluster snapshot.
HTTP Status Code: 404
- InvalidDBClusterSnapshotStateFault
-
The supplied value is not a valid DB cluster snapshot state.
HTTP Status Code: 400
- SharedSnapshotQuotaExceeded
-
You have exceeded the maximum number of accounts that you can share a manual DB snapshot with.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following: