Class: Aws::OpenSearchService::Types::OffPeakWindowOptions

Inherits:

Struct

• Object
• Struct
• Aws::OpenSearchService::Types::OffPeakWindowOptions

Includes:

Structure

Defined in:

lib/aws-sdk-opensearchservice/types.rb

Overview

Options for a domain’s [off-peak window], during which OpenSearch Service can perform mandatory configuration changes on the domain.

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

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #enabled ⇒ Boolean

  Whether to enable an off-peak window.

• #off_peak_window ⇒ Types::OffPeakWindow

  Off-peak window settings for the domain.

Instance Attribute Details

#enabled ⇒ Boolean

Whether to enable an off-peak window.

This option is only available when modifying a domain created prior to February 16, 2023, not when creating a new domain. All domains created after this date have the off-peak window enabled by default. You can’t disable the off-peak window after it’s enabled for a domain.

Returns:

• (Boolean)

# File 'lib/aws-sdk-opensearchservice/types.rb', line 5852

class OffPeakWindowOptions < Struct.new(
  :enabled,
  :off_peak_window)
  SENSITIVE = []
  include Aws::Structure
end

#off_peak_window ⇒ Types::OffPeakWindow

Off-peak window settings for the domain.

Returns:

• (Types::OffPeakWindow)

# File 'lib/aws-sdk-opensearchservice/types.rb', line 5852

class OffPeakWindowOptions < Struct.new(
  :enabled,
  :off_peak_window)
  SENSITIVE = []
  include Aws::Structure
end