Target (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.cloudwatchevents.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
```
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're 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, 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:

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.
`BatchParameters`	`getBatchParameters()` If the event target is an AWS Batch job, this contains the job definition, job name, and other parameters.
`EcsParameters`	`getEcsParameters()` Contains the Amazon ECS task definition and task count to be used if the event target is an Amazon ECS task.
`String`	`getId()` The ID of the target.
`String`	`getInput()` Valid JSON text passed to the target.
`String`	`getInputPath()` The value of the JSONPath that is used for extracting part of the matched event when passing it to the target.
`InputTransformer`	`getInputTransformer()` Settings to enable you to provide custom input to a target based on certain event data.
`KinesisParameters`	`getKinesisParameters()` The custom parameter that you can use to control the shard assignment when the target is a Kinesis data stream.
`String`	`getRoleArn()` The Amazon Resource Name (ARN) of the IAM role to be used for this target when the rule is triggered.
`RunCommandParameters`	`getRunCommandParameters()` Parameters used when you are using the rule to invoke Amazon EC2 Run Command.
`SqsParameters`	`getSqsParameters()` Contains the message group ID to use when the target is a FIFO queue.
`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`	`setBatchParameters(BatchParameters batchParameters)` If the event target is an AWS Batch job, this contains the job definition, job name, and other parameters.
`void`	`setEcsParameters(EcsParameters ecsParameters)` Contains the Amazon ECS task definition and task count to be used if the event target is an Amazon ECS task.
`void`	`setId(String id)` The ID of the target.
`void`	`setInput(String input)` Valid JSON text passed to the target.
`void`	`setInputPath(String inputPath)` The value of the JSONPath that is used for extracting part of the matched event when passing it to the target.
`void`	`setInputTransformer(InputTransformer inputTransformer)` Settings to enable you to provide custom input to a target based on certain event data.
`void`	`setKinesisParameters(KinesisParameters kinesisParameters)` The custom parameter that you can use to control the shard assignment when the target is a Kinesis data stream.
`void`	`setRoleArn(String roleArn)` The Amazon Resource Name (ARN) of the IAM role to be used for this target when the rule is triggered.
`void`	`setRunCommandParameters(RunCommandParameters runCommandParameters)` Parameters used when you are using the rule to invoke Amazon EC2 Run Command.
`void`	`setSqsParameters(SqsParameters sqsParameters)` Contains the message group ID to use when the target is a FIFO queue.
`String`	`toString()` Returns a string representation of this object.
`Target`	`withArn(String arn)` The Amazon Resource Name (ARN) of the target.
`Target`	`withBatchParameters(BatchParameters batchParameters)` If the event target is an AWS Batch job, this contains the job definition, job name, and other parameters.
`Target`	`withEcsParameters(EcsParameters ecsParameters)` Contains the Amazon ECS task definition and task count to be used if the event target is an Amazon ECS task.
`Target`	`withId(String id)` The ID of the target.
`Target`	`withInput(String input)` Valid JSON text passed to the target.
`Target`	`withInputPath(String inputPath)` The value of the JSONPath that is used for extracting part of the matched event when passing it to the target.
`Target`	`withInputTransformer(InputTransformer inputTransformer)` Settings to enable you to provide custom input to a target based on certain event data.
`Target`	`withKinesisParameters(KinesisParameters kinesisParameters)` The custom parameter that you can use to control the shard assignment when the target is a Kinesis data stream.
`Target`	`withRoleArn(String roleArn)` The Amazon Resource Name (ARN) of the IAM role to be used for this target when the rule is triggered.
`Target`	`withRunCommandParameters(RunCommandParameters runCommandParameters)` Parameters used when you are using the rule to invoke Amazon EC2 Run Command.
`Target`	`withSqsParameters(SqsParameters sqsParameters)` Contains the message group ID to use when the target is a FIFO queue.

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

- Constructor Detail
  - Target
```
public Target()
```
- Method Detail
  - setId
```
public void setId(String id)
```
    The ID of the target.
    
    Parameters:
    
    id - The ID of the target.
  - getId
```
public String getId()
```
    The ID of the target.
    
    Returns:
    
    The ID of the target.
  - withId
```
public Target withId(String id)
```
    The ID of the target.
    
    Parameters:
    
    id - The ID of the target.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - 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.
  - setRoleArn
```
public void setRoleArn(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.
    
    Parameters:
    
    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.
  - getRoleArn
```
public String getRoleArn()
```
    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.
  - withRoleArn
```
public Target withRoleArn(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setInput
```
public void setInput(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.
    
    Parameters:
    
    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.
  - getInput
```
public String getInput()
```
    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.
  - withInput
```
public Target withInput(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setInputPath
```
public void setInputPath(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.
    
    Parameters:
    
    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.
  - getInputPath
```
public String getInputPath()
```
    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.
  - withInputPath
```
public Target withInputPath(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setInputTransformer
```
public void setInputTransformer(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.
    
    Parameters:
    
    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.
  - getInputTransformer
```
public InputTransformer getInputTransformer()
```
    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.
  - withInputTransformer
```
public Target withInputTransformer(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setKinesisParameters
```
public void setKinesisParameters(KinesisParameters kinesisParameters)
```
    The custom parameter that you can use to control the shard assignment when the target is a Kinesis data stream. If you don't include this parameter, the default is to use the eventId as the partition key.
    
    Parameters:
    
    kinesisParameters - The custom parameter that you can use to control the shard assignment when the target is a Kinesis data stream. If you don't include this parameter, the default is to use the eventId as the partition key.
  - getKinesisParameters
```
public KinesisParameters getKinesisParameters()
```
    The custom parameter that you can use to control the shard assignment when the target is a Kinesis data stream. If you don't include this parameter, the default is to use the eventId as the partition key.
    
    Returns:
    
    The custom parameter that you can use to control the shard assignment when the target is a Kinesis data stream. If you don't include this parameter, the default is to use the eventId as the partition key.
  - withKinesisParameters
```
public Target withKinesisParameters(KinesisParameters kinesisParameters)
```
    The custom parameter that you can use to control the shard assignment when the target is a Kinesis data stream. If you don't include this parameter, the default is to use the eventId as the partition key.
    
    Parameters:
    
    kinesisParameters - The custom parameter that you can use to control the shard assignment when the target is a Kinesis data stream. If you don't include this parameter, the default is to use the eventId as the partition key.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setRunCommandParameters
```
public void setRunCommandParameters(RunCommandParameters runCommandParameters)
```
    Parameters used when you are using the rule to invoke Amazon EC2 Run Command.
    
    Parameters:
    
    runCommandParameters - Parameters used when you are using the rule to invoke Amazon EC2 Run Command.
  - getRunCommandParameters
```
public RunCommandParameters getRunCommandParameters()
```
    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.
  - withRunCommandParameters
```
public Target withRunCommandParameters(RunCommandParameters runCommandParameters)
```
    Parameters used when you are using the rule to invoke Amazon EC2 Run Command.
    
    Parameters:
    
    runCommandParameters - Parameters used when you are using the rule to invoke Amazon EC2 Run Command.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setEcsParameters
```
public void setEcsParameters(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.
    
    Parameters:
    
    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.
  - getEcsParameters
```
public EcsParameters getEcsParameters()
```
    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.
  - withEcsParameters
```
public Target withEcsParameters(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setBatchParameters
```
public void setBatchParameters(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.
    
    Parameters:
    
    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.
  - getBatchParameters
```
public BatchParameters getBatchParameters()
```
    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.
  - withBatchParameters
```
public Target withBatchParameters(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setSqsParameters
```
public void setSqsParameters(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.
    
    Parameters:
    
    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.
  - getSqsParameters
```
public SqsParameters getSqsParameters()
```
    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.
  - withSqsParameters
```
public Target withSqsParameters(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.
    
    Parameters:
    
    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:
    
    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

setId

getId

withId

setArn

getArn

withArn

setRoleArn

getRoleArn

withRoleArn

setInput

getInput

withInput

setInputPath

getInputPath

withInputPath

setInputTransformer

getInputTransformer

withInputTransformer

setKinesisParameters

getKinesisParameters

withKinesisParameters

setRunCommandParameters

getRunCommandParameters

withRunCommandParameters

setEcsParameters

getEcsParameters

withEcsParameters

setBatchParameters

getBatchParameters

withBatchParameters

setSqsParameters

getSqsParameters

withSqsParameters

toString

equals

hashCode

clone

marshall