You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

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

Inherits:
Struct
  • Object
show all
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.

Instance Attribute Summary collapse

Instance Attribute Details

#end_timeTime

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

Returns:

  • (Time)


8012
8013
8014
8015
8016
8017
8018
8019
8020
8021
8022
8023
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 8012

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

#iam_roleString

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)


8012
8013
8014
8015
8016
8017
8018
8019
8020
8021
8022
8023
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 8012

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

#next_invocationsArray<Time>

List of times when the scheduled action will run.

Returns:

  • (Array<Time>)


8012
8013
8014
8015
8016
8017
8018
8019
8020
8021
8022
8023
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 8012

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

#scheduleString

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)


8012
8013
8014
8015
8016
8017
8018
8019
8020
8021
8022
8023
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 8012

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

#scheduled_action_descriptionString

The description of the scheduled action.

Returns:

  • (String)


8012
8013
8014
8015
8016
8017
8018
8019
8020
8021
8022
8023
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 8012

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

#scheduled_action_nameString

The name of the scheduled action.

Returns:

  • (String)


8012
8013
8014
8015
8016
8017
8018
8019
8020
8021
8022
8023
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 8012

class ScheduledAction < Struct.new(
  :scheduled_action_name,
  :target_action,
  :schedule,
  :iam_role,
  :scheduled_action_description,
  :state,
  :next_invocations,
  :start_time,
  :end_time)
  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)


8012
8013
8014
8015
8016
8017
8018
8019
8020
8021
8022
8023
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 8012

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

#stateString

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

Returns:

  • (String)


8012
8013
8014
8015
8016
8017
8018
8019
8020
8021
8022
8023
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 8012

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

#target_actionTypes::ScheduledActionType

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

"\{"ResizeCluster":\{"NodeType":"ds2.8xlarge","ClusterIdentifier":"my-test-cluster","NumberOfNodes":3\}\}".



8012
8013
8014
8015
8016
8017
8018
8019
8020
8021
8022
8023
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 8012

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