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

Inherits:

Struct

• Object
• Struct
• Aws::Redshift::Types::CreateScheduledActionMessage

Defined in:

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

Overview

Note:

When making an API call, you may pass CreateScheduledActionMessage data as a 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,
      reserved_node_id: "String",
      target_reserved_node_offering_id: "String",
    },
    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:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #enable ⇒ Boolean

  If true, the schedule is enabled.

• #end_time ⇒ Time

  The end time in UTC of the scheduled action.

• #iam_role ⇒ String

  The IAM role to assume to run the target action.

• #schedule ⇒ String

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

• #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 of the scheduled action.

• #target_action ⇒ Types::ScheduledActionType

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

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)

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

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

#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)

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

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

#iam_role ⇒ String

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

Returns:

• (String)

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

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

#schedule ⇒ String

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

Returns:

• (String)

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

class CreateScheduledActionMessage < Struct.new(
  :scheduled_action_name,
  :target_action,
  :schedule,
  :iam_role,
  :scheduled_action_description,
  :start_time,
  :end_time,
  :enable)
  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 3012

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

#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)

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

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

#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)

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

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

#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:

• (Types::ScheduledActionType)

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

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