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

Class: Aws::Redshift::Types::ModifyScheduledActionMessage

Inherits:

Struct

• Object
• Struct
• Aws::Redshift::Types::ModifyScheduledActionMessage

Defined in:

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

Overview

Note:

When making an API call, you may pass ModifyScheduledActionMessage data as a hash:

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

See Also:

• AWS API Documentation

Instance Attribute Summary

• #enable ⇒ Boolean

  A modified enable flag of the scheduled action.

• #end_time ⇒ Time

  A modified end time of the scheduled action.

• #iam_role ⇒ String

  A different IAM role to assume to run the target action.

• #schedule ⇒ String

  A modified schedule in either at( ) or cron( ) format.

• #scheduled_action_description ⇒ String

  A modified description of the scheduled action.

• #scheduled_action_name ⇒ String

  The name of the scheduled action to modify.

• #start_time ⇒ Time

  A modified start time of the scheduled action.

• #target_action ⇒ Types::ScheduledActionType

  A modified JSON format of the scheduled action.

Instance Attribute Details

#enable ⇒ Boolean

A modified enable flag of the scheduled action. If true, the scheduled action is active. If false, the scheduled action is disabled.

Returns:

• (Boolean)

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

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

#end_time ⇒ Time

A modified end time of the scheduled action. For more information about this parameter, see ScheduledAction.

Returns:

• (Time)

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

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

#iam_role ⇒ String

A different 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 6396

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

#schedule ⇒ String

A modified schedule in either 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 6396

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

#scheduled_action_description ⇒ String

A modified description of the scheduled action.

Returns:

• (String)

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

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

#scheduled_action_name ⇒ String

The name of the scheduled action to modify.

Returns:

• (String)

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

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

#start_time ⇒ Time

A modified start time of the scheduled action. For more information about this parameter, see ScheduledAction.

Returns:

• (Time)

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

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

#target_action ⇒ Types::ScheduledActionType

A modified JSON format of the scheduled action. For more information about this parameter, see ScheduledAction.

Returns:

• (Types::ScheduledActionType)

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

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