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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-rds/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",
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#backtrack_identifierString

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

Constraints:

^

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

Returns:

  • (String)


8580
8581
8582
8583
8584
8585
8586
8587
8588
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 8580

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

#db_cluster_identifierString

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)


8580
8581
8582
8583
8584
8585
8586
8587
8588
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 8580

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

#filtersArray<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:



8580
8581
8582
8583
8584
8585
8586
8587
8588
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 8580

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

#markerString

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)


8580
8581
8582
8583
8584
8585
8586
8587
8588
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 8580

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

#max_recordsInteger

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)


8580
8581
8582
8583
8584
8585
8586
8587
8588
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 8580

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