java.lang.Object
- software.amazon.awssdk.services.eventbridge.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>
```
Targets are the resources to be invoked when a rule is triggered. For a complete list of services and resources that can be set as a target, see PutTargets.

If you are setting the event bus of another account as the target, and that account granted permission to your account through an organization instead of directly by the account ID, then you must specify a RoleArn with proper permissions in the Target structure. For more information, see Sending and Receiving Events Between Amazon Web Services Accounts in the Amazon EventBridge User Guide.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface Target.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`AppSyncParameters`	`appSyncParameters()`	Contains the GraphQL operation to be parsed and executed, if the event target is an AppSync API.
`String`	`arn()`	The Amazon Resource Name (ARN) of the target.
`BatchParameters`	`batchParameters()`	If the event target is an Batch job, this contains the job definition, job name, and other parameters.
`static Target.Builder`	`builder()`
`DeadLetterConfig`	`deadLetterConfig()`	The `DeadLetterConfig` that defines the target queue to send dead-letter queue events to.
`EcsParameters`	`ecsParameters()`	Contains the Amazon ECS task definition and task count to be used, if the event target is an Amazon ECS task.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`HttpParameters`	`httpParameters()`	Contains the HTTP parameters to use when the target is a API Gateway endpoint or EventBridge ApiDestination.
`String`	`id()`	The ID of the target within the specified rule.
`String`	`input()`	Valid JSON text passed to the target.
`String`	`inputPath()`	The value of the JSONPath that is used for extracting part of the matched event when passing it to the target.
`InputTransformer`	`inputTransformer()`	Settings to enable you to provide custom input to a target based on certain event data.
`KinesisParameters`	`kinesisParameters()`	The custom parameter you can use to control the shard assignment, when the target is a Kinesis data stream.
`RedshiftDataParameters`	`redshiftDataParameters()`	Contains the Amazon Redshift Data API parameters to use when the target is a Amazon Redshift cluster.
`RetryPolicy`	`retryPolicy()`	The `RetryPolicy` object that contains the retry policy configuration to use for the dead-letter queue.
`String`	`roleArn()`	The Amazon Resource Name (ARN) of the IAM role to be used for this target when the rule is triggered.
`RunCommandParameters`	`runCommandParameters()`	Parameters used when you are using the rule to invoke Amazon EC2 Run Command.
`SageMakerPipelineParameters`	`sageMakerPipelineParameters()`	Contains the SageMaker Model Building Pipeline parameters to start execution of a SageMaker Model Building Pipeline.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends Target.Builder>`	`serializableBuilderClass()`
`SqsParameters`	`sqsParameters()`	Contains the message group ID to use when the target is a FIFO queue.
`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
  - id
```
public final String id()
```
    The ID of the target within the specified rule. Use this ID to reference the target when updating the rule. We recommend using a memorable and unique string.
    
    Returns:
    
    The ID of the target within the specified rule. Use this ID to reference the target when updating the rule. We recommend using a memorable and unique string.
  - arn
```
public final String arn()
```
    The Amazon Resource Name (ARN) of the target.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the target.
  - roleArn
```
public final String roleArn()
```
    The Amazon Resource Name (ARN) of the IAM role to be used for this target when the rule is triggered. If one rule triggers multiple targets, you can use a different IAM role for each target.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the IAM role to be used for this target when the rule is triggered. If one rule triggers multiple targets, you can use a different IAM role for each target.
  - input
```
public final String input()
```
    Valid JSON text passed to the target. In this case, nothing from the event itself is passed to the target. For more information, see The JavaScript Object Notation (JSON) Data Interchange Format.
    
    Returns:
    
    Valid JSON text passed to the target. In this case, nothing from the event itself is passed to the target. For more information, see The JavaScript Object Notation (JSON) Data Interchange Format.
  - inputPath
```
public final String inputPath()
```
    The value of the JSONPath that is used for extracting part of the matched event when passing it to the target. You may use JSON dot notation or bracket notation. For more information about JSON paths, see JSONPath.
    
    Returns:
    
    The value of the JSONPath that is used for extracting part of the matched event when passing it to the target. You may use JSON dot notation or bracket notation. For more information about JSON paths, see JSONPath.
  - inputTransformer
```
public final InputTransformer inputTransformer()
```
    Settings to enable you to provide custom input to a target based on certain event data. You can extract one or more key-value pairs from the event and then use that data to send customized input to the target.
    
    Returns:
    
    Settings to enable you to provide custom input to a target based on certain event data. You can extract one or more key-value pairs from the event and then use that data to send customized input to the target.
  - kinesisParameters
```
public final KinesisParameters kinesisParameters()
```
    The custom parameter you can use to control the shard assignment, when the target is a Kinesis data stream. If you do not include this parameter, the default is to use the eventId as the partition key.
    
    Returns:
    
    The custom parameter you can use to control the shard assignment, when the target is a Kinesis data stream. If you do not include this parameter, the default is to use the eventId as the partition key.
  - runCommandParameters
```
public final RunCommandParameters runCommandParameters()
```
    Parameters used when you are using the rule to invoke Amazon EC2 Run Command.
    
    Returns:
    
    Parameters used when you are using the rule to invoke Amazon EC2 Run Command.
  - ecsParameters
```
public final EcsParameters ecsParameters()
```
    Contains the Amazon ECS task definition and task count to be used, if the event target is an Amazon ECS task. For more information about Amazon ECS tasks, see Task Definitions in the Amazon EC2 Container Service Developer Guide.
    
    Returns:
    
    Contains the Amazon ECS task definition and task count to be used, if the event target is an Amazon ECS task. For more information about Amazon ECS tasks, see Task Definitions in the Amazon EC2 Container Service Developer Guide.
  - batchParameters
```
public final BatchParameters batchParameters()
```
    If the event target is an Batch job, this contains the job definition, job name, and other parameters. For more information, see Jobs in the Batch User Guide.
    
    Returns:
    
    If the event target is an Batch job, this contains the job definition, job name, and other parameters. For more information, see Jobs in the Batch User Guide.
  - sqsParameters
```
public final SqsParameters sqsParameters()
```
    Contains the message group ID to use when the target is a FIFO queue.
    
    If you specify an SQS FIFO queue as a target, the queue must have content-based deduplication enabled.
    
    Returns:
    
    Contains the message group ID to use when the target is a FIFO queue.
    
    If you specify an SQS FIFO queue as a target, the queue must have content-based deduplication enabled.
  - httpParameters
```
public final HttpParameters httpParameters()
```
    Contains the HTTP parameters to use when the target is a API Gateway endpoint or EventBridge ApiDestination.
    
    If you specify an API Gateway API or EventBridge ApiDestination as a target, you can use this parameter to specify headers, path parameters, and query string keys/values as part of your target invoking request. If you're using ApiDestinations, the corresponding Connection can also have these values configured. In case of any conflicting keys, values from the Connection take precedence.
    
    Returns:
    
    Contains the HTTP parameters to use when the target is a API Gateway endpoint or EventBridge ApiDestination.
    
    If you specify an API Gateway API or EventBridge ApiDestination as a target, you can use this parameter to specify headers, path parameters, and query string keys/values as part of your target invoking request. If you're using ApiDestinations, the corresponding Connection can also have these values configured. In case of any conflicting keys, values from the Connection take precedence.
  - redshiftDataParameters
```
public final RedshiftDataParameters redshiftDataParameters()
```
    Contains the Amazon Redshift Data API parameters to use when the target is a Amazon Redshift cluster.
    
    If you specify a Amazon Redshift Cluster as a Target, you can use this to specify parameters to invoke the Amazon Redshift Data API ExecuteStatement based on EventBridge events.
    
    Returns:
    
    Contains the Amazon Redshift Data API parameters to use when the target is a Amazon Redshift cluster.
    
    If you specify a Amazon Redshift Cluster as a Target, you can use this to specify parameters to invoke the Amazon Redshift Data API ExecuteStatement based on EventBridge events.
  - sageMakerPipelineParameters
```
public final SageMakerPipelineParameters sageMakerPipelineParameters()
```
    Contains the SageMaker Model Building Pipeline parameters to start execution of a SageMaker Model Building Pipeline.
    
    If you specify a SageMaker Model Building Pipeline as a target, you can use this to specify parameters to start a pipeline execution based on EventBridge events.
    
    Returns:
    
    Contains the SageMaker Model Building Pipeline parameters to start execution of a SageMaker Model Building Pipeline.
    
    If you specify a SageMaker Model Building Pipeline as a target, you can use this to specify parameters to start a pipeline execution based on EventBridge events.
  - deadLetterConfig
```
public final DeadLetterConfig deadLetterConfig()
```
    The DeadLetterConfig that defines the target queue to send dead-letter queue events to.
    
    Returns:
    
    The DeadLetterConfig that defines the target queue to send dead-letter queue events to.
  - retryPolicy
```
public final RetryPolicy retryPolicy()
```
    The RetryPolicy object that contains the retry policy configuration to use for the dead-letter queue.
    
    Returns:
    
    The RetryPolicy object that contains the retry policy configuration to use for the dead-letter queue.
  - appSyncParameters
```
public final AppSyncParameters appSyncParameters()
```
    Contains the GraphQL operation to be parsed and executed, if the event target is an AppSync API.
    
    Returns:
    
    Contains the GraphQL operation to be parsed and executed, if the event target is an AppSync API.
  - 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

Class Target

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

id

arn

roleArn

input

inputPath

inputTransformer

kinesisParameters

runCommandParameters

ecsParameters

batchParameters

sqsParameters

httpParameters

redshiftDataParameters

sageMakerPipelineParameters

deadLetterConfig

retryPolicy

appSyncParameters

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields