Class: Aws::Scheduler::Types::CreateScheduleInput

Inherits:

Struct

• Object
• Struct
• Aws::Scheduler::Types::CreateScheduleInput

Defined in:

gems/aws-sdk-scheduler/lib/aws-sdk-scheduler/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #action_after_completion ⇒ String

  Specifies the action that EventBridge Scheduler applies to the schedule after the schedule completes invoking the target.

• #client_token ⇒ String

  Unique, case-sensitive identifier you provide to ensure the idempotency of the request.

• #description ⇒ String

  The description you specify for the schedule.

• #end_date ⇒ Time

  The date, in UTC, before which the schedule can invoke its target.

• #flexible_time_window ⇒ Types::FlexibleTimeWindow

  Allows you to configure a time window during which EventBridge Scheduler invokes the schedule.

• #group_name ⇒ String

  The name of the schedule group to associate with this schedule.

• #kms_key_arn ⇒ String

  The Amazon Resource Name (ARN) for the customer managed KMS key that EventBridge Scheduler will use to encrypt and decrypt your data.

• #name ⇒ String

  The name of the schedule that you are creating.

• #schedule_expression ⇒ String

  The expression that defines when the schedule runs.

• #schedule_expression_timezone ⇒ String

  The timezone in which the scheduling expression is evaluated.

• #start_date ⇒ Time

  The date, in UTC, after which the schedule can begin invoking its target.

• #state ⇒ String

  Specifies whether the schedule is enabled or disabled.

• #target ⇒ Types::Target

  The schedule's target.

Instance Attribute Details

#action_after_completion ⇒ String

Specifies the action that EventBridge Scheduler applies to the schedule after the schedule completes invoking the target.

Returns:

• (String)

# File 'gems/aws-sdk-scheduler/lib/aws-sdk-scheduler/types.rb', line 228

class CreateScheduleInput < Struct.new(
  :action_after_completion,
  :client_token,
  :description,
  :end_date,
  :flexible_time_window,
  :group_name,
  :kms_key_arn,
  :name,
  :schedule_expression,
  :schedule_expression_timezone,
  :start_date,
  :state,
  :target)
  SENSITIVE = []
  include Aws::Structure
end

#client_token ⇒ String

Unique, case-sensitive identifier you provide to ensure the idempotency of the request. If you do not specify a client token, EventBridge Scheduler uses a randomly generated token for the request to ensure idempotency.

A suitable default value is auto-generated. You should normally not need to pass this option.

Returns:

• (String)

# File 'gems/aws-sdk-scheduler/lib/aws-sdk-scheduler/types.rb', line 228

class CreateScheduleInput < Struct.new(
  :action_after_completion,
  :client_token,
  :description,
  :end_date,
  :flexible_time_window,
  :group_name,
  :kms_key_arn,
  :name,
  :schedule_expression,
  :schedule_expression_timezone,
  :start_date,
  :state,
  :target)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ String

The description you specify for the schedule.

Returns:

• (String)

# File 'gems/aws-sdk-scheduler/lib/aws-sdk-scheduler/types.rb', line 228

class CreateScheduleInput < Struct.new(
  :action_after_completion,
  :client_token,
  :description,
  :end_date,
  :flexible_time_window,
  :group_name,
  :kms_key_arn,
  :name,
  :schedule_expression,
  :schedule_expression_timezone,
  :start_date,
  :state,
  :target)
  SENSITIVE = []
  include Aws::Structure
end

#end_date ⇒ Time

The date, in UTC, before which the schedule can invoke its target. Depending on the schedule's recurrence expression, invocations might stop on, or before, the EndDate you specify. EventBridge Scheduler ignores EndDate for one-time schedules.

Returns:

• (Time)

# File 'gems/aws-sdk-scheduler/lib/aws-sdk-scheduler/types.rb', line 228

class CreateScheduleInput < Struct.new(
  :action_after_completion,
  :client_token,
  :description,
  :end_date,
  :flexible_time_window,
  :group_name,
  :kms_key_arn,
  :name,
  :schedule_expression,
  :schedule_expression_timezone,
  :start_date,
  :state,
  :target)
  SENSITIVE = []
  include Aws::Structure
end

#flexible_time_window ⇒ Types::FlexibleTimeWindow

Allows you to configure a time window during which EventBridge Scheduler invokes the schedule.

Returns:

• (Types::FlexibleTimeWindow)

# File 'gems/aws-sdk-scheduler/lib/aws-sdk-scheduler/types.rb', line 228

class CreateScheduleInput < Struct.new(
  :action_after_completion,
  :client_token,
  :description,
  :end_date,
  :flexible_time_window,
  :group_name,
  :kms_key_arn,
  :name,
  :schedule_expression,
  :schedule_expression_timezone,
  :start_date,
  :state,
  :target)
  SENSITIVE = []
  include Aws::Structure
end

#group_name ⇒ String

The name of the schedule group to associate with this schedule. If you omit this, the default schedule group is used.

Returns:

• (String)

# File 'gems/aws-sdk-scheduler/lib/aws-sdk-scheduler/types.rb', line 228

class CreateScheduleInput < Struct.new(
  :action_after_completion,
  :client_token,
  :description,
  :end_date,
  :flexible_time_window,
  :group_name,
  :kms_key_arn,
  :name,
  :schedule_expression,
  :schedule_expression_timezone,
  :start_date,
  :state,
  :target)
  SENSITIVE = []
  include Aws::Structure
end

#kms_key_arn ⇒ String

The Amazon Resource Name (ARN) for the customer managed KMS key that EventBridge Scheduler will use to encrypt and decrypt your data.

Returns:

• (String)

# File 'gems/aws-sdk-scheduler/lib/aws-sdk-scheduler/types.rb', line 228

class CreateScheduleInput < Struct.new(
  :action_after_completion,
  :client_token,
  :description,
  :end_date,
  :flexible_time_window,
  :group_name,
  :kms_key_arn,
  :name,
  :schedule_expression,
  :schedule_expression_timezone,
  :start_date,
  :state,
  :target)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

The name of the schedule that you are creating.

Returns:

• (String)

# File 'gems/aws-sdk-scheduler/lib/aws-sdk-scheduler/types.rb', line 228

class CreateScheduleInput < Struct.new(
  :action_after_completion,
  :client_token,
  :description,
  :end_date,
  :flexible_time_window,
  :group_name,
  :kms_key_arn,
  :name,
  :schedule_expression,
  :schedule_expression_timezone,
  :start_date,
  :state,
  :target)
  SENSITIVE = []
  include Aws::Structure
end

#schedule_expression ⇒ String

The expression that defines when the schedule runs. The following formats are supported.

• at expression - at(yyyy-mm-ddThh:mm:ss)

• rate expression - rate(value unit)

• cron expression - cron(fields)

You can use at expressions to create one-time schedules that invoke a target once, at the time and in the time zone, that you specify. You can use rate and cron expressions to create recurring schedules. Rate-based schedules are useful when you want to invoke a target at regular intervals, such as every 15 minutes or every five days. Cron-based schedules are useful when you want to invoke a target periodically at a specific time, such as at 8:00 am (UTC+0) every 1st day of the month.

A cron expression consists of six fields separated by white spaces: (minutes hours day_of_month month day_of_week year).

A rate expression consists of a value as a positive integer, and a unit with the following options: minute | minutes | hour | hours | day | days

For more information and examples, see Schedule types on EventBridge Scheduler in the EventBridge Scheduler User Guide.

Returns:

• (String)

# File 'gems/aws-sdk-scheduler/lib/aws-sdk-scheduler/types.rb', line 228

class CreateScheduleInput < Struct.new(
  :action_after_completion,
  :client_token,
  :description,
  :end_date,
  :flexible_time_window,
  :group_name,
  :kms_key_arn,
  :name,
  :schedule_expression,
  :schedule_expression_timezone,
  :start_date,
  :state,
  :target)
  SENSITIVE = []
  include Aws::Structure
end

#schedule_expression_timezone ⇒ String

The timezone in which the scheduling expression is evaluated.

Returns:

• (String)

# File 'gems/aws-sdk-scheduler/lib/aws-sdk-scheduler/types.rb', line 228

class CreateScheduleInput < Struct.new(
  :action_after_completion,
  :client_token,
  :description,
  :end_date,
  :flexible_time_window,
  :group_name,
  :kms_key_arn,
  :name,
  :schedule_expression,
  :schedule_expression_timezone,
  :start_date,
  :state,
  :target)
  SENSITIVE = []
  include Aws::Structure
end

#start_date ⇒ Time

The date, in UTC, after which the schedule can begin invoking its target. Depending on the schedule's recurrence expression, invocations might occur on, or after, the StartDate you specify. EventBridge Scheduler ignores StartDate for one-time schedules.

Returns:

• (Time)

# File 'gems/aws-sdk-scheduler/lib/aws-sdk-scheduler/types.rb', line 228

class CreateScheduleInput < Struct.new(
  :action_after_completion,
  :client_token,
  :description,
  :end_date,
  :flexible_time_window,
  :group_name,
  :kms_key_arn,
  :name,
  :schedule_expression,
  :schedule_expression_timezone,
  :start_date,
  :state,
  :target)
  SENSITIVE = []
  include Aws::Structure
end

#state ⇒ String

Specifies whether the schedule is enabled or disabled.

Returns:

• (String)

# File 'gems/aws-sdk-scheduler/lib/aws-sdk-scheduler/types.rb', line 228

class CreateScheduleInput < Struct.new(
  :action_after_completion,
  :client_token,
  :description,
  :end_date,
  :flexible_time_window,
  :group_name,
  :kms_key_arn,
  :name,
  :schedule_expression,
  :schedule_expression_timezone,
  :start_date,
  :state,
  :target)
  SENSITIVE = []
  include Aws::Structure
end

#target ⇒ Types::Target

The schedule's target.

Returns:

• (Types::Target)

# File 'gems/aws-sdk-scheduler/lib/aws-sdk-scheduler/types.rb', line 228

class CreateScheduleInput < Struct.new(
  :action_after_completion,
  :client_token,
  :description,
  :end_date,
  :flexible_time_window,
  :group_name,
  :kms_key_arn,
  :name,
  :schedule_expression,
  :schedule_expression_timezone,
  :start_date,
  :state,
  :target)
  SENSITIVE = []
  include Aws::Structure
end