You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::RDS::Types::DescribeDBClusterBacktracksMessage

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing DescribeDBClusterBacktracksMessage as input to an Aws::Client method, you can use a vanilla Hash:

{
  db_cluster_identifier: "String", # required
  backtrack_identifier: "String",
  filters: [
    {
      name: "String", # required
      values: ["String"], # required
    },
  ],
  max_records: 1,
  marker: "String",
}

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#backtrack_identifier ⇒ String

If specified, this value is the backtrack identifier of the backtrack to be described.

Constraints:

^

Example: 123e4567-e89b-12d3-a456-426655440000

Returns:

  • (String) —

    If specified, this value is the backtrack identifier of the backtrack to be described.

#db_cluster_identifier ⇒ String

The DB cluster identifier of the DB cluster to be described. This parameter is stored as a lowercase string.

Constraints:

  • Must contain from 1 to 63 alphanumeric characters or hyphens.

  • First character must be a letter.

  • Can\'t end with a hyphen or contain two consecutive hyphens.

Example: my-cluster1

Returns:

  • (String) —

    The DB cluster identifier of the DB cluster to be described.

#filters ⇒ Array<Types::Filter>

A filter that specifies one or more DB clusters to describe. Supported filters include the following:

  • db-cluster-backtrack-id - Accepts backtrack identifiers. The results list includes information about only the backtracks identified by these identifiers.

  • db-cluster-backtrack-status - Accepts any of the following backtrack status values:

    • applying

    • completed

    • failed

    • pending

    The results list includes information about only the backtracks identified by these values.

Returns:

  • (Array<Types::Filter>) —

    A filter that specifies one or more DB clusters to describe.

#marker ⇒ String

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

Returns:

  • (String) —

    An optional pagination token provided by a previous DescribeDBClusterBacktracks request.

#max_records ⇒ Integer

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.

Returns:

  • (Integer) —

    The maximum number of records to include in the response.