Package software.amazon.awssdk.services.scheduler.model

Interface Target.Builder

All Superinterfaces:

Buildable, CopyableBuilder<Target.Builder,Target>, SdkBuilder<Target.Builder,Target>, SdkPojo

Enclosing class:

Target

public static interface Target.Builder
extends SdkPojo, CopyableBuilder<Target.Builder,Target>

Method Summary

Modifier and Type	Method	Description
Target.Builder	arn(String arn)	The Amazon Resource Name (ARN) of the target.
default Target.Builder	deadLetterConfig(Consumer<DeadLetterConfig.Builder> deadLetterConfig)	An object that contains information about an Amazon SQS queue that EventBridge Scheduler uses as a dead-letter queue for your schedule.
Target.Builder	deadLetterConfig(DeadLetterConfig deadLetterConfig)	An object that contains information about an Amazon SQS queue that EventBridge Scheduler uses as a dead-letter queue for your schedule.
default Target.Builder	ecsParameters(Consumer<EcsParameters.Builder> ecsParameters)	The templated target type for the Amazon ECS RunTask API operation.
Target.Builder	ecsParameters(EcsParameters ecsParameters)	The templated target type for the Amazon ECS RunTask API operation.
default Target.Builder	eventBridgeParameters(Consumer<EventBridgeParameters.Builder> eventBridgeParameters)	The templated target type for the EventBridge PutEvents API operation.
Target.Builder	eventBridgeParameters(EventBridgeParameters eventBridgeParameters)	The templated target type for the EventBridge PutEvents API operation.
Target.Builder	input(String input)	The text, or well-formed JSON, passed to the target.
default Target.Builder	kinesisParameters(Consumer<KinesisParameters.Builder> kinesisParameters)	The templated target type for the Amazon Kinesis PutRecord API operation.
Target.Builder	kinesisParameters(KinesisParameters kinesisParameters)	The templated target type for the Amazon Kinesis PutRecord API operation.
default Target.Builder	retryPolicy(Consumer<RetryPolicy.Builder> retryPolicy)	A RetryPolicy object that includes information about the retry policy settings, including the maximum age of an event, and the maximum number of times EventBridge Scheduler will try to deliver the event to a target.
Target.Builder	retryPolicy(RetryPolicy retryPolicy)	A RetryPolicy object that includes information about the retry policy settings, including the maximum age of an event, and the maximum number of times EventBridge Scheduler will try to deliver the event to a target.
Target.Builder	roleArn(String roleArn)	The Amazon Resource Name (ARN) of the IAM role that EventBridge Scheduler will use for this target when the schedule is invoked.
default Target.Builder	sageMakerPipelineParameters(Consumer<SageMakerPipelineParameters.Builder> sageMakerPipelineParameters)	The templated target type for the Amazon SageMaker StartPipelineExecution API operation.
Target.Builder	sageMakerPipelineParameters(SageMakerPipelineParameters sageMakerPipelineParameters)	The templated target type for the Amazon SageMaker StartPipelineExecution API operation.
default Target.Builder	sqsParameters(Consumer<SqsParameters.Builder> sqsParameters)	The templated target type for the Amazon SQS SendMessage API operation.
Target.Builder	sqsParameters(SqsParameters sqsParameters)	The templated target type for the Amazon SQS SendMessage API operation.

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Method Detail

arn

Target.Builder arn(String arn)

The Amazon Resource Name (ARN) of the target.

Parameters:

arn - The Amazon Resource Name (ARN) of the target.

Returns:

Returns a reference to this object so that method calls can be chained together.

deadLetterConfig

Target.Builder deadLetterConfig(DeadLetterConfig deadLetterConfig)

An object that contains information about an Amazon SQS queue that EventBridge Scheduler uses as a dead-letter queue for your schedule. If specified, EventBridge Scheduler delivers failed events that could not be successfully delivered to a target to the queue.

Parameters:

deadLetterConfig - An object that contains information about an Amazon SQS queue that EventBridge Scheduler uses as a dead-letter queue for your schedule. If specified, EventBridge Scheduler delivers failed events that could not be successfully delivered to a target to the queue.

Returns:

Returns a reference to this object so that method calls can be chained together.

deadLetterConfig

default Target.Builder deadLetterConfig(Consumer<DeadLetterConfig.Builder> deadLetterConfig)

An object that contains information about an Amazon SQS queue that EventBridge Scheduler uses as a dead-letter queue for your schedule. If specified, EventBridge Scheduler delivers failed events that could not be successfully delivered to a target to the queue.

This is a convenience method that creates an instance of the DeadLetterConfig.Builder avoiding the need to create one manually via DeadLetterConfig.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to deadLetterConfig(DeadLetterConfig).

Parameters:

deadLetterConfig - a consumer that will call methods on DeadLetterConfig.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

deadLetterConfig(DeadLetterConfig)

ecsParameters

Target.Builder ecsParameters(EcsParameters ecsParameters)

The templated target type for the Amazon ECS RunTask API operation.

Parameters:

ecsParameters - The templated target type for the Amazon ECS RunTask API operation.

Returns:

Returns a reference to this object so that method calls can be chained together.

ecsParameters

default Target.Builder ecsParameters(Consumer<EcsParameters.Builder> ecsParameters)

The templated target type for the Amazon ECS RunTask API operation.

This is a convenience method that creates an instance of the EcsParameters.Builder avoiding the need to create one manually via EcsParameters.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to ecsParameters(EcsParameters).

Parameters:

ecsParameters - a consumer that will call methods on EcsParameters.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ecsParameters(EcsParameters)

eventBridgeParameters

Target.Builder eventBridgeParameters(EventBridgeParameters eventBridgeParameters)

The templated target type for the EventBridge PutEvents API operation.

Parameters:

eventBridgeParameters - The templated target type for the EventBridge PutEvents API operation.

Returns:

Returns a reference to this object so that method calls can be chained together.

eventBridgeParameters

default Target.Builder eventBridgeParameters(Consumer<EventBridgeParameters.Builder> eventBridgeParameters)

The templated target type for the EventBridge PutEvents API operation.

This is a convenience method that creates an instance of the EventBridgeParameters.Builder avoiding the need to create one manually via EventBridgeParameters.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to eventBridgeParameters(EventBridgeParameters).

Parameters:

eventBridgeParameters - a consumer that will call methods on EventBridgeParameters.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

eventBridgeParameters(EventBridgeParameters)

input

Target.Builder input(String input)

The text, or well-formed JSON, passed to the target. If you are configuring a templated Lambda, AWS Step Functions, or Amazon EventBridge target, the input must be a well-formed JSON. For all other target types, a JSON is not required. If you do not specify anything for this field, EventBridge Scheduler delivers a default notification to the target.

Parameters:

input - The text, or well-formed JSON, passed to the target. If you are configuring a templated Lambda, AWS Step Functions, or Amazon EventBridge target, the input must be a well-formed JSON. For all other target types, a JSON is not required. If you do not specify anything for this field, EventBridge Scheduler delivers a default notification to the target.

Returns:

Returns a reference to this object so that method calls can be chained together.

kinesisParameters

Target.Builder kinesisParameters(KinesisParameters kinesisParameters)

The templated target type for the Amazon Kinesis PutRecord API operation.

Parameters:

kinesisParameters - The templated target type for the Amazon Kinesis PutRecord API operation.

Returns:

Returns a reference to this object so that method calls can be chained together.

kinesisParameters

default Target.Builder kinesisParameters(Consumer<KinesisParameters.Builder> kinesisParameters)

The templated target type for the Amazon Kinesis PutRecord API operation.

This is a convenience method that creates an instance of the KinesisParameters.Builder avoiding the need to create one manually via KinesisParameters.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to kinesisParameters(KinesisParameters).

Parameters:

kinesisParameters - a consumer that will call methods on KinesisParameters.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

kinesisParameters(KinesisParameters)

retryPolicy

Target.Builder retryPolicy(RetryPolicy retryPolicy)

A RetryPolicy object that includes information about the retry policy settings, including the maximum age of an event, and the maximum number of times EventBridge Scheduler will try to deliver the event to a target.

Parameters:

retryPolicy - A RetryPolicy object that includes information about the retry policy settings, including the maximum age of an event, and the maximum number of times EventBridge Scheduler will try to deliver the event to a target.

Returns:

Returns a reference to this object so that method calls can be chained together.

retryPolicy

default Target.Builder retryPolicy(Consumer<RetryPolicy.Builder> retryPolicy)

A RetryPolicy object that includes information about the retry policy settings, including the maximum age of an event, and the maximum number of times EventBridge Scheduler will try to deliver the event to a target.

This is a convenience method that creates an instance of the RetryPolicy.Builder avoiding the need to create one manually via RetryPolicy.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to retryPolicy(RetryPolicy).

Parameters:

retryPolicy - a consumer that will call methods on RetryPolicy.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

retryPolicy(RetryPolicy)

roleArn

Target.Builder roleArn(String roleArn)

The Amazon Resource Name (ARN) of the IAM role that EventBridge Scheduler will use for this target when the schedule is invoked.

Parameters:

roleArn - The Amazon Resource Name (ARN) of the IAM role that EventBridge Scheduler will use for this target when the schedule is invoked.

Returns:

Returns a reference to this object so that method calls can be chained together.

sageMakerPipelineParameters

Target.Builder sageMakerPipelineParameters(SageMakerPipelineParameters sageMakerPipelineParameters)

The templated target type for the Amazon SageMaker StartPipelineExecution API operation.

Parameters:

sageMakerPipelineParameters - The templated target type for the Amazon SageMaker StartPipelineExecution API operation.

Returns:

Returns a reference to this object so that method calls can be chained together.

sageMakerPipelineParameters

default Target.Builder sageMakerPipelineParameters(Consumer<SageMakerPipelineParameters.Builder> sageMakerPipelineParameters)

The templated target type for the Amazon SageMaker StartPipelineExecution API operation.

This is a convenience method that creates an instance of the SageMakerPipelineParameters.Builder avoiding the need to create one manually via SageMakerPipelineParameters.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to sageMakerPipelineParameters(SageMakerPipelineParameters).

Parameters:

sageMakerPipelineParameters - a consumer that will call methods on SageMakerPipelineParameters.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

sageMakerPipelineParameters(SageMakerPipelineParameters)

sqsParameters

Target.Builder sqsParameters(SqsParameters sqsParameters)

The templated target type for the Amazon SQS SendMessage API operation. Contains the message group ID to use when the target is a FIFO queue. If you specify an Amazon SQS FIFO queue as a target, the queue must have content-based deduplication enabled. For more information, see Using the Amazon SQS message deduplication ID in the Amazon SQS Developer Guide.

Parameters:

sqsParameters - The templated target type for the Amazon SQS SendMessage API operation. Contains the message group ID to use when the target is a FIFO queue. If you specify an Amazon SQS FIFO queue as a target, the queue must have content-based deduplication enabled. For more information, see Using the Amazon SQS message deduplication ID in the Amazon SQS Developer Guide.

Returns:

Returns a reference to this object so that method calls can be chained together.

sqsParameters

default Target.Builder sqsParameters(Consumer<SqsParameters.Builder> sqsParameters)

The templated target type for the Amazon SQS SendMessage API operation. Contains the message group ID to use when the target is a FIFO queue. If you specify an Amazon SQS FIFO queue as a target, the queue must have content-based deduplication enabled. For more information, see Using the Amazon SQS message deduplication ID in the Amazon SQS Developer Guide.

This is a convenience method that creates an instance of the SqsParameters.Builder avoiding the need to create one manually via SqsParameters.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to sqsParameters(SqsParameters).

Parameters:

sqsParameters - a consumer that will call methods on SqsParameters.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

sqsParameters(SqsParameters)