Class: Aws::OpenSearchService::Types::UpdateScheduledActionRequest

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-opensearchservice/types.rb

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#action_id ⇒ String

The unique identifier of the action to reschedule. To retrieve this ID, send a [ListScheduledActions] request.

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

Returns:

  • (String) 


7664
7665
7666
7667
7668
7669
7670
7671
7672
 
# File 'lib/aws-sdk-opensearchservice/types.rb', line 7664

class UpdateScheduledActionRequest < Struct.new(
  :domain_name,
  :action_id,
  :action_type,
  :schedule_at,
  :desired_start_time)
  SENSITIVE = []
  include Aws::Structure
end

#action_type ⇒ String

The type of action to reschedule. Can be one of ‘SERVICE_SOFTWARE_UPDATE`, `JVM_HEAP_SIZE_TUNING`, or `JVM_YOUNG_GEN_TUNING`. To retrieve this value, send a

ListScheduledActions][1

request.

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

Returns:

  • (String) 


7664
7665
7666
7667
7668
7669
7670
7671
7672
 
# File 'lib/aws-sdk-opensearchservice/types.rb', line 7664

class UpdateScheduledActionRequest < Struct.new(
  :domain_name,
  :action_id,
  :action_type,
  :schedule_at,
  :desired_start_time)
  SENSITIVE = []
  include Aws::Structure
end

#desired_start_time ⇒ Integer

The time to implement the change, in Coordinated Universal Time (UTC). Only specify this parameter if you set ‘ScheduleAt` to `TIMESTAMP`.

Returns:

  • (Integer) 


7664
7665
7666
7667
7668
7669
7670
7671
7672
 
# File 'lib/aws-sdk-opensearchservice/types.rb', line 7664

class UpdateScheduledActionRequest < Struct.new(
  :domain_name,
  :action_id,
  :action_type,
  :schedule_at,
  :desired_start_time)
  SENSITIVE = []
  include Aws::Structure
end

#domain_name ⇒ String

The name of the domain to reschedule an action for.

Returns:

  • (String) 


7664
7665
7666
7667
7668
7669
7670
7671
7672
 
# File 'lib/aws-sdk-opensearchservice/types.rb', line 7664

class UpdateScheduledActionRequest < Struct.new(
  :domain_name,
  :action_id,
  :action_type,
  :schedule_at,
  :desired_start_time)
  SENSITIVE = []
  include Aws::Structure
end

#schedule_at ⇒ String

When to schedule the action.

  • ‘NOW` - Immediately schedules the update to happen in the current hour if there’s capacity available.

  • ‘TIMESTAMP` - Lets you specify a custom date and time to apply the update. If you specify this value, you must also provide a value for `DesiredStartTime`.

  • ‘OFF_PEAK_WINDOW` - Marks the action to be picked up during an upcoming off-peak window. There’s no guarantee that the change will be implemented during the next immediate window. Depending on capacity, it might happen in subsequent days.

Returns:

  • (String) 


7664
7665
7666
7667
7668
7669
7670
7671
7672
 
# File 'lib/aws-sdk-opensearchservice/types.rb', line 7664

class UpdateScheduledActionRequest < Struct.new(
  :domain_name,
  :action_id,
  :action_type,
  :schedule_at,
  :desired_start_time)
  SENSITIVE = []
  include Aws::Structure
end