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

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-rds/types.rb

Overview

Note:

When making an API call, you may pass DescribeDBClusterBacktracksMessage data as a 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:

  • Must contain a valid universally unique identifier (UUID). For more information about UUIDs, see [A Universally Unique Identifier (UUID) URN Namespace].

^

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

[1]: www.ietf.org/rfc/rfc4122.txt

Returns:

  • (String) 


6600
6601
6602
6603
6604
6605
6606
6607
 
# File 'lib/aws-sdk-rds/types.rb', line 6600

class DescribeDBClusterBacktracksMessage < Struct.new(
  :db_cluster_identifier,
  :backtrack_identifier,
  :filters,
  :max_records,
  :marker)
  include Aws::Structure
end

#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) 


6600
6601
6602
6603
6604
6605
6606
6607
 
# File 'lib/aws-sdk-rds/types.rb', line 6600

class DescribeDBClusterBacktracksMessage < Struct.new(
  :db_cluster_identifier,
  :backtrack_identifier,
  :filters,
  :max_records,
  :marker)
  include Aws::Structure
end

#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. For more information about backtrack status values, see DBClusterBacktrack.

Returns:



6600
6601
6602
6603
6604
6605
6606
6607
 
# File 'lib/aws-sdk-rds/types.rb', line 6600

class DescribeDBClusterBacktracksMessage < Struct.new(
  :db_cluster_identifier,
  :backtrack_identifier,
  :filters,
  :max_records,
  :marker)
  include Aws::Structure
end

#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) 


6600
6601
6602
6603
6604
6605
6606
6607
 
# File 'lib/aws-sdk-rds/types.rb', line 6600

class DescribeDBClusterBacktracksMessage < Struct.new(
  :db_cluster_identifier,
  :backtrack_identifier,
  :filters,
  :max_records,
  :marker)
  include Aws::Structure
end

#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 that the remaining results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

Returns:

  • (Integer) 


6600
6601
6602
6603
6604
6605
6606
6607
 
# File 'lib/aws-sdk-rds/types.rb', line 6600

class DescribeDBClusterBacktracksMessage < Struct.new(
  :db_cluster_identifier,
  :backtrack_identifier,
  :filters,
  :max_records,
  :marker)
  include Aws::Structure
end