docdb_describe_db_cluster_snapshot_attributes: Returns a list of cluster snapshot attribute names and values...

Description Usage Arguments Value Request syntax

View source: R/docdb_operations.R

Description

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

When you share snapshots with other AWS accounts, describe_db_cluster_snapshot_attributes returns the restore attribute and a list of IDs for the AWS 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 AWS accounts.

Usage

1
2
docdb_describe_db_cluster_snapshot_attributes(
  DBClusterSnapshotIdentifier)

Arguments

DBClusterSnapshotIdentifier

[required] The identifier for the cluster snapshot to describe the attributes for.

Value

A list with the following syntax:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
list(
  DBClusterSnapshotAttributesResult = list(
    DBClusterSnapshotIdentifier = "string",
    DBClusterSnapshotAttributes = list(
      list(
        AttributeName = "string",
        AttributeValues = list(
          "string"
        )
      )
    )
  )
)

Request syntax

1
2
3
svc$describe_db_cluster_snapshot_attributes(
  DBClusterSnapshotIdentifier = "string"
)

paws.database documentation built on Aug. 23, 2021, 9:18 a.m.