Target (AWS SDK for Java - 2.0.0-preview-11)

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

All Implemented Interfaces:

StructuredPojo, ToCopyableBuilder<Target.Builder,Target>
```
@Generated(value="software.amazon.awssdk:codegen")
public final class Target
extends Object
implements StructuredPojo, ToCopyableBuilder<Target.Builder,Target>
```
Targets are the resources to be invoked when a rule is triggered. Target types include EC2 instances, AWS Lambda functions, Amazon Kinesis streams, Amazon ECS tasks, AWS Step Functions state machines, Run Command, and built-in targets.

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.
`static Target.Builder`	`builder()`
`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)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`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 shard assignment, when the target is an Amazon Kinesis stream.
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`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.
`static Class<? extends Target.Builder>`	`serializableBuilderClass()`
`Target.Builder`	`toBuilder()` Take this object and create a builder that contains all of the current property values of this object.
`String`	`toString()`

Methods inherited from class java.lang.Object
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. You must use JSON dot notation, not bracket notation. 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. You must use JSON dot notation, not bracket notation. 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 shard assignment, when the target is an Amazon Kinesis 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 shard assignment, when the target is an Amazon Kinesis 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.
  - toBuilder
```
public Target.Builder toBuilder()
```
    Description copied from interface: ToCopyableBuilder
    
    Take this object and create a builder that contains all of the current property values of this object.
    
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<Target.Builder,Target>
    
    Returns:
    
    a builder for type T
  - 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
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getValueForField
```
public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)
```
  - 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.

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

toBuilder

builder

serializableBuilderClass

hashCode

equals

toString

getValueForField

marshall