Package software.amazon.awscdk.services.redshift

Class CfnScheduledActionProps.Builder

java.lang.Object

software.amazon.awscdk.services.redshift.CfnScheduledActionProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnScheduledActionProps>

Enclosing interface:

CfnScheduledActionProps

@Stability(Stable)
public static final class CfnScheduledActionProps.Builder
extends Object
implements software.amazon.jsii.Builder<CfnScheduledActionProps>

A builder for CfnScheduledActionProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CfnScheduledActionProps	build()	Builds the configured instance.
CfnScheduledActionProps.Builder	enable(Boolean enable)	Sets the value of CfnScheduledActionProps.getEnable()
CfnScheduledActionProps.Builder	enable(IResolvable enable)	Sets the value of CfnScheduledActionProps.getEnable()
CfnScheduledActionProps.Builder	endTime(String endTime)	Sets the value of CfnScheduledActionProps.getEndTime()
CfnScheduledActionProps.Builder	iamRole(String iamRole)	Sets the value of CfnScheduledActionProps.getIamRole()
CfnScheduledActionProps.Builder	schedule(String schedule)	Sets the value of CfnScheduledActionProps.getSchedule()
CfnScheduledActionProps.Builder	scheduledActionDescription(String scheduledActionDescription)	Sets the value of CfnScheduledActionProps.getScheduledActionDescription()
CfnScheduledActionProps.Builder	scheduledActionName(String scheduledActionName)	Sets the value of CfnScheduledActionProps.getScheduledActionName()
CfnScheduledActionProps.Builder	startTime(String startTime)	Sets the value of CfnScheduledActionProps.getStartTime()
CfnScheduledActionProps.Builder	targetAction(IResolvable targetAction)	Sets the value of CfnScheduledActionProps.getTargetAction()
CfnScheduledActionProps.Builder	targetAction(CfnScheduledAction.ScheduledActionTypeProperty targetAction)	Sets the value of CfnScheduledActionProps.getTargetAction()

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Method Details

scheduledActionName

@Stability(Stable)
public CfnScheduledActionProps.Builder scheduledActionName(String scheduledActionName)

Sets the value of CfnScheduledActionProps.getScheduledActionName()

Parameters:

scheduledActionName - The name of the scheduled action. This parameter is required.

Returns:

this

enable

@Stability(Stable)
public CfnScheduledActionProps.Builder enable(Boolean enable)

Sets the value of CfnScheduledActionProps.getEnable()

Parameters:

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

Returns:

this

enable

@Stability(Stable)
public CfnScheduledActionProps.Builder enable(IResolvable enable)

Sets the value of CfnScheduledActionProps.getEnable()

Parameters:

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

Returns:

this

endTime

@Stability(Stable)
public CfnScheduledActionProps.Builder endTime(String endTime)

Sets the value of CfnScheduledActionProps.getEndTime()

Parameters:

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

Returns:

this

iamRole

@Stability(Stable)
public CfnScheduledActionProps.Builder iamRole(String iamRole)

Sets the value of CfnScheduledActionProps.getIamRole()

Parameters:

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

Returns:

this

schedule

@Stability(Stable)
public CfnScheduledActionProps.Builder schedule(String schedule)

Sets the value of CfnScheduledActionProps.getSchedule()

Parameters:

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

Returns:

this

scheduledActionDescription

@Stability(Stable)
public CfnScheduledActionProps.Builder scheduledActionDescription(String scheduledActionDescription)

Sets the value of CfnScheduledActionProps.getScheduledActionDescription()

Parameters:

scheduledActionDescription - The description of the scheduled action.

Returns:

this

startTime

@Stability(Stable)
public CfnScheduledActionProps.Builder startTime(String startTime)

Sets the value of CfnScheduledActionProps.getStartTime()

Parameters:

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

Returns:

this

targetAction

@Stability(Stable)
public CfnScheduledActionProps.Builder targetAction(IResolvable targetAction)

Sets the value of CfnScheduledActionProps.getTargetAction()

Parameters:

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

Returns:

this

targetAction

@Stability(Stable)
public CfnScheduledActionProps.Builder targetAction(CfnScheduledAction.ScheduledActionTypeProperty targetAction)

Sets the value of CfnScheduledActionProps.getTargetAction()

Parameters:

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

Returns:

this

build

@Stability(Stable)
public CfnScheduledActionProps build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<CfnScheduledActionProps>

Returns:

a new instance of CfnScheduledActionProps

Throws:

NullPointerException - if any required attribute was not provided