Package software.amazon.awscdk.services.stepfunctions.tasks

Class EventBridgeSchedulerCreateScheduleTaskJsonPathProps.Builder

java.lang.Object

software.amazon.awscdk.services.stepfunctions.tasks.EventBridgeSchedulerCreateScheduleTaskJsonPathProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<EventBridgeSchedulerCreateScheduleTaskJsonPathProps>

Enclosing interface:

EventBridgeSchedulerCreateScheduleTaskJsonPathProps

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

A builder for EventBridgeSchedulerCreateScheduleTaskJsonPathProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
EventBridgeSchedulerCreateScheduleTaskJsonPathProps.Builder	actionAfterCompletion(ActionAfterCompletion actionAfterCompletion)	Sets the value of EventBridgeSchedulerCreateScheduleTaskJsonPathProps.getActionAfterCompletion()
EventBridgeSchedulerCreateScheduleTaskJsonPathProps.Builder	assign(Map<String,? extends Object> assign)	Sets the value of AssignableStateOptions.getAssign()
EventBridgeSchedulerCreateScheduleTaskJsonPathProps	build()	Builds the configured instance.
EventBridgeSchedulerCreateScheduleTaskJsonPathProps.Builder	clientToken(String clientToken)	Sets the value of EventBridgeSchedulerCreateScheduleTaskJsonPathProps.getClientToken()
EventBridgeSchedulerCreateScheduleTaskJsonPathProps.Builder	comment(String comment)	Sets the value of StateBaseProps.getComment()
EventBridgeSchedulerCreateScheduleTaskJsonPathProps.Builder	credentials(Credentials credentials)	Sets the value of TaskStateBaseOptions.getCredentials()
EventBridgeSchedulerCreateScheduleTaskJsonPathProps.Builder	description(String description)	Sets the value of EventBridgeSchedulerCreateScheduleTaskJsonPathProps.getDescription()
EventBridgeSchedulerCreateScheduleTaskJsonPathProps.Builder	enabled(Boolean enabled)	Sets the value of EventBridgeSchedulerCreateScheduleTaskJsonPathProps.getEnabled()
EventBridgeSchedulerCreateScheduleTaskJsonPathProps.Builder	endDate(Instant endDate)	Sets the value of EventBridgeSchedulerCreateScheduleTaskJsonPathProps.getEndDate()
EventBridgeSchedulerCreateScheduleTaskJsonPathProps.Builder	flexibleTimeWindow(Duration flexibleTimeWindow)	Sets the value of EventBridgeSchedulerCreateScheduleTaskJsonPathProps.getFlexibleTimeWindow()
EventBridgeSchedulerCreateScheduleTaskJsonPathProps.Builder	groupName(String groupName)	Sets the value of EventBridgeSchedulerCreateScheduleTaskJsonPathProps.getGroupName()
EventBridgeSchedulerCreateScheduleTaskJsonPathProps.Builder	heartbeat(Duration heartbeat)	Deprecated. use `heartbeatTimeout`
EventBridgeSchedulerCreateScheduleTaskJsonPathProps.Builder	heartbeatTimeout(Timeout heartbeatTimeout)	Sets the value of TaskStateBaseOptions.getHeartbeatTimeout()
EventBridgeSchedulerCreateScheduleTaskJsonPathProps.Builder	inputPath(String inputPath)	Sets the value of JsonPathCommonOptions.getInputPath()
EventBridgeSchedulerCreateScheduleTaskJsonPathProps.Builder	integrationPattern(IntegrationPattern integrationPattern)	Sets the value of TaskStateBaseOptions.getIntegrationPattern()
EventBridgeSchedulerCreateScheduleTaskJsonPathProps.Builder	kmsKey(IKey kmsKey)	Sets the value of EventBridgeSchedulerCreateScheduleTaskJsonPathProps.getKmsKey()
EventBridgeSchedulerCreateScheduleTaskJsonPathProps.Builder	outputPath(String outputPath)	Sets the value of JsonPathCommonOptions.getOutputPath()
EventBridgeSchedulerCreateScheduleTaskJsonPathProps.Builder	queryLanguage(QueryLanguage queryLanguage)	Sets the value of StateBaseProps.getQueryLanguage()
EventBridgeSchedulerCreateScheduleTaskJsonPathProps.Builder	resultPath(String resultPath)	Sets the value of TaskStateJsonPathBaseProps.getResultPath()
EventBridgeSchedulerCreateScheduleTaskJsonPathProps.Builder	resultSelector(Map<String,? extends Object> resultSelector)	Sets the value of TaskStateJsonPathBaseProps.getResultSelector()
EventBridgeSchedulerCreateScheduleTaskJsonPathProps.Builder	schedule(Schedule schedule)	Sets the value of EventBridgeSchedulerCreateScheduleTaskJsonPathProps.getSchedule()
EventBridgeSchedulerCreateScheduleTaskJsonPathProps.Builder	scheduleName(String scheduleName)	Sets the value of EventBridgeSchedulerCreateScheduleTaskJsonPathProps.getScheduleName()
EventBridgeSchedulerCreateScheduleTaskJsonPathProps.Builder	startDate(Instant startDate)	Sets the value of EventBridgeSchedulerCreateScheduleTaskJsonPathProps.getStartDate()
EventBridgeSchedulerCreateScheduleTaskJsonPathProps.Builder	stateName(String stateName)	Sets the value of StateBaseProps.getStateName()
EventBridgeSchedulerCreateScheduleTaskJsonPathProps.Builder	target(EventBridgeSchedulerTarget target)	Sets the value of EventBridgeSchedulerCreateScheduleTaskJsonPathProps.getTarget()
EventBridgeSchedulerCreateScheduleTaskJsonPathProps.Builder	taskTimeout(Timeout taskTimeout)	Sets the value of TaskStateBaseOptions.getTaskTimeout()
EventBridgeSchedulerCreateScheduleTaskJsonPathProps.Builder	timeout(Duration timeout)	Deprecated. use `taskTimeout`
EventBridgeSchedulerCreateScheduleTaskJsonPathProps.Builder	timezone(String timezone)	Sets the value of EventBridgeSchedulerCreateScheduleTaskJsonPathProps.getTimezone()

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

schedule

@Stability(Stable)
public EventBridgeSchedulerCreateScheduleTaskJsonPathProps.Builder schedule(Schedule schedule)

Sets the value of EventBridgeSchedulerCreateScheduleTaskJsonPathProps.getSchedule()

Parameters:

schedule - The schedule that defines when the schedule will trigger. This parameter is required.

Returns:

this

scheduleName

@Stability(Stable)
public EventBridgeSchedulerCreateScheduleTaskJsonPathProps.Builder scheduleName(String scheduleName)

Sets the value of EventBridgeSchedulerCreateScheduleTaskJsonPathProps.getScheduleName()

Parameters:

scheduleName - Schedule name. This parameter is required.

Returns:

this

target

@Stability(Stable)
public EventBridgeSchedulerCreateScheduleTaskJsonPathProps.Builder target(EventBridgeSchedulerTarget target)

Sets the value of EventBridgeSchedulerCreateScheduleTaskJsonPathProps.getTarget()

Parameters:

target - The schedule's target. This parameter is required.

Returns:

this

actionAfterCompletion

@Stability(Stable)
public EventBridgeSchedulerCreateScheduleTaskJsonPathProps.Builder actionAfterCompletion(ActionAfterCompletion actionAfterCompletion)

Sets the value of EventBridgeSchedulerCreateScheduleTaskJsonPathProps.getActionAfterCompletion()

Parameters:

actionAfterCompletion - Specifies the action that EventBridge Scheduler applies to the schedule after the schedule completes invoking the target.

Returns:

this

clientToken

@Stability(Stable)
public EventBridgeSchedulerCreateScheduleTaskJsonPathProps.Builder clientToken(String clientToken)

Sets the value of EventBridgeSchedulerCreateScheduleTaskJsonPathProps.getClientToken()

Parameters:

clientToken - Unique, case-sensitive identifier to ensure the idempotency of the request.

Returns:

this

description

@Stability(Stable)
public EventBridgeSchedulerCreateScheduleTaskJsonPathProps.Builder description(String description)

Sets the value of EventBridgeSchedulerCreateScheduleTaskJsonPathProps.getDescription()

Parameters:

description - The description for the schedule.

Returns:

this

enabled

@Stability(Stable)
public EventBridgeSchedulerCreateScheduleTaskJsonPathProps.Builder enabled(Boolean enabled)

Sets the value of EventBridgeSchedulerCreateScheduleTaskJsonPathProps.getEnabled()

Parameters:

enabled - Specifies whether the schedule is enabled or disabled.

Returns:

this

endDate

@Stability(Stable)
public EventBridgeSchedulerCreateScheduleTaskJsonPathProps.Builder endDate(Instant endDate)

Sets the value of EventBridgeSchedulerCreateScheduleTaskJsonPathProps.getEndDate()

Parameters:

endDate - The date, in UTC, before which the schedule can invoke its target. Depending on the schedule's recurrence expression, invocations might stop on, or before, the EndDate you specify. EventBridge Scheduler ignores EndDate for one-time schedules.

Returns:

this

flexibleTimeWindow

@Stability(Stable)
public EventBridgeSchedulerCreateScheduleTaskJsonPathProps.Builder flexibleTimeWindow(Duration flexibleTimeWindow)

Sets the value of EventBridgeSchedulerCreateScheduleTaskJsonPathProps.getFlexibleTimeWindow()

Parameters:

flexibleTimeWindow - The maximum time window during which a schedule can be invoked. Minimum value is 1 minute. Maximum value is 1440 minutes (1 day).

Returns:

this

groupName

@Stability(Stable)
public EventBridgeSchedulerCreateScheduleTaskJsonPathProps.Builder groupName(String groupName)

Sets the value of EventBridgeSchedulerCreateScheduleTaskJsonPathProps.getGroupName()

Parameters:

groupName - The name of the schedule group to associate with this schedule.

Returns:

this

kmsKey

@Stability(Stable)
public EventBridgeSchedulerCreateScheduleTaskJsonPathProps.Builder kmsKey(IKey kmsKey)

Sets the value of EventBridgeSchedulerCreateScheduleTaskJsonPathProps.getKmsKey()

Parameters:

kmsKey - The customer managed KMS key that EventBridge Scheduler will use to encrypt and decrypt payload.

Returns:

this

startDate

@Stability(Stable)
public EventBridgeSchedulerCreateScheduleTaskJsonPathProps.Builder startDate(Instant startDate)

Sets the value of EventBridgeSchedulerCreateScheduleTaskJsonPathProps.getStartDate()

Parameters:

startDate - The date, in UTC, after which the schedule can begin invoking its target. Depending on the schedule's recurrence expression, invocations might occur on, or after, the StartDate you specify. EventBridge Scheduler ignores StartDate for one-time schedules.

Returns:

this

timezone

@Stability(Stable)
public EventBridgeSchedulerCreateScheduleTaskJsonPathProps.Builder timezone(String timezone)

Sets the value of EventBridgeSchedulerCreateScheduleTaskJsonPathProps.getTimezone()

Parameters:

timezone - The timezone in which the scheduling expression is evaluated.

Returns:

this

resultPath

@Stability(Stable)
public EventBridgeSchedulerCreateScheduleTaskJsonPathProps.Builder resultPath(String resultPath)

Sets the value of TaskStateJsonPathBaseProps.getResultPath()

Parameters:

resultPath - JSONPath expression to indicate where to inject the state's output. May also be the special value JsonPath.DISCARD, which will cause the state's input to become its output.

Returns:

this

resultSelector

@Stability(Stable)
public EventBridgeSchedulerCreateScheduleTaskJsonPathProps.Builder resultSelector(Map<String,? extends Object> resultSelector)

Sets the value of TaskStateJsonPathBaseProps.getResultSelector()

Parameters:

resultSelector - The JSON that will replace the state's raw result and become the effective result before ResultPath is applied. You can use ResultSelector to create a payload with values that are static or selected from the state's raw result.

Returns:

this

comment

@Stability(Stable)
public EventBridgeSchedulerCreateScheduleTaskJsonPathProps.Builder comment(String comment)

Sets the value of StateBaseProps.getComment()

Parameters:

comment - A comment describing this state.

Returns:

this

queryLanguage

@Stability(Stable)
public EventBridgeSchedulerCreateScheduleTaskJsonPathProps.Builder queryLanguage(QueryLanguage queryLanguage)

Sets the value of StateBaseProps.getQueryLanguage()

Parameters:

queryLanguage - The name of the query language used by the state. If the state does not contain a queryLanguage field, then it will use the query language specified in the top-level queryLanguage field.

Returns:

this

stateName

@Stability(Stable)
public EventBridgeSchedulerCreateScheduleTaskJsonPathProps.Builder stateName(String stateName)

Sets the value of StateBaseProps.getStateName()

Parameters:

stateName - Optional name for this state.

Returns:

this

credentials

@Stability(Stable)
public EventBridgeSchedulerCreateScheduleTaskJsonPathProps.Builder credentials(Credentials credentials)

Sets the value of TaskStateBaseOptions.getCredentials()

Parameters:

credentials - Credentials for an IAM Role that the State Machine assumes for executing the task. This enables cross-account resource invocations.

Returns:

this

heartbeat

@Stability(Deprecated)
@Deprecated
public EventBridgeSchedulerCreateScheduleTaskJsonPathProps.Builder heartbeat(Duration heartbeat)

Deprecated.

use `heartbeatTimeout`

Sets the value of TaskStateBaseOptions.getHeartbeat()

Parameters:

heartbeat - Timeout for the heartbeat.

Returns:

this

heartbeatTimeout

@Stability(Stable)
public EventBridgeSchedulerCreateScheduleTaskJsonPathProps.Builder heartbeatTimeout(Timeout heartbeatTimeout)

Sets the value of TaskStateBaseOptions.getHeartbeatTimeout()

Parameters:

heartbeatTimeout - Timeout for the heartbeat. [disable-awslint:duration-prop-type] is needed because all props interface in aws-stepfunctions-tasks extend this interface

Returns:

this

integrationPattern

@Stability(Stable)
public EventBridgeSchedulerCreateScheduleTaskJsonPathProps.Builder integrationPattern(IntegrationPattern integrationPattern)

Sets the value of TaskStateBaseOptions.getIntegrationPattern()

Parameters:

integrationPattern - AWS Step Functions integrates with services directly in the Amazon States Language. You can control these AWS services using service integration patterns.

Depending on the AWS Service, the Service Integration Pattern availability will vary.

Returns:

this

taskTimeout

@Stability(Stable)
public EventBridgeSchedulerCreateScheduleTaskJsonPathProps.Builder taskTimeout(Timeout taskTimeout)

Sets the value of TaskStateBaseOptions.getTaskTimeout()

Parameters:

taskTimeout - Timeout for the task. [disable-awslint:duration-prop-type] is needed because all props interface in aws-stepfunctions-tasks extend this interface

Returns:

this

timeout

@Stability(Deprecated)
@Deprecated
public EventBridgeSchedulerCreateScheduleTaskJsonPathProps.Builder timeout(Duration timeout)

Deprecated.

use `taskTimeout`

Sets the value of TaskStateBaseOptions.getTimeout()

Parameters:

timeout - Timeout for the task.

Returns:

this

assign

@Stability(Stable)
public EventBridgeSchedulerCreateScheduleTaskJsonPathProps.Builder assign(Map<String,? extends Object> assign)

Sets the value of AssignableStateOptions.getAssign()

Parameters:

assign - Workflow variables to store in this step. Using workflow variables, you can store data in a step and retrieve that data in future steps.

Returns:

this

inputPath

@Stability(Stable)
public EventBridgeSchedulerCreateScheduleTaskJsonPathProps.Builder inputPath(String inputPath)

Sets the value of JsonPathCommonOptions.getInputPath()

Parameters:

inputPath - JSONPath expression to select part of the state to be the input to this state. May also be the special value JsonPath.DISCARD, which will cause the effective input to be the empty object {}.

Returns:

this

outputPath

@Stability(Stable)
public EventBridgeSchedulerCreateScheduleTaskJsonPathProps.Builder outputPath(String outputPath)

Sets the value of JsonPathCommonOptions.getOutputPath()

Parameters:

outputPath - JSONPath expression to select part of the state to be the output to this state. May also be the special value JsonPath.DISCARD, which will cause the effective output to be the empty object {}.

Returns:

this

build

@Stability(Stable)
public EventBridgeSchedulerCreateScheduleTaskJsonPathProps build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of EventBridgeSchedulerCreateScheduleTaskJsonPathProps

Throws:

NullPointerException - if any required attribute was not provided