Class: Aws::Redshift::Types::ScheduledAction

Inherits:

Struct

• Object
• Struct
• Aws::Redshift::Types::ScheduledAction

Defined in:

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

Overview

Describes a scheduled action. You can use a scheduled action to trigger some Amazon Redshift API operations on a schedule. For information about which API operations can be scheduled, see ScheduledActionType.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #end_time ⇒ Time

  The end time in UTC when the schedule is no longer active.

• #iam_role ⇒ String

  The IAM role to assume to run the scheduled action.

• #next_invocations ⇒ Array<Time>

  List of times when the scheduled action will run.

• #schedule ⇒ String

  The schedule for a one-time (at format) or recurring (cron format) scheduled action.

• #scheduled_action_description ⇒ String

  The description of the scheduled action.

• #scheduled_action_name ⇒ String

  The name of the scheduled action.

• #start_time ⇒ Time

  The start time in UTC when the schedule is active.

• #state ⇒ String

  The state of the scheduled action.

• #target_action ⇒ Types::ScheduledActionType

  A JSON format string of the Amazon Redshift API operation with input parameters.

Instance Attribute Details

#end_time ⇒ Time

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

Returns:

• (Time)

# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 11347

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

#iam_role ⇒ String

The IAM role to assume to run the scheduled action. This IAM role must have permission to run the Amazon Redshift API operation in the scheduled action. This IAM role must allow the Amazon Redshift scheduler (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 Cluster Management Guide.

Returns:

• (String)

# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 11347

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

#next_invocations ⇒ Array<Time>

List of times when the scheduled action will run.

Returns:

• (Array<Time>)

# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 11347

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

#schedule ⇒ String

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

Format of at expressions is "at(yyyy-mm-ddThh:mm:ss)". For example, "at(2016-03-04T17:27:00)".

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

Returns:

• (String)

# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 11347

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

#scheduled_action_description ⇒ String

The description of the scheduled action.

Returns:

• (String)

# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 11347

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

#scheduled_action_name ⇒ String

The name of the scheduled action.

Returns:

• (String)

# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 11347

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

#start_time ⇒ Time

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

Returns:

• (Time)

# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 11347

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

#state ⇒ String

The state of the scheduled action. For example, DISABLED.

Returns:

• (String)

# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 11347

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

#target_action ⇒ Types::ScheduledActionType

A JSON format string of the Amazon Redshift API operation with input parameters.

"{"ResizeCluster":{"NodeType":"ra3.4xlarge","ClusterIdentifier":"my-test-cluster","NumberOfNodes":3}}".

Returns:

• (Types::ScheduledActionType)

# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 11347

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