Class: Aws::OpenSearchService::Types::AutoTuneOptions

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/types.rb

Overview

Note:

When making an API call, you may pass AutoTuneOptions data as a hash:

{
  desired_state: "ENABLED", # accepts ENABLED, DISABLED
  rollback_on_disable: "NO_ROLLBACK", # accepts NO_ROLLBACK, DEFAULT_ROLLBACK
  maintenance_schedules: [
    {
      start_at: Time.now,
      duration: {
        value: 1,
        unit: "HOURS", # accepts HOURS
      },
      cron_expression_for_recurrence: "String",
    },
  ],
}

The Auto-Tune options: the Auto-Tune desired state for the domain, rollback state when disabling Auto-Tune options and list of maintenance schedules.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#desired_stateString

The Auto-Tune desired state. Valid values are ENABLED and DISABLED.

Returns:

  • (String)


495
496
497
498
499
500
501
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/types.rb', line 495

class AutoTuneOptions < Struct.new(
  :desired_state,
  :rollback_on_disable,
  :maintenance_schedules)
  SENSITIVE = []
  include Aws::Structure
end

#maintenance_schedulesArray<Types::AutoTuneMaintenanceSchedule>

A list of maintenance schedules. See Auto-Tune for Amazon OpenSearch Service for more information.



495
496
497
498
499
500
501
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/types.rb', line 495

class AutoTuneOptions < Struct.new(
  :desired_state,
  :rollback_on_disable,
  :maintenance_schedules)
  SENSITIVE = []
  include Aws::Structure
end

#rollback_on_disableString

The rollback state while disabling Auto-Tune for the domain. Valid values are NO_ROLLBACK and DEFAULT_ROLLBACK.

Returns:

  • (String)


495
496
497
498
499
500
501
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/types.rb', line 495

class AutoTuneOptions < Struct.new(
  :desired_state,
  :rollback_on_disable,
  :maintenance_schedules)
  SENSITIVE = []
  include Aws::Structure
end