Target

class 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.

Types

Link copied to clipboard
class Builder
Link copied to clipboard
object Companion

Properties

Link copied to clipboard
val arn: String

The Amazon Resource Name (ARN) of the target.

Link copied to clipboard

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.

Link copied to clipboard

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

Link copied to clipboard

The templated target type for the EventBridge PutEvents API operation.

Link copied to clipboard

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.

Link copied to clipboard

The templated target type for the Amazon Kinesis PutRecordkinesis/latest/APIReference/API_PutRecord.html API operation.

Link copied to clipboard

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.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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.

Functions

Link copied to clipboard
inline fun copy(block: Target.Builder.() -> Unit = {}): Target
Link copied to clipboard
open operator override fun equals(other: Any?): Boolean
Link copied to clipboard
open override fun hashCode(): Int
Link copied to clipboard
open override fun toString(): String