Skip to content

AutoTuneOptionsInput

Used by
Source code in docs_src/capo_opensearch/types/auto_tune_options_input.py 
13
14
15
16
17
18
19
20
21
22
23
class AutoTuneOptionsInput(TypedDict, closed=True):
    desired_state: NotRequired[
        "capo_opensearch.types.auto_tune_desired_state.AutoTuneDesiredState"
    ]
    """<p>Whether Auto-Tune is enabled or disabled.</p>"""
    maintenance_schedules: NotRequired[
        "capo_opensearch.types.auto_tune_maintenance_schedule_list.AutoTuneMaintenanceScheduleList"
    ]
    """<p>A list of maintenance schedules during which Auto-Tune can deploy changes. Maintenance windows are deprecated and have been replaced with <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/off-peak.html">off-peak windows</a>.</p>"""
    use_off_peak_window: NotRequired["capo_opensearch.types.boolean.Boolean"]
    """<p>Whether to schedule Auto-Tune optimizations that require blue/green deployments during the domain's configured daily off-peak window.</p>"""

desired_state instance-attribute 

desired_state: NotRequired[AutoTuneDesiredState]

Whether Auto-Tune is enabled or disabled.

maintenance_schedules instance-attribute 

maintenance_schedules: NotRequired[AutoTuneMaintenanceScheduleList]

A list of maintenance schedules during which Auto-Tune can deploy changes. Maintenance windows are deprecated and have been replaced with off-peak windows.

use_off_peak_window instance-attribute 

use_off_peak_window: NotRequired[Boolean]

Whether to schedule Auto-Tune optimizations that require blue/green deployments during the domain's configured daily off-peak window.