Target (AWS Java SDK :: Services :: Amazon CloudWatch Events 2.15.45 API)

java.lang.Object
- software.amazon.awssdk.services.cloudwatchevents.model.Target

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<Target.Builder,Target>
```
@Generated(value="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 AWS Accounts in the Amazon EventBridge User Guide.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface Target.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`Target.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`arn()` The Amazon Resource Name (ARN) of the target.
`BatchParameters`	`batchParameters()` If the event target is an AWS 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 REST endpoint.
`String`	`id()` The ID of the target.
`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 Redshift Data API parameters to use when the target is a 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.
`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 String id()
```
    The ID of the target.
    
    Returns:
    
    The ID of the target.
  - arn
```
public String arn()
```
    The Amazon Resource Name (ARN) of the target.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the target.
  - roleArn
```
public 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 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 String inputPath()
```
    The value of the JSONPath that is used for extracting part of the matched event when passing it to the target. You must use JSON dot notation, not 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 must use JSON dot notation, not bracket notation. For more information about JSON paths, see JSONPath.
  - inputTransformer
```
public 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 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 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 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 BatchParameters batchParameters()
```
    If the event target is an AWS Batch job, this contains the job definition, job name, and other parameters. For more information, see Jobs in the AWS Batch User Guide.
    
    Returns:
    
    If the event target is an AWS Batch job, this contains the job definition, job name, and other parameters. For more information, see Jobs in the AWS Batch User Guide.
  - sqsParameters
```
public 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 HttpParameters httpParameters()
```
    Contains the HTTP parameters to use when the target is a API Gateway REST endpoint.
    
    If you specify an API Gateway REST API as a target, you can use this parameter to specify headers, path parameter, query string keys/values as part of your target invoking request.
    
    Returns:
    
    Contains the HTTP parameters to use when the target is a API Gateway REST endpoint.
    
    If you specify an API Gateway REST API as a target, you can use this parameter to specify headers, path parameter, query string keys/values as part of your target invoking request.
  - redshiftDataParameters
```
public RedshiftDataParameters redshiftDataParameters()
```
    Contains the Redshift Data API parameters to use when the target is a Redshift cluster.
    
    If you specify a Redshift Cluster as a Target, you can use this to specify parameters to invoke the Redshift Data API ExecuteStatement based on EventBridge events.
    
    Returns:
    
    Contains the Redshift Data API parameters to use when the target is a Redshift cluster.
    
    If you specify a Redshift Cluster as a Target, you can use this to specify parameters to invoke the Redshift Data API ExecuteStatement based on EventBridge events.
  - deadLetterConfig
```
public 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 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.
  - 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 int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - equalsBySdkFields
```
public boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - 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
  - getValueForField
```
public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)
```
  - sdkFields
```
public 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

deadLetterConfig

retryPolicy

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields