rds_describe_db_cluster_snapshots: Returns information about DB cluster snapshots

Description Usage Arguments Value Request syntax

View source: R/rds_operations.R

Description

Returns information about DB cluster snapshots. This API action supports pagination.

For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide.

This action only applies to Aurora DB clusters.

Usage

1
2
3
rds_describe_db_cluster_snapshots(DBClusterIdentifier,
  DBClusterSnapshotIdentifier, SnapshotType, Filters, MaxRecords, Marker,
  IncludeShared, IncludePublic)

Arguments

DBClusterIdentifier

The ID of the DB cluster to retrieve the list of DB cluster snapshots for. This parameter can't be used in conjunction with the DBClusterSnapshotIdentifier parameter. This parameter isn't case-sensitive.

Constraints:

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

DBClusterSnapshotIdentifier

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

Constraints:

  • If supplied, 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 DB cluster snapshots to be returned. You can specify one of the following values:

  • automated - Return all DB cluster snapshots that have been automatically taken by Amazon RDS for my AWS account.

  • manual - Return all DB cluster snapshots that have been taken by my AWS account.

  • shared - Return all manual DB cluster snapshots that have been shared to my AWS account.

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

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

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

A filter that specifies one or more DB cluster snapshots to describe.

Supported filters:

  • db-cluster-id - Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs).

  • db-cluster-snapshot-id - Accepts DB cluster snapshot identifiers.

  • snapshot-type - Accepts types of DB cluster snapshots.

  • engine - Accepts names of database engines.

MaxRecords

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so you can retrieve the remaining results.

Default: 100

Constraints: Minimum 20, maximum 100.

Marker

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

IncludeShared

A value that indicates whether to include shared manual DB cluster snapshots from other AWS accounts that this AWS account has been given permission to copy or restore. By default, these snapshots are not included.

You can give an AWS account permission to restore a manual DB cluster snapshot from another AWS account by the modify_db_cluster_snapshot_attribute API action.

IncludePublic

A value that indicates whether to include manual DB cluster snapshots that are public and can be copied or restored by any AWS account. By default, the public snapshots are not included.

You can share a manual DB cluster snapshot as public by using the modify_db_cluster_snapshot_attribute API action.

Value

A list with the following syntax:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
list(
  Marker = "string",
  DBClusterSnapshots = list(
    list(
      AvailabilityZones = list(
        "string"
      ),
      DBClusterSnapshotIdentifier = "string",
      DBClusterIdentifier = "string",
      SnapshotCreateTime = as.POSIXct(
        "2015-01-01"
      ),
      Engine = "string",
      AllocatedStorage = 123,
      Status = "string",
      Port = 123,
      VpcId = "string",
      ClusterCreateTime = as.POSIXct(
        "2015-01-01"
      ),
      MasterUsername = "string",
      EngineVersion = "string",
      LicenseModel = "string",
      SnapshotType = "string",
      PercentProgress = 123,
      StorageEncrypted = TRUE|FALSE,
      KmsKeyId = "string",
      DBClusterSnapshotArn = "string",
      SourceDBClusterSnapshotArn = "string",
      IAMDatabaseAuthenticationEnabled = TRUE|FALSE,
      TagList = list(
        list(
          Key = "string",
          Value = "string"
        )
      )
    )
  )
)

Request syntax

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
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
)

paws.database documentation built on March 9, 2021, 5:11 p.m.