AWS Fundamentals Logo
AWS Fundamentals
L1 ConstructAWS::Redshift::ScheduledAction

CfnScheduledAction

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 `ResizeCluster` API operation.

Import

import { CfnScheduledAction } from 'aws-cdk-lib/aws-redshift';

Or use the module namespace:

import * as redshift from 'aws-cdk-lib/aws-redshift';
// redshift.CfnScheduledAction

Properties

Configuration passed to the constructor as CfnScheduledActionProps.

scheduledActionNameRequired
string

The name of the scheduled action.

enableOptional
boolean | IResolvable

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` .

endTimeOptional
string

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

iamRoleOptional
string

The IAM role to assume to run the scheduled action. This IAM role must have permission to run the Amazon Redshift API operation in the scheduled action. This IAM role must allow the Amazon Redshift scheduler (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](https://docs.aws.amazon.com/redshift/latest/mgmt/redshift-iam-access-control-identity-based.html) in the *Amazon Redshift Cluster Management Guide* .

scheduleOptional
string

The schedule for a one-time (at format) or recurring (cron format) scheduled action. Schedule invocations must be separated by at least one hour. Format of at expressions is " `at(yyyy-mm-ddThh:mm:ss)` ". For example, " `at(2016-03-04T17:27:00)` ". Format of cron expressions is " `cron(Minutes Hours Day-of-month Month Day-of-week Year)` ". For example, " `cron(0 10 ? * MON *)` ". For more information, see [Cron Expressions](https://docs.aws.amazon.com//AmazonCloudWatch/latest/events/ScheduledEvents.html#CronExpressions) in the *Amazon CloudWatch Events User Guide* .

scheduledActionDescriptionOptional
string

The description of the scheduled action.

startTimeOptional
string

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

targetActionOptional
IResolvable | ScheduledActionTypeProperty

A JSON format string of the Amazon Redshift API operation with input parameters. " `{\"ResizeCluster\":{\"NodeType\":\"ra3.4xlarge\",\"ClusterIdentifier\":\"my-test-cluster\",\"NumberOfNodes\":3}}` ".

CloudFormation Resource

This L1 construct maps directly to the following CloudFormation resource type.

AWS::Redshift::ScheduledActionView in CloudFormation Explorer

Learn AWS the Practical Way

Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.

Subscribe to Newsletter

Quick Facts

LevelL1 (CloudFormation)
Moduleaws-redshift
CFN TypeAWS::Redshift::ScheduledAction
Properties8

Related Constructs

Explore This Service

External Links