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

Class: Aws::Redshift::Types::CreateScheduledActionMessage

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing CreateScheduledActionMessage as input to an Aws::Client method, you can use a vanilla Hash:

{
  scheduled_action_name: "String", # required
  target_action: { # required
    resize_cluster: {
      cluster_identifier: "String", # required
      cluster_type: "String",
      node_type: "String",
      number_of_nodes: 1,
      classic: false,
    },
    pause_cluster: {
      cluster_identifier: "String", # required
    },
    resume_cluster: {
      cluster_identifier: "String", # required
    },
  },
  schedule: "String", # required
  iam_role: "String", # required
  scheduled_action_description: "String",
  start_time: Time.now,
  end_time: Time.now,
  enable: false,
}

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#enable ⇒ Boolean

If true, the schedule is enabled. If false, the scheduled action does not trigger. For more information about state of the scheduled action, see ScheduledAction.

Returns:

  • (Boolean) —

    If true, the schedule is enabled.

#end_time ⇒ Time

The end time in UTC of the scheduled action. After this time, the scheduled action does not trigger. For more information about this parameter, see ScheduledAction.

Returns:

  • (Time) —

    The end time in UTC of the scheduled action.

#iam_role ⇒ String

The IAM role to assume to run the target action. For more information about this parameter, see ScheduledAction.

Returns:

  • (String) —

    The IAM role to assume to run the target action.

#schedule ⇒ String

The schedule in at( ) or cron( ) format. For more information about this parameter, see ScheduledAction.

Returns:

  • (String) —

    The schedule in at( ) or cron( ) format.

#scheduled_action_description ⇒ String

The description of the scheduled action.

Returns:

  • (String) —

    The description of the scheduled action.

#scheduled_action_name ⇒ String

The name of the scheduled action. The name must be unique within an account. For more information about this parameter, see ScheduledAction.

Returns:

  • (String) —

    The name of the scheduled action.

#start_time ⇒ Time

The start time in UTC of the scheduled action. Before this time, the scheduled action does not trigger. For more information about this parameter, see ScheduledAction.

Returns:

  • (Time) —

    The start time in UTC of the scheduled action.

#target_action ⇒ Types::ScheduledActionType

A JSON format string of the Amazon Redshift API operation with input parameters. For more information about this parameter, see ScheduledAction.

Returns: