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 accounts, specify restore
as the AttributeName
, and use the ValuesToAdd
parameter to add a list of IDs of the 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 accounts. Do not add the all
value for any manual cluster snapshots that contain private information that you don’t want available to all accounts. If a manual cluster snapshot is encrypted, it can be shared, but only by specifying a list of authorized 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
See ‘aws help’ for descriptions of global parameters.
modify-db-cluster-snapshot-attribute
--db-cluster-snapshot-identifier <value>
--attribute-name <value>
[--values-to-add <value>]
[--values-to-remove <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
--db-cluster-snapshot-identifier
(string)
The identifier for the cluster snapshot to modify the attributes for.
--attribute-name
(string)
The name of the cluster snapshot attribute to modify.
To manage authorization for other accounts to copy or restore a manual cluster snapshot, set this value to
restore
.
--values-to-add
(list)
A list of cluster snapshot attributes to add to the attribute specified by
AttributeName
.To authorize other accounts to copy or restore a manual cluster snapshot, set this list to include one or more account IDs. To make the manual cluster snapshot restorable by any account, set it to
all
. Do not add theall
value for any manual cluster snapshots that contain private information that you don’t want to be available to all accounts.(string)
Syntax:
"string" "string" ...
--values-to-remove
(list)
A list of cluster snapshot attributes to remove from the attribute specified by
AttributeName
.To remove authorization for other accounts to copy or restore a manual cluster snapshot, set this list to include one or more account identifiers. To remove authorization for any account to copy or restore the cluster snapshot, set it to
all
. If you specifyall
, an account whose account ID is explicitly added to therestore
attribute can still copy or restore a manual cluster snapshot.(string)
Syntax:
"string" "string" ...
--cli-input-json
| --cli-input-yaml
(string)
Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton
. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml
.
--generate-cli-skeleton
(string)
Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input
, prints a sample input JSON that can be used as an argument for --cli-input-json
. Similarly, if provided yaml-input
it will print a sample input YAML that can be used with --cli-input-yaml
. If provided with the value output
, it validates the command inputs and returns a sample output JSON for that command.
See ‘aws help’ for descriptions of global parameters.
Example 1: To add an attribute to an Amazon DocumentDB snapshot
The following modify-db-cluster-snapshot-attribute
example adds four attribute values to an Amazon DocumentDB cluster snapshot.
aws docdb modify-db-cluster-snapshot-attribute \
--db-cluster-snapshot-identifier sample-cluster-snapshot \
--attribute-name restore \
--values-to-add all 123456789011 123456789012 123456789013
Output:
{
"DBClusterSnapshotAttributesResult": {
"DBClusterSnapshotAttributes": [
{
"AttributeName": "restore",
"AttributeValues": [
"all",
"123456789011",
"123456789012",
"123456789013"
]
}
],
"DBClusterSnapshotIdentifier": "sample-cluster-snapshot"
}
}
Example 2: To remove attributes from an Amazon DocumentDB snapshot
The following modify-db-cluster-snapshot-attribute
example removes two attribute values from an Amazon DocumentDB cluster snapshot.
aws docdb modify-db-cluster-snapshot-attribute \
--db-cluster-snapshot-identifier sample-cluster-snapshot \
--attribute-name restore \
--values-to-remove 123456789012 all
Output:
{
"DBClusterSnapshotAttributesResult": {
"DBClusterSnapshotAttributes": [
{
"AttributeName": "restore",
"AttributeValues": [
"123456789011",
"123456789013"
]
}
],
"DBClusterSnapshotIdentifier": "sample-cluster-snapshot"
}
}
For more information, see ModifyDBClusterSnapshotAttribute in the Amazon DocumentDB Developer Guide.
DBClusterSnapshotAttributesResult -> (structure)
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.
(structure)
Contains the name and values of a manual cluster snapshot attribute.
Manual cluster snapshot attributes are used to authorize other 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 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 torestore
, then this element returns a list of IDs of the accounts that are authorized to copy or restore the manual cluster snapshot. If a value ofall
is in the list, then the manual cluster snapshot is public and available for any account to copy or restore.(string)