[ aws . docdb ]

describe-db-cluster-snapshot-attributes

Description

Returns a list of cluster snapshot attribute names and values for a manual DB cluster snapshot.

When you share snapshots with other Amazon Web Services accounts, DescribeDBClusterSnapshotAttributes returns the restore attribute and a list of IDs for the Amazon Web Services accounts that are authorized to copy or restore the manual cluster snapshot. If all is included in the list of values for the restore attribute, then the manual cluster snapshot is public and can be copied or restored by all Amazon Web Services accounts.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  describe-db-cluster-snapshot-attributes
--db-cluster-snapshot-identifier <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--db-cluster-snapshot-identifier (string)

The identifier for the cluster snapshot to describe the attributes for.

--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.

Examples

To list an Amazon DocumentDB snapshot attribute names and values

The following describe-db-cluster-snapshot-attributes example lists the attribute names and values for the Amazon DocumentDB snapshot sample-cluster-snapshot.

aws docdb describe-db-cluster-snapshot-attributes \
    --db-cluster-snapshot-identifier sample-cluster-snapshot

Output:

{
    "DBClusterSnapshotAttributesResult": {
        "DBClusterSnapshotAttributes": [
            {
                "AttributeName": "restore",
                "AttributeValues": []
            }
        ],
        "DBClusterSnapshotIdentifier": "sample-cluster-snapshot"
    }
}

For more information, see DescribeDBClusterSnapshotAttributes in the Amazon DocumentDB Developer Guide.

Output

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 Amazon Web Services 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 Amazon Web Services 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 to restore , then this element returns a list of IDs of the Amazon Web Services accounts that are authorized to copy or restore the manual cluster snapshot. If a value of all is in the list, then the manual cluster snapshot is public and available for any Amazon Web Services account to copy or restore.

(string)