software.amazon.awscdk.services.redshift

Interface CfnScheduledActionProps

All Known Implementing Classes:

CfnScheduledActionProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-22T19:35:45.869Z")
public interface 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 software.amazon.awscdk.services.redshift.*;
 CfnScheduledActionProps cfnScheduledActionProps = CfnScheduledActionProps.builder()
         .scheduledActionName("scheduledActionName")
         // the properties below are optional
         .enable(false)
         .endTime("endTime")
         .iamRole("iamRole")
         .schedule("schedule")
         .scheduledActionDescription("scheduledActionDescription")
         .startTime("startTime")
         .targetAction(ScheduledActionTypeProperty.builder()
                 .pauseCluster(PauseClusterMessageProperty.builder()
                         .clusterIdentifier("clusterIdentifier")
                         .build())
                 .resizeCluster(ResizeClusterMessageProperty.builder()
                         .clusterIdentifier("clusterIdentifier")
                         // the properties below are optional
                         .classic(false)
                         .clusterType("clusterType")
                         .nodeType("nodeType")
                         .numberOfNodes(123)
                         .build())
                 .resumeCluster(ResumeClusterMessageProperty.builder()
                         .clusterIdentifier("clusterIdentifier")
                         .build())
                 .build())
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CfnScheduledActionProps.Builder A builder for CfnScheduledActionProps
static class	CfnScheduledActionProps.Jsii$Proxy An implementation for CfnScheduledActionProps

Method Summary

Modifier and Type	Method and Description
static CfnScheduledActionProps.Builder	builder()
default java.lang.Object	getEnable() If true, the schedule is enabled.
default java.lang.String	getEndTime() The end time in UTC when the schedule is no longer active.
default java.lang.String	getIamRole() The IAM role to assume to run the scheduled action.
default java.lang.String	getSchedule() The schedule for a one-time (at format) or recurring (cron format) scheduled action.
default java.lang.String	getScheduledActionDescription() The description of the scheduled action.
java.lang.String	getScheduledActionName() The name of the scheduled action.
default java.lang.String	getStartTime() The start time in UTC when the schedule is active.
default java.lang.Object	getTargetAction() A JSON format string of the Amazon Redshift API operation with input parameters.

Method Detail

getScheduledActionName

java.lang.String getScheduledActionName()

The name of the scheduled action.

getEnable

default java.lang.Object getEnable()

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 .

getEndTime

default java.lang.String getEndTime()

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

After this time, the scheduled action does not trigger.

getIamRole

default java.lang.String getIamRole()

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 .

getSchedule

default java.lang.String getSchedule()

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 .

getScheduledActionDescription

default java.lang.String getScheduledActionDescription()

The description of the scheduled action.

getStartTime

default java.lang.String getStartTime()

The start time in UTC when the schedule is active.

Before this time, the scheduled action does not trigger.

getTargetAction

default java.lang.Object getTargetAction()

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

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

builder

static CfnScheduledActionProps.Builder builder()

Returns:

a CfnScheduledActionProps.Builder of CfnScheduledActionProps