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

Class CfnScheduledActionPropsMixin.Builder

java.lang.Object

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

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnScheduledActionPropsMixin>

Enclosing class:

CfnScheduledActionPropsMixin

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

A fluent builder for CfnScheduledActionPropsMixin.

Method Summary

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

Parameters:

options - Mixin options.

Returns:

a new instance of CfnScheduledActionPropsMixin.Builder.

create

@Stability(Stable)
public static CfnScheduledActionPropsMixin.Builder create()

Returns:

a new instance of CfnScheduledActionPropsMixin.Builder.

enable

@Stability(Stable)
public CfnScheduledActionPropsMixin.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 CfnScheduledActionPropsMixin.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 CfnScheduledActionPropsMixin.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 CfnScheduledActionPropsMixin.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 CfnScheduledActionPropsMixin.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 CfnScheduledActionPropsMixin.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

scheduledActionName

@Stability(Stable)
public CfnScheduledActionPropsMixin.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

startTime

@Stability(Stable)
public CfnScheduledActionPropsMixin.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 CfnScheduledActionPropsMixin.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 CfnScheduledActionPropsMixin.Builder targetAction(CfnScheduledActionPropsMixin.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 CfnScheduledActionPropsMixin build()

Specified by:

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

Returns:

a newly built instance of CfnScheduledActionPropsMixin.