interface CfnScheduledActionProps

Language	Type name
.NET	`Amazon.CDK.AWS.Redshift.CfnScheduledActionProps`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awsredshift#CfnScheduledActionProps`
Java	`software.amazon.awscdk.services.redshift.CfnScheduledActionProps`
Python	`aws_cdk.aws_redshift.CfnScheduledActionProps`
TypeScript	`aws-cdk-lib` » `aws_redshift` » `CfnScheduledActionProps`

Properties for defining a CfnScheduledAction.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_redshift as redshift } from 'aws-cdk-lib';
const cfnScheduledActionProps: redshift.CfnScheduledActionProps = {
  scheduledActionName: 'scheduledActionName',

  // the properties below are optional
  enable: false,
  endTime: 'endTime',
  iamRole: 'iamRole',
  schedule: 'schedule',
  scheduledActionDescription: 'scheduledActionDescription',
  startTime: 'startTime',
  targetAction: {
    pauseCluster: {
      clusterIdentifier: 'clusterIdentifier',
    },
    resizeCluster: {
      clusterIdentifier: 'clusterIdentifier',

      // the properties below are optional
      classic: false,
      clusterType: 'clusterType',
      nodeType: 'nodeType',
      numberOfNodes: 123,
    },
    resumeCluster: {
      clusterIdentifier: 'clusterIdentifier',
    },
  },
};

Properties

Name	Type	Description
scheduledActionName	`string`	The name of the scheduled action.
enable?	`boolean \|` `IResolvable`	If true, the schedule is enabled.
endTime?	`string`	The end time in UTC when the schedule is no longer active.
iamRole?	`string`	The IAM role to assume to run the scheduled action.
schedule?	`string`	The schedule for a one-time (at format) or recurring (cron format) scheduled action.
scheduledActionDescription?	`string`	The description of the scheduled action.
startTime?	`string`	The start time in UTC when the schedule is active.
targetAction?	`IResolvable` `\|` `ScheduledActionTypeProperty`	A JSON format string of the Amazon Redshift API operation with input parameters.

scheduledActionName

Type: string

The name of the scheduled action.

enable?

Type: boolean | IResolvable (optional)

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 .

endTime?

Type: string (optional)

The end time in UTC when the schedule is no longer active.

After this time, the scheduled action does not trigger.

iamRole?

Type: string (optional)

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 in the Amazon Redshift Cluster Management Guide .

schedule?

Type: string (optional)

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 in the Amazon CloudWatch Events User Guide .

scheduledActionDescription?

Type: string (optional)

The description of the scheduled action.

startTime?

Type: string (optional)

The start time in UTC when the schedule is active.

Before this time, the scheduled action does not trigger.

targetAction?

Type: IResolvable | ScheduledActionTypeProperty (optional)

A JSON format string of the Amazon Redshift API operation with input parameters.

" {\"ResizeCluster\":{\"NodeType\":\"ra3.4xlarge\",\"ClusterIdentifier\":\"my-test-cluster\",\"NumberOfNodes\":3}} ".