Target (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.scheduler.model.Target

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class Target
extends Object
implements Serializable, Cloneable, StructuredPojo
```
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:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

Target()

Constructors
Constructor and Description
`Target()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Target`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getArn()` The Amazon Resource Name (ARN) of the target.
`DeadLetterConfig`	`getDeadLetterConfig()` An object that contains information about an Amazon SQS queue that EventBridge Scheduler uses as a dead-letter queue for your schedule.
`EcsParameters`	`getEcsParameters()` The templated target type for the Amazon ECS `RunTask` API operation.
`EventBridgeParameters`	`getEventBridgeParameters()` The templated target type for the EventBridge `PutEvents` API operation.
`String`	`getInput()` The text, or well-formed JSON, passed to the target.
`KinesisParameters`	`getKinesisParameters()` The templated target type for the Amazon Kinesis `PutRecord` API operation.
`RetryPolicy`	`getRetryPolicy()` 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`	`getRoleArn()` The Amazon Resource Name (ARN) of the IAM role that EventBridge Scheduler will use for this target when the schedule is invoked.
`SageMakerPipelineParameters`	`getSageMakerPipelineParameters()` The templated target type for the Amazon SageMaker `StartPipelineExecution` API operation.
`SqsParameters`	`getSqsParameters()` The templated target type for the Amazon SQS `SendMessage` API operation.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setArn(String arn)` The Amazon Resource Name (ARN) of the target.
`void`	`setDeadLetterConfig(DeadLetterConfig deadLetterConfig)` An object that contains information about an Amazon SQS queue that EventBridge Scheduler uses as a dead-letter queue for your schedule.
`void`	`setEcsParameters(EcsParameters ecsParameters)` The templated target type for the Amazon ECS `RunTask` API operation.
`void`	`setEventBridgeParameters(EventBridgeParameters eventBridgeParameters)` The templated target type for the EventBridge `PutEvents` API operation.
`void`	`setInput(String input)` The text, or well-formed JSON, passed to the target.
`void`	`setKinesisParameters(KinesisParameters kinesisParameters)` The templated target type for the Amazon Kinesis `PutRecord` API operation.
`void`	`setRetryPolicy(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.
`void`	`setRoleArn(String roleArn)` The Amazon Resource Name (ARN) of the IAM role that EventBridge Scheduler will use for this target when the schedule is invoked.
`void`	`setSageMakerPipelineParameters(SageMakerPipelineParameters sageMakerPipelineParameters)` The templated target type for the Amazon SageMaker `StartPipelineExecution` API operation.
`void`	`setSqsParameters(SqsParameters sqsParameters)` The templated target type for the Amazon SQS `SendMessage` API operation.
`String`	`toString()` Returns a string representation of this object.
`Target`	`withArn(String arn)` The Amazon Resource Name (ARN) of the target.
`Target`	`withDeadLetterConfig(DeadLetterConfig deadLetterConfig)` An object that contains information about an Amazon SQS queue that EventBridge Scheduler uses as a dead-letter queue for your schedule.
`Target`	`withEcsParameters(EcsParameters ecsParameters)` The templated target type for the Amazon ECS `RunTask` API operation.
`Target`	`withEventBridgeParameters(EventBridgeParameters eventBridgeParameters)` The templated target type for the EventBridge `PutEvents` API operation.
`Target`	`withInput(String input)` The text, or well-formed JSON, passed to the target.
`Target`	`withKinesisParameters(KinesisParameters kinesisParameters)` The templated target type for the Amazon Kinesis `PutRecord` API operation.
`Target`	`withRetryPolicy(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`	`withRoleArn(String roleArn)` The Amazon Resource Name (ARN) of the IAM role that EventBridge Scheduler will use for this target when the schedule is invoked.
`Target`	`withSageMakerPipelineParameters(SageMakerPipelineParameters sageMakerPipelineParameters)` The templated target type for the Amazon SageMaker `StartPipelineExecution` API operation.
`Target`	`withSqsParameters(SqsParameters sqsParameters)` The templated target type for the Amazon SQS `SendMessage` API operation.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - Target
```
public Target()
```
- Method Detail
  - setArn
```
public void setArn(String arn)
```
    The Amazon Resource Name (ARN) of the target.
    
    Parameters:
    
    arn - The Amazon Resource Name (ARN) of the target.
  - getArn
```
public String getArn()
```
    The Amazon Resource Name (ARN) of the target.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the target.
  - withArn
```
public Target withArn(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.
  - setDeadLetterConfig
```
public void setDeadLetterConfig(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.
  - getDeadLetterConfig
```
public DeadLetterConfig getDeadLetterConfig()
```
    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.
  - withDeadLetterConfig
```
public Target withDeadLetterConfig(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.
  - setEcsParameters
```
public void setEcsParameters(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.
  - getEcsParameters
```
public EcsParameters getEcsParameters()
```
    The templated target type for the Amazon ECS RunTask API operation.
    
    Returns:
    
    The templated target type for the Amazon ECS RunTask API operation.
  - withEcsParameters
```
public Target withEcsParameters(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.
  - setEventBridgeParameters
```
public void setEventBridgeParameters(EventBridgeParameters eventBridgeParameters)
```
    The templated target type for the EventBridge PutEvents API operation.
    
    Parameters:
    
    eventBridgeParameters - The templated target type for the EventBridge PutEvents API operation.
  - getEventBridgeParameters
```
public EventBridgeParameters getEventBridgeParameters()
```
    The templated target type for the EventBridge PutEvents API operation.
    
    Returns:
    
    The templated target type for the EventBridge PutEvents API operation.
  - withEventBridgeParameters
```
public Target withEventBridgeParameters(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.
  - setInput
```
public void setInput(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.
  - getInput
```
public String getInput()
```
    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.
  - withInput
```
public Target withInput(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.
  - setKinesisParameters
```
public void setKinesisParameters(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.
  - getKinesisParameters
```
public KinesisParameters getKinesisParameters()
```
    The templated target type for the Amazon Kinesis PutRecord API operation.
    
    Returns:
    
    The templated target type for the Amazon Kinesis PutRecord API operation.
  - withKinesisParameters
```
public Target withKinesisParameters(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.
  - setRetryPolicy
```
public void setRetryPolicy(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.
  - getRetryPolicy
```
public RetryPolicy getRetryPolicy()
```
    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.
  - withRetryPolicy
```
public Target withRetryPolicy(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.
  - setRoleArn
```
public void setRoleArn(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.
  - getRoleArn
```
public String getRoleArn()
```
    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.
  - withRoleArn
```
public Target withRoleArn(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.
  - setSageMakerPipelineParameters
```
public void setSageMakerPipelineParameters(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.
  - getSageMakerPipelineParameters
```
public SageMakerPipelineParameters getSageMakerPipelineParameters()
```
    The templated target type for the Amazon SageMaker StartPipelineExecution API operation.
    
    Returns:
    
    The templated target type for the Amazon SageMaker StartPipelineExecution API operation.
  - withSageMakerPipelineParameters
```
public Target withSageMakerPipelineParameters(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.
  - setSqsParameters
```
public void setSqsParameters(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.
  - getSqsParameters
```
public SqsParameters getSqsParameters()
```
    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.
  - withSqsParameters
```
public Target withSqsParameters(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.
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public Target clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Did this page help you?

Class Target

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Target

Method Detail

setArn

getArn

withArn

setDeadLetterConfig

getDeadLetterConfig

withDeadLetterConfig

setEcsParameters

getEcsParameters

withEcsParameters

setEventBridgeParameters

getEventBridgeParameters

withEventBridgeParameters

setInput

getInput

withInput

setKinesisParameters

getKinesisParameters

withKinesisParameters

setRetryPolicy

getRetryPolicy

withRetryPolicy

setRoleArn

getRoleArn

withRoleArn

setSageMakerPipelineParameters

getSageMakerPipelineParameters

withSageMakerPipelineParameters

setSqsParameters

getSqsParameters

withSqsParameters

toString

equals

hashCode

clone

marshall