Struct aws_sdk_opensearch::types::AutoTuneOptions

#[non_exhaustive]
pub struct AutoTuneOptions {
    pub desired_state: Option<AutoTuneDesiredState>,
    pub rollback_on_disable: Option<RollbackOnDisable>,
    pub maintenance_schedules: Option<Vec<AutoTuneMaintenanceSchedule>>,
    pub use_off_peak_window: Option<bool>,
}

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

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

desired_state: Option<AutoTuneDesiredState>

Whether Auto-Tune is enabled or disabled.

rollback_on_disable: Option<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.

maintenance_schedules: Option<Vec<AutoTuneMaintenanceSchedule>>

DEPRECATED. Use off-peak window instead.

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

use_off_peak_window: Option<bool>

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

Implementations

impl AutoTuneOptions

pub fn desired_state(&self) -> Option<&AutoTuneDesiredState>

Whether Auto-Tune is enabled or disabled.

pub fn rollback_on_disable(&self) -> Option<&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.

pub fn maintenance_schedules(&self) -> &[AutoTuneMaintenanceSchedule]

DEPRECATED. Use off-peak window instead.

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

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .maintenance_schedules.is_none().

pub fn use_off_peak_window(&self) -> Option<bool>

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

impl AutoTuneOptions

pub fn builder() -> AutoTuneOptionsBuilder

Creates a new builder-style object to manufacture AutoTuneOptions.

Trait Implementations

impl Clone for AutoTuneOptions

fn clone(&self) -> AutoTuneOptions

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for AutoTuneOptions

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for AutoTuneOptions

fn eq(&self, other: &AutoTuneOptions) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for AutoTuneOptions