Create Scheduled Action

redshiftserverless_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 create_snapshot API operation.

Usage

redshiftserverless_create_scheduled_action(enabled, endTime,
  namespaceName, roleArn, schedule, scheduledActionDescription,
  scheduledActionName, startTime, targetAction)

Arguments

enabled

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

endTime

The end time in UTC when the schedule is no longer active. After this time, the scheduled action does not trigger.

namespaceName

[required] The name of the namespace for which to create a scheduled action.

roleArn

[required] The ARN of the IAM role to assume to run the scheduled action. This IAM role must have permission to run the Amazon Redshift Serverless API operation in the scheduled action. This IAM role must allow the Amazon Redshift scheduler to schedule creating snapshots. (Principal scheduler.redshift.amazonaws.com) to assume permissions on your behalf. For more information about the IAM role to use with the Amazon Redshift scheduler, see Using Identity-Based Policies for Amazon Redshift in the Amazon Redshift Management Guide

schedule

[required] The schedule for a one-time (at timestamp format) or recurring (cron format) scheduled action. Schedule invocations must be separated by at least one hour. Times are in UTC.

• Format of at timestamp is yyyy-mm-ddThh:mm:ss. For example, ⁠2016-03-04T17:27:00⁠.

• Format of cron expression is ⁠(Minutes Hours Day-of-month Month Day-of-week Year)⁠. For example, "(0 10 ? * MON *)". For more information, see Cron Expressions in the Amazon CloudWatch Events User Guide.

scheduledActionDescription

The description of the scheduled action.

scheduledActionName

[required] The name of the scheduled action.

startTime

The start time in UTC when the schedule is active. Before this time, the scheduled action does not trigger.

targetAction

[required]

Value

A list with the following syntax:

list(
  scheduledAction = list(
    endTime = as.POSIXct(
      "2015-01-01"
    ),
    namespaceName = "string",
    nextInvocations = list(
      as.POSIXct(
        "2015-01-01"
      )
    ),
    roleArn = "string",
    schedule = list(
      at = as.POSIXct(
        "2015-01-01"
      ),
      cron = "string"
    ),
    scheduledActionDescription = "string",
    scheduledActionName = "string",
    scheduledActionUuid = "string",
    startTime = as.POSIXct(
      "2015-01-01"
    ),
    state = "ACTIVE"|"DISABLED",
    targetAction = list(
      createSnapshot = list(
        namespaceName = "string",
        retentionPeriod = 123,
        snapshotNamePrefix = "string",
        tags = list(
          list(
            key = "string",
            value = "string"
          )
        )
      )
    )
  )
)

Request syntax

svc$create_scheduled_action(
  enabled = TRUE|FALSE,
  endTime = as.POSIXct(
    "2015-01-01"
  ),
  namespaceName = "string",
  roleArn = "string",
  schedule = list(
    at = as.POSIXct(
      "2015-01-01"
    ),
    cron = "string"
  ),
  scheduledActionDescription = "string",
  scheduledActionName = "string",
  startTime = as.POSIXct(
    "2015-01-01"
  ),
  targetAction = list(
    createSnapshot = list(
      namespaceName = "string",
      retentionPeriod = 123,
      snapshotNamePrefix = "string",
      tags = list(
        list(
          key = "string",
          value = "string"
        )
      )
    )
  )
)