Package software.amazon.awscdk.services.redshift

Class CfnScheduledAction.Builder

java.lang.Object

software.amazon.awscdk.services.redshift.CfnScheduledAction.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnScheduledAction>

Enclosing class:

CfnScheduledAction

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

A fluent builder for CfnScheduledAction.

Method Summary

Modifier and Type	Method	Description
CfnScheduledAction	build()
static CfnScheduledAction.Builder	create(software.constructs.Construct scope, String id)
CfnScheduledAction.Builder	enable(Boolean enable)	If true, the schedule is enabled.
CfnScheduledAction.Builder	enable(IResolvable enable)	If true, the schedule is enabled.
CfnScheduledAction.Builder	endTime(String endTime)	The end time in UTC when the schedule is no longer active.
CfnScheduledAction.Builder	iamRole(String iamRole)	The IAM role to assume to run the scheduled action.
CfnScheduledAction.Builder	schedule(String schedule)	The schedule for a one-time (at format) or recurring (cron format) scheduled action.
CfnScheduledAction.Builder	scheduledActionDescription(String scheduledActionDescription)	The description of the scheduled action.
CfnScheduledAction.Builder	scheduledActionName(String scheduledActionName)	The name of the scheduled action.
CfnScheduledAction.Builder	startTime(String startTime)	The start time in UTC when the schedule is active.
CfnScheduledAction.Builder	targetAction(IResolvable targetAction)	A JSON format string of the Amazon Redshift API operation with input parameters.
CfnScheduledAction.Builder	targetAction(CfnScheduledAction.ScheduledActionTypeProperty targetAction)	A JSON format string of the Amazon Redshift API operation with input parameters.

Methods inherited from class java.lang.Object

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

Method Details

create

@Stability(Stable)
public static CfnScheduledAction.Builder create(software.constructs.Construct scope,
 String id)

Parameters:

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

id - Construct identifier for this resource (unique in its scope). This parameter is required.

Returns:

a new instance of CfnScheduledAction.Builder.

scheduledActionName

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

The name of the scheduled action.

Parameters:

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

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-scheduledaction.html#cfn-redshift-scheduledaction-scheduledactionname

enable

@Stability(Stable)
public CfnScheduledAction.Builder enable(Boolean 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 .

Parameters:

enable - If true, the schedule is enabled. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-scheduledaction.html#cfn-redshift-scheduledaction-enable

enable

@Stability(Stable)
public CfnScheduledAction.Builder enable(IResolvable 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 .

Parameters:

enable - If true, the schedule is enabled. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-scheduledaction.html#cfn-redshift-scheduledaction-enable

endTime

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

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

After this time, the scheduled action does not trigger.

Parameters:

endTime - The end time in UTC when the schedule is no longer active. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-scheduledaction.html#cfn-redshift-scheduledaction-endtime

iamRole

@Stability(Stable)
public CfnScheduledAction.Builder iamRole(String 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 .

Parameters:

iamRole - The IAM role to assume to run the scheduled action. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-scheduledaction.html#cfn-redshift-scheduledaction-iamrole

schedule

@Stability(Stable)
public CfnScheduledAction.Builder schedule(String 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 .

Parameters:

schedule - The schedule for a one-time (at format) or recurring (cron format) scheduled action. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-scheduledaction.html#cfn-redshift-scheduledaction-schedule

scheduledActionDescription

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

The description of the scheduled action.

Parameters:

scheduledActionDescription - The description of the scheduled action. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-scheduledaction.html#cfn-redshift-scheduledaction-scheduledactiondescription

startTime

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

The start time in UTC when the schedule is active.

Before this time, the scheduled action does not trigger.

Parameters:

startTime - The start time in UTC when the schedule is active. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-scheduledaction.html#cfn-redshift-scheduledaction-starttime

targetAction

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

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

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

Parameters:

targetAction - A JSON format string of the Amazon Redshift API operation with input parameters. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-scheduledaction.html#cfn-redshift-scheduledaction-targetaction

targetAction

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

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

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

Parameters:

targetAction - A JSON format string of the Amazon Redshift API operation with input parameters. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-scheduledaction.html#cfn-redshift-scheduledaction-targetaction

build

@Stability(Stable)
public CfnScheduledAction build()

Specified by:

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

Returns:

a newly built instance of CfnScheduledAction.