Modify Db Cluster Snapshot Attribute
rds_modify_db_cluster_snapshot_attribute | R Documentation |
Adds an attribute and values to, or removes an attribute and values from, a manual DB cluster snapshot¶
Description¶
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 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 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 Web Services
accounts.
Don't add the all
value for any manual DB cluster snapshots that
contain private information that you don't want available to all Amazon
Web Services accounts.
If a manual DB 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.
To view which Amazon Web Services accounts have access to copy or
restore a manual DB cluster snapshot, or whether a manual DB cluster
snapshot is public or private, use the
describe_db_cluster_snapshot_attributes
API operation. The accounts
are returned as values for the restore
attribute.
Usage¶
rds_modify_db_cluster_snapshot_attribute(DBClusterSnapshotIdentifier,
AttributeName, ValuesToAdd, ValuesToRemove)
Arguments¶
DBClusterSnapshotIdentifier
[required] The identifier for the DB cluster snapshot to modify the attributes for.
AttributeName
[required] The name of the DB cluster snapshot attribute to modify.
To manage authorization for other Amazon Web Services accounts to copy or restore a manual DB cluster snapshot, set this value to
restore
.To view the list of attributes available to modify, use the
describe_db_cluster_snapshot_attributes
API operation.ValuesToAdd
A list of DB cluster snapshot attributes to add to the attribute specified by
AttributeName
.To authorize other Amazon Web Services accounts to copy or restore a manual DB cluster snapshot, set this list to include one or more Amazon Web Services account IDs, or
all
to make the manual DB cluster snapshot restorable by any Amazon Web Services 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 Web Services accounts.ValuesToRemove
A list of DB 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 DB cluster snapshot, set this list to include one or more Amazon Web Services account identifiers, or
all
to remove authorization for any Amazon Web Services account to copy or restore the DB cluster snapshot. If you specifyall
, an Amazon Web Services account whose account ID is explicitly added to therestore
attribute can still copy or restore a manual DB cluster snapshot.
Value¶
A list with the following syntax:
list(
DBClusterSnapshotAttributesResult = list(
DBClusterSnapshotIdentifier = "string",
DBClusterSnapshotAttributes = list(
list(
AttributeName = "string",
AttributeValues = list(
"string"
)
)
)
)
)