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

#cancellableBoolean

Whether or not the scheduled action is cancellable.

Returns:

  • (Boolean)


5462
5463
5464
5465
5466
5467
5468
5469
5470
5471
5472
5473
5474
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/types.rb', line 5462

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

#descriptionString

A description of the action to be taken.

Returns:

  • (String)


5462
5463
5464
5465
5466
5467
5468
5469
5470
5471
5472
5473
5474
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/types.rb', line 5462

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

#idString

The unique identifier of the scheduled action.

Returns:

  • (String)


5462
5463
5464
5465
5466
5467
5468
5469
5470
5471
5472
5473
5474
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/types.rb', line 5462

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

#mandatoryBoolean

Whether the action is required or optional.

Returns:

  • (Boolean)


5462
5463
5464
5465
5466
5467
5468
5469
5470
5471
5472
5473
5474
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/types.rb', line 5462

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

#scheduled_byString

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

Returns:

  • (String)


5462
5463
5464
5465
5466
5467
5468
5469
5470
5471
5472
5473
5474
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/types.rb', line 5462

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

#scheduled_timeInteger

The time when the change is scheduled to happen.

Returns:

  • (Integer)


5462
5463
5464
5465
5466
5467
5468
5469
5470
5471
5472
5473
5474
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/types.rb', line 5462

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

#severityString

The severity of the action.

Returns:

  • (String)


5462
5463
5464
5465
5466
5467
5468
5469
5470
5471
5472
5473
5474
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/types.rb', line 5462

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

#statusString

The current status of the scheduled action.

Returns:

  • (String)


5462
5463
5464
5465
5466
5467
5468
5469
5470
5471
5472
5473
5474
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/types.rb', line 5462

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

#typeString

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

Returns:

  • (String)


5462
5463
5464
5465
5466
5467
5468
5469
5470
5471
5472
5473
5474
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/types.rb', line 5462

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