Class CfnScheduledAction.Builder
- All Implemented Interfaces:
software.amazon.jsii.Builder<CfnScheduledAction>
- Enclosing class:
CfnScheduledAction
CfnScheduledAction
.-
Method Summary
Modifier and TypeMethodDescriptionbuild()
static CfnScheduledAction.Builder
If true, the schedule is enabled.enable
(IResolvable enable) If true, the schedule is enabled.The end time in UTC when the schedule is no longer active.The IAM role to assume to run the scheduled action.The schedule for a one-time (at format) or recurring (cron format) scheduled action.scheduledActionDescription
(String scheduledActionDescription) The description of the scheduled action.scheduledActionName
(String scheduledActionName) The name of the scheduled action.The start time in UTC when the schedule is active.targetAction
(IResolvable targetAction) A JSON format string of the Amazon Redshift API operation with input parameters.targetAction
(CfnScheduledAction.ScheduledActionTypeProperty targetAction) A JSON format string of the Amazon Redshift API operation with input parameters.
-
Method Details
-
create
- Parameters:
scope
-- scope in which this resource is defined.
id
-- scoped id of the resource.
- 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
-
enable
If true, the schedule is enabled.If false, the scheduled action does not trigger. For more information about
state
of the scheduled action, seeScheduledAction
.- Parameters:
enable
- If true, the schedule is enabled. This parameter is required.- Returns:
this
-
enable
If true, the schedule is enabled.If false, the scheduled action does not trigger. For more information about
state
of the scheduled action, seeScheduledAction
.- Parameters:
enable
- If true, the schedule is enabled. This parameter is required.- Returns:
this
-
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
-
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
-
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
-
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
-
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
-
targetAction
A JSON format string of the Amazon Redshift API operation with input parameters."
{\"ResizeCluster\":{\"NodeType\":\"ds2.8xlarge\",\"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
-
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\":\"ds2.8xlarge\",\"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
-
build
- Specified by:
build
in interfacesoftware.amazon.jsii.Builder<CfnScheduledAction>
- Returns:
- a newly built instance of
CfnScheduledAction
.
-