Class: Aws::RedshiftServerless::Types::ScheduledActionResponse

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-redshiftserverless/lib/aws-sdk-redshiftserverless/types.rb

Overview

The returned scheduled action object.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#end_timeTime

The end time of

Returns:

  • (Time)


2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
# File 'gems/aws-sdk-redshiftserverless/lib/aws-sdk-redshiftserverless/types.rb', line 2631

class ScheduledActionResponse < Struct.new(
  :end_time,
  :namespace_name,
  :next_invocations,
  :role_arn,
  :schedule,
  :scheduled_action_description,
  :scheduled_action_name,
  :scheduled_action_uuid,
  :start_time,
  :state,
  :target_action)
  SENSITIVE = []
  include Aws::Structure
end

#namespace_nameString

The end time in UTC when the schedule is no longer active. After this time, the scheduled action does not trigger.

Returns:

  • (String)


2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
# File 'gems/aws-sdk-redshiftserverless/lib/aws-sdk-redshiftserverless/types.rb', line 2631

class ScheduledActionResponse < Struct.new(
  :end_time,
  :namespace_name,
  :next_invocations,
  :role_arn,
  :schedule,
  :scheduled_action_description,
  :scheduled_action_name,
  :scheduled_action_uuid,
  :start_time,
  :state,
  :target_action)
  SENSITIVE = []
  include Aws::Structure
end

#next_invocationsArray<Time>

An array of timestamps of when the next scheduled actions will trigger.

Returns:

  • (Array<Time>)


2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
# File 'gems/aws-sdk-redshiftserverless/lib/aws-sdk-redshiftserverless/types.rb', line 2631

class ScheduledActionResponse < Struct.new(
  :end_time,
  :namespace_name,
  :next_invocations,
  :role_arn,
  :schedule,
  :scheduled_action_description,
  :scheduled_action_name,
  :scheduled_action_uuid,
  :start_time,
  :state,
  :target_action)
  SENSITIVE = []
  include Aws::Structure
end

#role_arnString

The ARN of the IAM role to assume to run the scheduled action. This IAM role must have permission to run the Amazon Redshift Serverless API operation in the scheduled action. This IAM role must allow the Amazon Redshift scheduler to schedule creating snapshots. (Principal scheduler.redshift.amazonaws.com) to assume permissions on your behalf. For more information about the IAM role to use with the Amazon Redshift scheduler, see Using Identity-Based Policies for Amazon Redshift in the Amazon Redshift Management Guide

Returns:

  • (String)


2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
# File 'gems/aws-sdk-redshiftserverless/lib/aws-sdk-redshiftserverless/types.rb', line 2631

class ScheduledActionResponse < Struct.new(
  :end_time,
  :namespace_name,
  :next_invocations,
  :role_arn,
  :schedule,
  :scheduled_action_description,
  :scheduled_action_name,
  :scheduled_action_uuid,
  :start_time,
  :state,
  :target_action)
  SENSITIVE = []
  include Aws::Structure
end

#scheduleTypes::Schedule

The schedule for a one-time (at timestamp format) or recurring (cron format) scheduled action. Schedule invocations must be separated by at least one hour. Times are in UTC.

  • Format of at timestamp is yyyy-mm-ddThh:mm:ss. For example, 2016-03-04T17:27:00.

  • Format of cron expression is (Minutes Hours Day-of-month Month Day-of-week Year). For example, "(0 10 ? * MON *)". For more information, see Cron Expressions in the Amazon CloudWatch Events User Guide.

Returns:



2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
# File 'gems/aws-sdk-redshiftserverless/lib/aws-sdk-redshiftserverless/types.rb', line 2631

class ScheduledActionResponse < Struct.new(
  :end_time,
  :namespace_name,
  :next_invocations,
  :role_arn,
  :schedule,
  :scheduled_action_description,
  :scheduled_action_name,
  :scheduled_action_uuid,
  :start_time,
  :state,
  :target_action)
  SENSITIVE = []
  include Aws::Structure
end

#scheduled_action_descriptionString

The description of the scheduled action.

Returns:

  • (String)


2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
# File 'gems/aws-sdk-redshiftserverless/lib/aws-sdk-redshiftserverless/types.rb', line 2631

class ScheduledActionResponse < Struct.new(
  :end_time,
  :namespace_name,
  :next_invocations,
  :role_arn,
  :schedule,
  :scheduled_action_description,
  :scheduled_action_name,
  :scheduled_action_uuid,
  :start_time,
  :state,
  :target_action)
  SENSITIVE = []
  include Aws::Structure
end

#scheduled_action_nameString

The name of the scheduled action.

Returns:

  • (String)


2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
# File 'gems/aws-sdk-redshiftserverless/lib/aws-sdk-redshiftserverless/types.rb', line 2631

class ScheduledActionResponse < Struct.new(
  :end_time,
  :namespace_name,
  :next_invocations,
  :role_arn,
  :schedule,
  :scheduled_action_description,
  :scheduled_action_name,
  :scheduled_action_uuid,
  :start_time,
  :state,
  :target_action)
  SENSITIVE = []
  include Aws::Structure
end

#scheduled_action_uuidString

The uuid of the scheduled action.

Returns:

  • (String)


2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
# File 'gems/aws-sdk-redshiftserverless/lib/aws-sdk-redshiftserverless/types.rb', line 2631

class ScheduledActionResponse < Struct.new(
  :end_time,
  :namespace_name,
  :next_invocations,
  :role_arn,
  :schedule,
  :scheduled_action_description,
  :scheduled_action_name,
  :scheduled_action_uuid,
  :start_time,
  :state,
  :target_action)
  SENSITIVE = []
  include Aws::Structure
end

#start_timeTime

The start time in UTC when the schedule is active. Before this time, the scheduled action does not trigger.

Returns:

  • (Time)


2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
# File 'gems/aws-sdk-redshiftserverless/lib/aws-sdk-redshiftserverless/types.rb', line 2631

class ScheduledActionResponse < Struct.new(
  :end_time,
  :namespace_name,
  :next_invocations,
  :role_arn,
  :schedule,
  :scheduled_action_description,
  :scheduled_action_name,
  :scheduled_action_uuid,
  :start_time,
  :state,
  :target_action)
  SENSITIVE = []
  include Aws::Structure
end

#stateString

The state of the scheduled action.

Returns:

  • (String)


2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
# File 'gems/aws-sdk-redshiftserverless/lib/aws-sdk-redshiftserverless/types.rb', line 2631

class ScheduledActionResponse < Struct.new(
  :end_time,
  :namespace_name,
  :next_invocations,
  :role_arn,
  :schedule,
  :scheduled_action_description,
  :scheduled_action_name,
  :scheduled_action_uuid,
  :start_time,
  :state,
  :target_action)
  SENSITIVE = []
  include Aws::Structure
end

#target_actionTypes::TargetAction

A JSON format string of the Amazon Redshift Serverless API operation with input parameters. The following is an example of a target action.

"\{"CreateSnapshot": \{"NamespaceName": "sampleNamespace","SnapshotName": "sampleSnapshot", "retentionPeriod": "1"\}\}"

Returns:



2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
# File 'gems/aws-sdk-redshiftserverless/lib/aws-sdk-redshiftserverless/types.rb', line 2631

class ScheduledActionResponse < Struct.new(
  :end_time,
  :namespace_name,
  :next_invocations,
  :role_arn,
  :schedule,
  :scheduled_action_description,
  :scheduled_action_name,
  :scheduled_action_uuid,
  :start_time,
  :state,
  :target_action)
  SENSITIVE = []
  include Aws::Structure
end