AutoTuneOptions - Amazon OpenSearch Service

AutoTuneOptions

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

Contents

DesiredState

Whether Auto-Tune is enabled or disabled.

Type: String

Valid Values: ENABLED | DISABLED

Required: No

MaintenanceSchedules

DEPRECATED. Use off-peak window instead.

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

Type: Array of AutoTuneMaintenanceSchedule objects

Array Members: Maximum number of 100 items.

Required: No

RollbackOnDisable

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.

Type: String

Valid Values: NO_ROLLBACK | DEFAULT_ROLLBACK

Required: No

UseOffPeakWindow

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

Type: Boolean

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: