modifyDBSnapshotAttribute method

Future<ModifyDBSnapshotAttributeResult> modifyDBSnapshotAttribute({ required String attributeName, required String dBSnapshotIdentifier, List<String>? valuesToAdd, List<String>? valuesToRemove, })

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

To share a manual DB snapshot with other AWS accounts, specify restore as the AttributeName and use the ValuesToAdd parameter to add a list of IDs of the AWS accounts that are authorized to restore the manual DB snapshot. Uses the value all to make the manual DB snapshot public, which means it can be copied or restored by all AWS accounts. If the manual DB snapshot is encrypted, it can be shared, but only by specifying a list of authorized AWS account IDs for the ValuesToAdd parameter. You can't use all as a value for that parameter in this case.

To view which AWS accounts have access to copy or restore a manual DB snapshot, or whether a manual DB snapshot public or private, use the DescribeDBSnapshotAttributes API action. The accounts are returned as values for the restore attribute.

May throw DBSnapshotNotFoundFault. May throw InvalidDBSnapshotStateFault. May throw SharedSnapshotQuotaExceededFault.

Parameter attributeName : The name of the DB snapshot attribute to modify.

To manage authorization for other AWS accounts to copy or restore a manual DB snapshot, set this value to restore.

Parameter dBSnapshotIdentifier : The identifier for the DB snapshot to modify the attributes for.

Parameter valuesToAdd : A list of DB snapshot attributes to add to the attribute specified by AttributeName.

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

Parameter valuesToRemove : A list of DB snapshot attributes to remove from the attribute specified by AttributeName.

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

Implementation

Future<ModifyDBSnapshotAttributeResult> modifyDBSnapshotAttribute({
  required String attributeName,
  required String dBSnapshotIdentifier,
  List<String>? valuesToAdd,
  List<String>? valuesToRemove,
}) async {
  ArgumentError.checkNotNull(attributeName, 'attributeName');
  ArgumentError.checkNotNull(dBSnapshotIdentifier, 'dBSnapshotIdentifier');
  final $request = <String, dynamic>{};
  $request['AttributeName'] = attributeName;
  $request['DBSnapshotIdentifier'] = dBSnapshotIdentifier;
  valuesToAdd?.also((arg) => $request['ValuesToAdd'] = arg);
  valuesToRemove?.also((arg) => $request['ValuesToRemove'] = arg);
  final $result = await _protocol.send(
    $request,
    action: 'ModifyDBSnapshotAttribute',
    version: '2014-10-31',
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    shape: shapes['ModifyDBSnapshotAttributeMessage'],
    shapes: shapes,
    resultWrapper: 'ModifyDBSnapshotAttributeResult',
  );
  return ModifyDBSnapshotAttributeResult.fromXml($result);
}