IAmazonNeptune.ModifyDBClusterSnapshotAttribute Method (ModifyDBClusterSnapshotAttributeRequest)

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.

Note:

For .NET Core this operation is only available in asynchronous form. Please refer to ModifyDBClusterSnapshotAttributeAsync.

Namespace: Amazon.Neptune
Assembly: AWSSDK.Neptune.dll
Version: 3.x.y.z

Syntax

public abstract ModifyDBClusterSnapshotAttributeResponse ModifyDBClusterSnapshotAttribute(
         ModifyDBClusterSnapshotAttributeRequest request
)

Parameters

request: Type: Amazon.Neptune.Model.ModifyDBClusterSnapshotAttributeRequest

Container for the necessary parameters to execute the ModifyDBClusterSnapshotAttribute service method.

Return Value

Type: ModifyDBClusterSnapshotAttributeResponse

The response from the ModifyDBClusterSnapshotAttribute service method, as returned by Neptune.

Exceptions

Exception	Condition
DBClusterSnapshotNotFoundException	DBClusterSnapshotIdentifier does not refer to an existing DB cluster snapshot.
InvalidDBClusterSnapshotStateException	The supplied value is not a valid DB cluster snapshot state.
SharedSnapshotQuotaExceededException	You have exceeded the maximum number of accounts that you can share a manual DB snapshot with.

Examples

The following example gives two AWS accounts access to a manual DB cluster snapshot and ensures that the DB cluster snapshot is private by removing the value "all".

To add or remove access to a manual DB cluster snapshot


var response = client.ModifyDBClusterSnapshotAttribute(new ModifyDBClusterSnapshotAttributeRequest 
{
    AttributeName = "restore",
    DBClusterSnapshotIdentifier = "manual-cluster-snapshot1",
    ValuesToAdd = new List<string> {
        "123451234512",
        "123456789012"
    },
    ValuesToRemove = new List<string> {
        "all"
    }
});

DBClusterSnapshotAttributesResult dbClusterSnapshotAttributesResult = response.DBClusterSnapshotAttributesResult;

Version Information

.NET Framework:
Supported in: 4.5 and newer, 3.5

IAmazonNeptune.ModifyDBClusterSnapshotAttribute (ModifyDBClusterSnapshotAttributeRequest)

Method