software.amazon.awscdk.services.redshift

Class CfnScheduledAction

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.redshift.CfnScheduledAction

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:41.549Z")
 @Stability(value=Stable)
public class CfnScheduledAction
extends CfnResource
implements IInspectable

A CloudFormation `AWS::Redshift::ScheduledAction`.

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.

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.*;
 Object targetAction;
 CfnScheduledAction cfnScheduledAction = CfnScheduledAction.Builder.create(this, "MyCfnScheduledAction")
         .scheduledActionName("scheduledActionName")
         // the properties below are optional
         .enable(false)
         .endTime("endTime")
         .iamRole("iamRole")
         .schedule("schedule")
         .scheduledActionDescription("scheduledActionDescription")
         .startTime("startTime")
         .targetAction(targetAction)
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnScheduledAction.Builder A fluent builder for CfnScheduledAction.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnScheduledAction(software.constructs.Construct scope, String id, CfnScheduledActionProps props) Create a new `AWS::Redshift::ScheduledAction`.
protected	CfnScheduledAction(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnScheduledAction(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
List<String>	getAttrNextInvocations() List of times when the scheduled action will run.
String	getAttrState() The state of the scheduled action.
protected Map<String,Object>	getCfnProperties()
Object	getEnable() If true, the schedule is enabled.
String	getEndTime() The end time in UTC when the schedule is no longer active.
String	getIamRole() The IAM role to assume to run the scheduled action.
String	getSchedule() The schedule for a one-time (at format) or recurring (cron format) scheduled action.
String	getScheduledActionDescription() The description of the scheduled action.
String	getScheduledActionName() The name of the scheduled action.
String	getStartTime() The start time in UTC when the schedule is active.
Object	getTargetAction() A JSON format string of the Amazon Redshift API operation with input parameters.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setEnable(Boolean value) If true, the schedule is enabled.
void	setEnable(IResolvable value) If true, the schedule is enabled.
void	setEndTime(String value) The end time in UTC when the schedule is no longer active.
void	setIamRole(String value) The IAM role to assume to run the scheduled action.
void	setSchedule(String value) The schedule for a one-time (at format) or recurring (cron format) scheduled action.
void	setScheduledActionDescription(String value) The description of the scheduled action.
void	setScheduledActionName(String value) The name of the scheduled action.
void	setStartTime(String value) The start time in UTC when the schedule is active.
void	setTargetAction(Object value) A JSON format string of the Amazon Redshift API operation with input parameters.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnScheduledAction

protected CfnScheduledAction(software.amazon.jsii.JsiiObjectRef objRef)

CfnScheduledAction

protected CfnScheduledAction(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnScheduledAction

@Stability(value=Stable)
public CfnScheduledAction(@NotNull
                                                   software.constructs.Construct scope,
                                                   @NotNull
                                                   String id,
                                                   @NotNull
                                                   CfnScheduledActionProps props)

Create a new `AWS::Redshift::ScheduledAction`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

props - - resource properties. This parameter is required.

Method Detail

inspect

@Stability(value=Stable)
public void inspect(@NotNull
                                             TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrNextInvocations

@Stability(value=Stable)
 @NotNull
public List<String> getAttrNextInvocations()

List of times when the scheduled action will run.

getAttrState

@Stability(value=Stable)
 @NotNull
public String getAttrState()

The state of the scheduled action.

For example, DISABLED .

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getScheduledActionName

@Stability(value=Stable)
 @NotNull
public String getScheduledActionName()

The name of the scheduled action.

setScheduledActionName

@Stability(value=Stable)
public void setScheduledActionName(@NotNull
                                                            String value)

The name of the scheduled action.

getTargetAction

@Stability(value=Stable)
 @NotNull
public 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}} ".

setTargetAction

@Stability(value=Stable)
public void setTargetAction(@NotNull
                                                     Object value)

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

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

getEnable

@Stability(value=Stable)
 @Nullable
public 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 .

setEnable

@Stability(value=Stable)
public void setEnable(@Nullable
                                               Boolean value)

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 .

setEnable

@Stability(value=Stable)
public void setEnable(@Nullable
                                               IResolvable value)

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

@Stability(value=Stable)
 @Nullable
public String getEndTime()

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

After this time, the scheduled action does not trigger.

setEndTime

@Stability(value=Stable)
public void setEndTime(@Nullable
                                                String value)

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

After this time, the scheduled action does not trigger.

getIamRole

@Stability(value=Stable)
 @Nullable
public 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 .

setIamRole

@Stability(value=Stable)
public void setIamRole(@Nullable
                                                String value)

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

@Stability(value=Stable)
 @Nullable
public 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 .

setSchedule

@Stability(value=Stable)
public void setSchedule(@Nullable
                                                 String value)

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

@Stability(value=Stable)
 @Nullable
public String getScheduledActionDescription()

The description of the scheduled action.

setScheduledActionDescription

@Stability(value=Stable)
public void setScheduledActionDescription(@Nullable
                                                                   String value)

The description of the scheduled action.

getStartTime

@Stability(value=Stable)
 @Nullable
public String getStartTime()

The start time in UTC when the schedule is active.

Before this time, the scheduled action does not trigger.

setStartTime

@Stability(value=Stable)
public void setStartTime(@Nullable
                                                  String value)

The start time in UTC when the schedule is active.

Before this time, the scheduled action does not trigger.