Class: Aws::Scheduler::Types::GetScheduleOutput

Inherits:

Struct

• Object
• Struct
• Aws::Scheduler::Types::GetScheduleOutput

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

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

• #arn ⇒ String

  The Amazon Resource Name (ARN) of the schedule.

• #creation_date ⇒ Time

  The time at which the schedule was created.

• #description ⇒ String

  The description of 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 associated with this schedule.

• #kms_key_arn ⇒ String

  The ARN for a customer managed KMS Key that is be used to encrypt and decrypt your data.

• #last_modification_date ⇒ Time

  The time at which the schedule was last modified.

• #name ⇒ String

  The name of the schedule.

• #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 target.

Instance Attribute Details

#action_after_completion ⇒ String

Indicates 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 668

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

#arn ⇒ String

The Amazon Resource Name (ARN) of the schedule.

Returns:

• (String)

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

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

#creation_date ⇒ Time

The time at which the schedule was created.

Returns:

• (Time)

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

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

#description ⇒ String

The description of the schedule.

Returns:

• (String)

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

class GetScheduleOutput < Struct.new(
  :action_after_completion,
  :arn,
  :creation_date,
  :description,
  :end_date,
  :flexible_time_window,
  :group_name,
  :kms_key_arn,
  :last_modification_date,
  :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 668

class GetScheduleOutput < Struct.new(
  :action_after_completion,
  :arn,
  :creation_date,
  :description,
  :end_date,
  :flexible_time_window,
  :group_name,
  :kms_key_arn,
  :last_modification_date,
  :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 668

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

#group_name ⇒ String

The name of the schedule group associated with this schedule.

Returns:

• (String)

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

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

#kms_key_arn ⇒ String

The ARN for a customer managed KMS Key that is be used to encrypt and decrypt your data.

Returns:

• (String)

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

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

#last_modification_date ⇒ Time

The time at which the schedule was last modified.

Returns:

• (Time)

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

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

#name ⇒ String

The name of the schedule.

Returns:

• (String)

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

class GetScheduleOutput < Struct.new(
  :action_after_completion,
  :arn,
  :creation_date,
  :description,
  :end_date,
  :flexible_time_window,
  :group_name,
  :kms_key_arn,
  :last_modification_date,
  :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 668

class GetScheduleOutput < Struct.new(
  :action_after_completion,
  :arn,
  :creation_date,
  :description,
  :end_date,
  :flexible_time_window,
  :group_name,
  :kms_key_arn,
  :last_modification_date,
  :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 668

class GetScheduleOutput < Struct.new(
  :action_after_completion,
  :arn,
  :creation_date,
  :description,
  :end_date,
  :flexible_time_window,
  :group_name,
  :kms_key_arn,
  :last_modification_date,
  :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 668

class GetScheduleOutput < Struct.new(
  :action_after_completion,
  :arn,
  :creation_date,
  :description,
  :end_date,
  :flexible_time_window,
  :group_name,
  :kms_key_arn,
  :last_modification_date,
  :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 668

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

#target ⇒ Types::Target

The schedule target.

Returns:

• (Types::Target)

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

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