Skip to content

Describe Db Cluster Snapshots

docdb_describe_db_cluster_snapshots R Documentation

Returns information about cluster snapshots

Description

Returns information about cluster snapshots. This API operation supports pagination.

Usage

docdb_describe_db_cluster_snapshots(DBClusterIdentifier,
  DBClusterSnapshotIdentifier, SnapshotType, Filters, MaxRecords, Marker,
  IncludeShared, IncludePublic)

Arguments

DBClusterIdentifier

The ID of the cluster to retrieve the list of cluster snapshots for. This parameter can't be used with the DBClusterSnapshotIdentifier parameter. This parameter is not case sensitive.

Constraints:

  • If provided, must match the identifier of an existing DBCluster.

DBClusterSnapshotIdentifier

A specific cluster snapshot identifier to describe. This parameter can't be used with the DBClusterIdentifier parameter. This value is stored as a lowercase string.

Constraints:

  • If provided, must match the identifier of an existing DBClusterSnapshot.

  • If this identifier is for an automated snapshot, the SnapshotType parameter must also be specified.

SnapshotType

The type of cluster snapshots to be returned. You can specify one of the following values:

  • automated - Return all cluster snapshots that Amazon DocumentDB has automatically created for your Amazon Web Services account.

  • manual - Return all cluster snapshots that you have manually created for your Amazon Web Services account.

  • shared - Return all manual cluster snapshots that have been shared to your Amazon Web Services account.

  • public - Return all cluster snapshots that have been marked as public.

If you don't specify a SnapshotType value, then both automated and manual cluster snapshots are returned. You can include shared cluster snapshots with these results by setting the IncludeShared parameter to true. You can include public cluster snapshots with these results by setting theIncludePublic parameter to true.

The IncludeShared and IncludePublic parameters don't apply for SnapshotType values of manual or automated. The IncludePublic parameter doesn't apply when SnapshotType is set to shared. The IncludeShared parameter doesn't apply when SnapshotType is set to public.

Filters

This parameter is not currently supported.

MaxRecords

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token (marker) is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

Marker

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

IncludeShared

Set to true to include shared manual cluster snapshots from other Amazon Web Services accounts that this Amazon Web Services account has been given permission to copy or restore, and otherwise false. The default is false.

IncludePublic

Set to true to include manual cluster snapshots that are public and can be copied or restored by any Amazon Web Services account, and otherwise false. The default is false.

Value

A list with the following syntax: 

list(
  Marker = "string",
  DBClusterSnapshots = list(
    list(
      AvailabilityZones = list(
        "string"
      ),
      DBClusterSnapshotIdentifier = "string",
      DBClusterIdentifier = "string",
      SnapshotCreateTime = as.POSIXct(
        "2015-01-01"
      ),
      Engine = "string",
      Status = "string",
      Port = 123,
      VpcId = "string",
      ClusterCreateTime = as.POSIXct(
        "2015-01-01"
      ),
      MasterUsername = "string",
      EngineVersion = "string",
      SnapshotType = "string",
      PercentProgress = 123,
      StorageEncrypted = TRUE|FALSE,
      KmsKeyId = "string",
      DBClusterSnapshotArn = "string",
      SourceDBClusterSnapshotArn = "string",
      StorageType = "string"
    )
  )
)

Request syntax

svc$describe_db_cluster_snapshots(
  DBClusterIdentifier = "string",
  DBClusterSnapshotIdentifier = "string",
  SnapshotType = "string",
  Filters = list(
    list(
      Name = "string",
      Values = list(
        "string"
      )
    )
  ),
  MaxRecords = 123,
  Marker = "string",
  IncludeShared = TRUE|FALSE,
  IncludePublic = TRUE|FALSE
)