Package software.amazon.awscdk.cfnpropertymixins.services.redshift

Class CfnScheduledActionMixinProps.Builder

java.lang.Object

software.amazon.awscdk.cfnpropertymixins.services.redshift.CfnScheduledActionMixinProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnScheduledActionMixinProps>

Enclosing interface:

CfnScheduledActionMixinProps

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

A builder for CfnScheduledActionMixinProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CfnScheduledActionMixinProps	build()	Builds the configured instance.
CfnScheduledActionMixinProps.Builder	enable(Boolean enable)	Sets the value of CfnScheduledActionMixinProps.getEnable()
CfnScheduledActionMixinProps.Builder	enable(IResolvable enable)	Sets the value of CfnScheduledActionMixinProps.getEnable()
CfnScheduledActionMixinProps.Builder	endTime(String endTime)	Sets the value of CfnScheduledActionMixinProps.getEndTime()
CfnScheduledActionMixinProps.Builder	iamRole(String iamRole)	Sets the value of CfnScheduledActionMixinProps.getIamRole()
CfnScheduledActionMixinProps.Builder	schedule(String schedule)	Sets the value of CfnScheduledActionMixinProps.getSchedule()
CfnScheduledActionMixinProps.Builder	scheduledActionDescription(String scheduledActionDescription)	Sets the value of CfnScheduledActionMixinProps.getScheduledActionDescription()
CfnScheduledActionMixinProps.Builder	scheduledActionName(String scheduledActionName)	Sets the value of CfnScheduledActionMixinProps.getScheduledActionName()
CfnScheduledActionMixinProps.Builder	startTime(String startTime)	Sets the value of CfnScheduledActionMixinProps.getStartTime()
CfnScheduledActionMixinProps.Builder	targetAction(CfnScheduledActionPropsMixin.ScheduledActionTypeProperty targetAction)	Sets the value of CfnScheduledActionMixinProps.getTargetAction()
CfnScheduledActionMixinProps.Builder	targetAction(IResolvable targetAction)	Sets the value of CfnScheduledActionMixinProps.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

enable

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

Sets the value of CfnScheduledActionMixinProps.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 CfnScheduledActionMixinProps.Builder enable(IResolvable enable)

Sets the value of CfnScheduledActionMixinProps.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 CfnScheduledActionMixinProps.Builder endTime(String endTime)

Sets the value of CfnScheduledActionMixinProps.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 CfnScheduledActionMixinProps.Builder iamRole(String iamRole)

Sets the value of CfnScheduledActionMixinProps.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 CfnScheduledActionMixinProps.Builder schedule(String schedule)

Sets the value of CfnScheduledActionMixinProps.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 CfnScheduledActionMixinProps.Builder scheduledActionDescription(String scheduledActionDescription)

Sets the value of CfnScheduledActionMixinProps.getScheduledActionDescription()

Parameters:

scheduledActionDescription - The description of the scheduled action.

Returns:

this

scheduledActionName

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

Sets the value of CfnScheduledActionMixinProps.getScheduledActionName()

Parameters:

scheduledActionName - The name of the scheduled action.

Returns:

this

startTime

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

Sets the value of CfnScheduledActionMixinProps.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 CfnScheduledActionMixinProps.Builder targetAction(IResolvable targetAction)

Sets the value of CfnScheduledActionMixinProps.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 CfnScheduledActionMixinProps.Builder targetAction(CfnScheduledActionPropsMixin.ScheduledActionTypeProperty targetAction)

Sets the value of CfnScheduledActionMixinProps.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 CfnScheduledActionMixinProps build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of CfnScheduledActionMixinProps

Throws:

NullPointerException - if any required attribute was not provided