Skip to content

AutoTuneOptions

Used by
Source code in docs_src/capo_opensearch/types/auto_tune_options.py 
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
class AutoTuneOptions(TypedDict, closed=True):
    desired_state: NotRequired[
        "capo_opensearch.types.auto_tune_desired_state.AutoTuneDesiredState"
    ]
    """<p>Whether Auto-Tune is enabled or disabled.</p>"""
    rollback_on_disable: NotRequired[
        "capo_opensearch.types.rollback_on_disable.RollbackOnDisable"
    ]
    """<p>When disabling Auto-Tune, specify <code>NO_ROLLBACK</code> to retain all prior Auto-Tune settings or <code>DEFAULT_ROLLBACK</code> to revert to the OpenSearch Service defaults. If you specify <code>DEFAULT_ROLLBACK</code>, you must include a <code>MaintenanceSchedule</code> in the request. Otherwise, OpenSearch Service is unable to perform the rollback.</p>"""
    maintenance_schedules: NotRequired[
        "capo_opensearch.types.auto_tune_maintenance_schedule_list.AutoTuneMaintenanceScheduleList"
    ]
    """<p>DEPRECATED. Use <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/off-peak.html">off-peak window</a> instead.</p> <p>A list of maintenance schedules during which Auto-Tune can deploy changes.</p>"""
    use_off_peak_window: NotRequired["capo_opensearch.types.boolean.Boolean"]
    """<p>Whether to use the domain's <a href="https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_OffPeakWindow.html">off-peak window</a> to deploy configuration changes on the domain rather than a maintenance schedule.</p>"""

desired_state instance-attribute 

desired_state: NotRequired[AutoTuneDesiredState]

Whether Auto-Tune is enabled or disabled.

maintenance_schedules instance-attribute 

maintenance_schedules: NotRequired[AutoTuneMaintenanceScheduleList]

DEPRECATED. Use off-peak window instead.

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

rollback_on_disable instance-attribute 

rollback_on_disable: NotRequired[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.

use_off_peak_window instance-attribute 

use_off_peak_window: NotRequired[Boolean]

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