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

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

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#enableBoolean

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)


3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
# 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_timeTime

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)


3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
# 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_roleString

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

Returns:

  • (String)


3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
# 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

#scheduleString

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

Returns:

  • (String)


3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
# 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_descriptionString

The description of the scheduled action.

Returns:

  • (String)


3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
# 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_nameString

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

Returns:

  • (String)


3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
# 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_timeTime

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)


3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
# 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_actionTypes::ScheduledActionType

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



3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
# 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