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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-opensearchservice/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.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#cancellable ⇒ Boolean

Whether or not the scheduled action is cancellable.

Returns:

  • (Boolean)


8608
8609
8610
8611
8612
8613
8614
8615
8616
8617
8618
8619
8620
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/types.rb', line 8608

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)


8608
8609
8610
8611
8612
8613
8614
8615
8616
8617
8618
8619
8620
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/types.rb', line 8608

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)


8608
8609
8610
8611
8612
8613
8614
8615
8616
8617
8618
8619
8620
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/types.rb', line 8608

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)


8608
8609
8610
8611
8612
8613
8614
8615
8616
8617
8618
8619
8620
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/types.rb', line 8608

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)


8608
8609
8610
8611
8612
8613
8614
8615
8616
8617
8618
8619
8620
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/types.rb', line 8608

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)


8608
8609
8610
8611
8612
8613
8614
8615
8616
8617
8618
8619
8620
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/types.rb', line 8608

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)


8608
8609
8610
8611
8612
8613
8614
8615
8616
8617
8618
8619
8620
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/types.rb', line 8608

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)


8608
8609
8610
8611
8612
8613
8614
8615
8616
8617
8618
8619
8620
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/types.rb', line 8608

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)


8608
8609
8610
8611
8612
8613
8614
8615
8616
8617
8618
8619
8620
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/types.rb', line 8608

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