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

Class EventBridgeSchedulerTarget.Builder

java.lang.Object

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

All Implemented Interfaces:

software.amazon.jsii.Builder<EventBridgeSchedulerTarget>

Enclosing class:

EventBridgeSchedulerTarget

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

A fluent builder for EventBridgeSchedulerTarget.

Method Summary

Modifier and Type	Method	Description
EventBridgeSchedulerTarget.Builder	arn(String arn)	The Amazon Resource Name (ARN) of the target.
EventBridgeSchedulerTarget	build()
static EventBridgeSchedulerTarget.Builder	create()
EventBridgeSchedulerTarget.Builder	deadLetterQueue(IQueue deadLetterQueue)	Dead letter queue for failed events.
EventBridgeSchedulerTarget.Builder	input(String input)	The input to the target.
EventBridgeSchedulerTarget.Builder	retryPolicy(RetryPolicy retryPolicy)	The retry policy settings.
EventBridgeSchedulerTarget.Builder	role(IRole role)	The IAM role that EventBridge Scheduler will use for this target when the schedule is invoked.

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 EventBridgeSchedulerTarget.Builder create()

Returns:

a new instance of EventBridgeSchedulerTarget.Builder.

arn

@Stability(Stable)
public EventBridgeSchedulerTarget.Builder arn(String arn)

The Amazon Resource Name (ARN) of the target.

Parameters:

arn - The Amazon Resource Name (ARN) of the target. This parameter is required.

Returns:

this

See Also:

• https://docs.aws.amazon.com/scheduler/latest/UserGuide/managing-targets.html

role

@Stability(Stable)
public EventBridgeSchedulerTarget.Builder role(IRole role)

The IAM role that EventBridge Scheduler will use for this target when the schedule is invoked.

Parameters:

role - The IAM role that EventBridge Scheduler will use for this target when the schedule is invoked. This parameter is required.

Returns:

this

deadLetterQueue

@Stability(Stable)
public EventBridgeSchedulerTarget.Builder deadLetterQueue(IQueue deadLetterQueue)

Dead letter queue for failed events.

Default: - No dead letter queue

Parameters:

deadLetterQueue - Dead letter queue for failed events. This parameter is required.

Returns:

this

input

@Stability(Stable)
public EventBridgeSchedulerTarget.Builder input(String input)

The input to the target.

Default: - EventBridge Scheduler delivers a default notification to the target

Parameters:

input - The input to the target. This parameter is required.

Returns:

this

retryPolicy

@Stability(Stable)
public EventBridgeSchedulerTarget.Builder retryPolicy(RetryPolicy retryPolicy)

The retry policy settings.

Default: - Do not retry

Parameters:

retryPolicy - The retry policy settings. This parameter is required.

Returns:

this

build

@Stability(Stable)
public EventBridgeSchedulerTarget build()

Specified by:

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

Returns:

a newly built instance of EventBridgeSchedulerTarget.