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

Class Target

java.lang.Object

software.amazon.awssdk.services.scheduler.model.Target

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<Target.Builder,Target>

@Generated("software.amazon.awssdk:codegen")
public final class Target
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<Target.Builder,Target>

The schedule's target. EventBridge Scheduler supports templated target that invoke common API operations, as well as universal targets that you can customize to invoke over 6,000 API operations across more than 270 services. You can only specify one templated or universal target for a schedule.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	Target.Builder

Method Summary

Modifier and Type	Method	Description
String	arn()	The Amazon Resource Name (ARN) of the target.
static Target.Builder	builder()
DeadLetterConfig	deadLetterConfig()	An object that contains information about an Amazon SQS queue that EventBridge Scheduler uses as a dead-letter queue for your schedule.
EcsParameters	ecsParameters()	The templated target type for the Amazon ECS RunTask API operation.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
EventBridgeParameters	eventBridgeParameters()	The templated target type for the EventBridge PutEvents API operation.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	input()	The text, or well-formed JSON, passed to the target.
KinesisParameters	kinesisParameters()	The templated target type for the Amazon Kinesis PutRecord API operation.
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.
String	roleArn()	The Amazon Resource Name (ARN) of the IAM role that EventBridge Scheduler will use for this target when the schedule is invoked.
SageMakerPipelineParameters	sageMakerPipelineParameters()	The templated target type for the Amazon SageMaker StartPipelineExecution API operation.
List<SdkField<?>>	sdkFields()
static Class<? extends Target.Builder>	serializableBuilderClass()
SqsParameters	sqsParameters()	The templated target type for the Amazon SQS SendMessage API operation.
Target.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

arn

public final String arn()

The Amazon Resource Name (ARN) of the target.

Returns:

The Amazon Resource Name (ARN) of the target.

deadLetterConfig

public final 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.

Returns:

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.

ecsParameters

public final EcsParameters ecsParameters()

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

Returns:

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

eventBridgeParameters

public final EventBridgeParameters eventBridgeParameters()

The templated target type for the EventBridge PutEvents API operation.

Returns:

The templated target type for the EventBridge PutEvents API operation.

input

public final 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.

Returns:

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.

kinesisParameters

public final KinesisParameters kinesisParameters()

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

Returns:

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

retryPolicy

public final 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.

Returns:

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.

roleArn

public final String roleArn()

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

Returns:

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

sageMakerPipelineParameters

public final SageMakerPipelineParameters sageMakerPipelineParameters()

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

Returns:

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

sqsParameters

public final 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.

Returns:

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.

toBuilder

public Target.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<Target.Builder,Target>

builder

public static Target.Builder builder()

serializableBuilderClass

public static Class<? extends Target.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo