Skip to content

Describe Db Cluster Automated Backups

rds_describe_db_cluster_automated_backups R Documentation

Displays backups for both current and deleted DB clusters

Description

Displays backups for both current and deleted DB clusters. For example, use this operation to find details about automated backups for previously deleted clusters. Current clusters are returned for both the describe_db_cluster_automated_backups and describe_db_clusters operations.

All parameters are optional.

Usage

rds_describe_db_cluster_automated_backups(DbClusterResourceId,
  DBClusterIdentifier, Filters, MaxRecords, Marker)

Arguments

DbClusterResourceId

The resource ID of the DB cluster that is the source of the automated backup. This parameter isn't case-sensitive.

DBClusterIdentifier

(Optional) The user-supplied DB cluster identifier. If this parameter is specified, it must match the identifier of an existing DB cluster. It returns information from the specific DB cluster's automated backup. This parameter isn't case-sensitive.

Filters

A filter that specifies which resources to return based on status.

Supported filters are the following:

  • status

    • retained - Automated backups for deleted clusters and after backup replication is stopped.

  • db-cluster-id - Accepts DB cluster identifiers and Amazon Resource Names (ARNs). The results list includes only information about the DB cluster automated backups identified by these ARNs.

  • db-cluster-resource-id - Accepts DB resource identifiers and Amazon Resource Names (ARNs). The results list includes only information about the DB cluster resources identified by these ARNs.

Returns all resources by default. The status for each resource is specified in the response.

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 that you can retrieve the remaining results.

Marker

The pagination token provided in the previous request. If this parameter is specified the response includes only records beyond the marker, up to MaxRecords.

Value

A list with the following syntax: 

list(
  Marker = "string",
  DBClusterAutomatedBackups = list(
    list(
      Engine = "string",
      VpcId = "string",
      DBClusterAutomatedBackupsArn = "string",
      DBClusterIdentifier = "string",
      RestoreWindow = list(
        EarliestTime = as.POSIXct(
          "2015-01-01"
        ),
        LatestTime = as.POSIXct(
          "2015-01-01"
        )
      ),
      MasterUsername = "string",
      DbClusterResourceId = "string",
      Region = "string",
      LicenseModel = "string",
      Status = "string",
      IAMDatabaseAuthenticationEnabled = TRUE|FALSE,
      ClusterCreateTime = as.POSIXct(
        "2015-01-01"
      ),
      StorageEncrypted = TRUE|FALSE,
      AllocatedStorage = 123,
      EngineVersion = "string",
      DBClusterArn = "string",
      BackupRetentionPeriod = 123,
      EngineMode = "string",
      AvailabilityZones = list(
        "string"
      ),
      Port = 123,
      KmsKeyId = "string",
      StorageType = "string",
      Iops = 123,
      AwsBackupRecoveryPointArn = "string",
      StorageThroughput = 123
    )
  )
)

Request syntax

svc$describe_db_cluster_automated_backups(
  DbClusterResourceId = "string",
  DBClusterIdentifier = "string",
  Filters = list(
    list(
      Name = "string",
      Values = list(
        "string"
      )
    )
  ),
  MaxRecords = 123,
  Marker = "string"
)