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

Class: Aws::RDS::Types::BacktrackDBClusterMessage

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 BacktrackDBClusterMessage data as a hash:

{
  db_cluster_identifier: "String", # required
  backtrack_to: Time.now, # required
  force: false,
  use_earliest_time_on_point_in_time_unavailable: false,
}

Instance Attribute Summary collapse

Instance Attribute Details

#backtrack_toTime

The timestamp of the time to backtrack the DB cluster to, specified in ISO 8601 format. For more information about ISO 8601, see the ISO8601 Wikipedia page.

If the specified time is not a consistent time for the DB cluster, Aurora automatically chooses the nearest possible consistent time for the DB cluster.

Constraints:

  • Must contain a valid ISO 8601 timestamp.

  • Can't contain a timestamp set in the future.

Example: 2017-07-08T18:00Z

Returns:

  • (Time)


530
531
532
533
534
535
536
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 530

class BacktrackDBClusterMessage < Struct.new(
  :db_cluster_identifier,
  :backtrack_to,
  :force,
  :use_earliest_time_on_point_in_time_unavailable)
  include Aws::Structure
end

#db_cluster_identifierString

The DB cluster identifier of the DB cluster to be backtracked. 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)


530
531
532
533
534
535
536
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 530

class BacktrackDBClusterMessage < Struct.new(
  :db_cluster_identifier,
  :backtrack_to,
  :force,
  :use_earliest_time_on_point_in_time_unavailable)
  include Aws::Structure
end

#forceBoolean

A value that indicates whether to force the DB cluster to backtrack when binary logging is enabled. Otherwise, an error occurs when binary logging is enabled.

Returns:

  • (Boolean)


530
531
532
533
534
535
536
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 530

class BacktrackDBClusterMessage < Struct.new(
  :db_cluster_identifier,
  :backtrack_to,
  :force,
  :use_earliest_time_on_point_in_time_unavailable)
  include Aws::Structure
end

#use_earliest_time_on_point_in_time_unavailableBoolean

A value that indicates whether to backtrack the DB cluster to the earliest possible backtrack time when BacktrackTo is set to a timestamp earlier than the earliest backtrack time. When this parameter is disabled and BacktrackTo is set to a timestamp earlier than the earliest backtrack time, an error occurs.

Returns:

  • (Boolean)


530
531
532
533
534
535
536
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 530

class BacktrackDBClusterMessage < Struct.new(
  :db_cluster_identifier,
  :backtrack_to,
  :force,
  :use_earliest_time_on_point_in_time_unavailable)
  include Aws::Structure
end