Create Scheduled Action

redshift_create_scheduled_action

R Documentation

Creates a scheduled action¶

Description¶

Creates a scheduled action. A scheduled action contains a schedule and an Amazon Redshift API action. For example, you can create a schedule of when to run the resize_cluster API operation.

Usage¶

redshift_create_scheduled_action(ScheduledActionName, TargetAction,
  Schedule, IamRole, ScheduledActionDescription, StartTime, EndTime,
  Enable)

Arguments¶

ScheduledActionName: [required] The name of the scheduled action. The name must be unique within an account. For more information about this parameter, see ScheduledAction.
TargetAction: [required] A JSON format string of the Amazon Redshift API operation with input parameters. For more information about this parameter, see ScheduledAction.
Schedule: [required] The schedule in at( ) or cron( ) format. For more information about this parameter, see ScheduledAction.
IamRole: [required] The IAM role to assume to run the target action. For more information about this parameter, see ScheduledAction.
ScheduledActionDescription: The description of the scheduled action.
StartTime: 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.
EndTime: 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.
Enable: 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.

Value¶

A list with the following syntax:

list(
  ScheduledActionName = "string",
  TargetAction = list(
    ResizeCluster = list(
      ClusterIdentifier = "string",
      ClusterType = "string",
      NodeType = "string",
      NumberOfNodes = 123,
      Classic = TRUE|FALSE,
      ReservedNodeId = "string",
      TargetReservedNodeOfferingId = "string"
    ),
    PauseCluster = list(
      ClusterIdentifier = "string"
    ),
    ResumeCluster = list(
      ClusterIdentifier = "string"
    )
  ),
  Schedule = "string",
  IamRole = "string",
  ScheduledActionDescription = "string",
  State = "ACTIVE"|"DISABLED",
  NextInvocations = list(
    as.POSIXct(
      "2015-01-01"
    )
  ),
  StartTime = as.POSIXct(
    "2015-01-01"
  ),
  EndTime = as.POSIXct(
    "2015-01-01"
  )
)

Request syntax¶

svc$create_scheduled_action(
  ScheduledActionName = "string",
  TargetAction = list(
    ResizeCluster = list(
      ClusterIdentifier = "string",
      ClusterType = "string",
      NodeType = "string",
      NumberOfNodes = 123,
      Classic = TRUE|FALSE,
      ReservedNodeId = "string",
      TargetReservedNodeOfferingId = "string"
    ),
    PauseCluster = list(
      ClusterIdentifier = "string"
    ),
    ResumeCluster = list(
      ClusterIdentifier = "string"
    )
  ),
  Schedule = "string",
  IamRole = "string",
  ScheduledActionDescription = "string",
  StartTime = as.POSIXct(
    "2015-01-01"
  ),
  EndTime = as.POSIXct(
    "2015-01-01"
  ),
  Enable = TRUE|FALSE
)