Class: Aws::OpenSearchService::Types::ScheduledAction

Inherits:

Struct

• Object
• Struct
• Aws::OpenSearchService::Types::ScheduledAction

Includes:

Structure

Defined in:

lib/aws-sdk-opensearchservice/types.rb

Overview

Information about a scheduled configuration change for an OpenSearch Service domain. This actions can be a [service software update] or a [blue/green Auto-Tune enhancement].

[1]: docs.aws.amazon.com/opensearch-service/latest/developerguide/service-software.html [2]: docs.aws.amazon.com/opensearch-service/latest/developerguide/auto-tune.html#auto-tune-types

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #cancellable ⇒ Boolean

  Whether or not the scheduled action is cancellable.

• #description ⇒ String

  A description of the action to be taken.

• #id ⇒ String

  The unique identifier of the scheduled action.

• #mandatory ⇒ Boolean

  Whether the action is required or optional.

• #scheduled_by ⇒ String

  Whether the action was scheduled manually (‘CUSTOMER`, or by OpenSearch Service automatically (`SYSTEM`)..

• #scheduled_time ⇒ Integer

  The time when the change is scheduled to happen.

• #severity ⇒ String

  The severity of the action.

• #status ⇒ String

  The current status of the scheduled action.

• #type ⇒ String

  The type of action that will be taken on the domain.

Instance Attribute Details

#cancellable ⇒ Boolean

Whether or not the scheduled action is cancellable.

Returns:

• (Boolean)

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

class ScheduledAction < Struct.new(
  :id,
  :type,
  :severity,
  :scheduled_time,
  :description,
  :scheduled_by,
  :status,
  :mandatory,
  :cancellable)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ String

A description of the action to be taken.

Returns:

• (String)

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

class ScheduledAction < Struct.new(
  :id,
  :type,
  :severity,
  :scheduled_time,
  :description,
  :scheduled_by,
  :status,
  :mandatory,
  :cancellable)
  SENSITIVE = []
  include Aws::Structure
end

#id ⇒ String

The unique identifier of the scheduled action.

Returns:

• (String)

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

class ScheduledAction < Struct.new(
  :id,
  :type,
  :severity,
  :scheduled_time,
  :description,
  :scheduled_by,
  :status,
  :mandatory,
  :cancellable)
  SENSITIVE = []
  include Aws::Structure
end

#mandatory ⇒ Boolean

Whether the action is required or optional.

Returns:

• (Boolean)

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

class ScheduledAction < Struct.new(
  :id,
  :type,
  :severity,
  :scheduled_time,
  :description,
  :scheduled_by,
  :status,
  :mandatory,
  :cancellable)
  SENSITIVE = []
  include Aws::Structure
end

#scheduled_by ⇒ String

Whether the action was scheduled manually (‘CUSTOMER`, or by OpenSearch Service automatically (`SYSTEM`).

Returns:

• (String)

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

class ScheduledAction < Struct.new(
  :id,
  :type,
  :severity,
  :scheduled_time,
  :description,
  :scheduled_by,
  :status,
  :mandatory,
  :cancellable)
  SENSITIVE = []
  include Aws::Structure
end

#scheduled_time ⇒ Integer

The time when the change is scheduled to happen.

Returns:

• (Integer)

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

class ScheduledAction < Struct.new(
  :id,
  :type,
  :severity,
  :scheduled_time,
  :description,
  :scheduled_by,
  :status,
  :mandatory,
  :cancellable)
  SENSITIVE = []
  include Aws::Structure
end

#severity ⇒ String

The severity of the action.

Returns:

• (String)

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

class ScheduledAction < Struct.new(
  :id,
  :type,
  :severity,
  :scheduled_time,
  :description,
  :scheduled_by,
  :status,
  :mandatory,
  :cancellable)
  SENSITIVE = []
  include Aws::Structure
end

#status ⇒ String

The current status of the scheduled action.

Returns:

• (String)

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

class ScheduledAction < Struct.new(
  :id,
  :type,
  :severity,
  :scheduled_time,
  :description,
  :scheduled_by,
  :status,
  :mandatory,
  :cancellable)
  SENSITIVE = []
  include Aws::Structure
end

#type ⇒ String

The type of action that will be taken on the domain.

Returns:

• (String)

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

class ScheduledAction < Struct.new(
  :id,
  :type,
  :severity,
  :scheduled_time,
  :description,
  :scheduled_by,
  :status,
  :mandatory,
  :cancellable)
  SENSITIVE = []
  include Aws::Structure
end