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

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

Overview

Auto-Tune settings when updating a domain. For more information, see [Auto-Tune for Amazon OpenSearch Service].

[1]: docs.aws.amazon.com/opensearch-service/latest/developerguide/auto-tune.html

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#desired_state ⇒ String

Whether Auto-Tune is enabled or disabled.

Returns:

  • (String) 


801
802
803
804
805
806
807
808
 
# File 'lib/aws-sdk-opensearchservice/types.rb', line 801

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

#maintenance_schedules ⇒ Array<Types::AutoTuneMaintenanceSchedule>

DEPRECATED. Use [off-peak window] instead.

A list of maintenance schedules during which Auto-Tune can deploy changes.

[1]: docs.aws.amazon.com/opensearch-service/latest/developerguide/off-peak.html

Returns:



801
802
803
804
805
806
807
808
 
# File 'lib/aws-sdk-opensearchservice/types.rb', line 801

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

#rollback_on_disable ⇒ String

When disabling Auto-Tune, specify ‘NO_ROLLBACK` to retain all prior Auto-Tune settings or `DEFAULT_ROLLBACK` to revert to the OpenSearch Service defaults. If you specify `DEFAULT_ROLLBACK`, you must include a `MaintenanceSchedule` in the request. Otherwise, OpenSearch Service is unable to perform the rollback.

Returns:

  • (String) 


801
802
803
804
805
806
807
808
 
# File 'lib/aws-sdk-opensearchservice/types.rb', line 801

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

#use_off_peak_window ⇒ Boolean

Whether to use the domain’s [off-peak window] to deploy configuration changes on the domain rather than a maintenance schedule.

[1]: docs.aws.amazon.com/opensearch-service/latest/APIReference/API_OffPeakWindow.html

Returns:

  • (Boolean) 


801
802
803
804
805
806
807
808
 
# File 'lib/aws-sdk-opensearchservice/types.rb', line 801

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