Target.Builder (AWS Java SDK :: Services :: EventBridge 2.17.202 API)

All Superinterfaces:

Buildable, CopyableBuilder<Target.Builder,Target>, SdkBuilder<Target.Builder,Target>, SdkPojo

Enclosing class:

Target
```
public static interface Target.Builder
extends SdkPojo, CopyableBuilder<Target.Builder,Target>
```

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`Target.Builder`	`arn(String arn)` The Amazon Resource Name (ARN) of the target.
`Target.Builder`	`batchParameters(BatchParameters batchParameters)` If the event target is an Batch job, this contains the job definition, job name, and other parameters.
`default Target.Builder`	`batchParameters(Consumer<BatchParameters.Builder> batchParameters)` If the event target is an Batch job, this contains the job definition, job name, and other parameters.
`default Target.Builder`	`deadLetterConfig(Consumer<DeadLetterConfig.Builder> deadLetterConfig)` The `DeadLetterConfig` that defines the target queue to send dead-letter queue events to.
`Target.Builder`	`deadLetterConfig(DeadLetterConfig deadLetterConfig)` The `DeadLetterConfig` that defines the target queue to send dead-letter queue events to.
`default Target.Builder`	`ecsParameters(Consumer<EcsParameters.Builder> ecsParameters)` Contains the Amazon ECS task definition and task count to be used, if the event target is an Amazon ECS task.
`Target.Builder`	`ecsParameters(EcsParameters ecsParameters)` Contains the Amazon ECS task definition and task count to be used, if the event target is an Amazon ECS task.
`default Target.Builder`	`httpParameters(Consumer<HttpParameters.Builder> httpParameters)` Contains the HTTP parameters to use when the target is a API Gateway REST endpoint or EventBridge ApiDestination.
`Target.Builder`	`httpParameters(HttpParameters httpParameters)` Contains the HTTP parameters to use when the target is a API Gateway REST endpoint or EventBridge ApiDestination.
`Target.Builder`	`id(String id)` The ID of the target within the specified rule.
`Target.Builder`	`input(String input)` Valid JSON text passed to the target.
`Target.Builder`	`inputPath(String inputPath)` The value of the JSONPath that is used for extracting part of the matched event when passing it to the target.
`default Target.Builder`	`inputTransformer(Consumer<InputTransformer.Builder> inputTransformer)` Settings to enable you to provide custom input to a target based on certain event data.
`Target.Builder`	`inputTransformer(InputTransformer inputTransformer)` Settings to enable you to provide custom input to a target based on certain event data.
`default Target.Builder`	`kinesisParameters(Consumer<KinesisParameters.Builder> kinesisParameters)` The custom parameter you can use to control the shard assignment, when the target is a Kinesis data stream.
`Target.Builder`	`kinesisParameters(KinesisParameters kinesisParameters)` The custom parameter you can use to control the shard assignment, when the target is a Kinesis data stream.
`default Target.Builder`	`redshiftDataParameters(Consumer<RedshiftDataParameters.Builder> redshiftDataParameters)` Contains the Amazon Redshift Data API parameters to use when the target is a Amazon Redshift cluster.
`Target.Builder`	`redshiftDataParameters(RedshiftDataParameters redshiftDataParameters)` Contains the Amazon Redshift Data API parameters to use when the target is a Amazon Redshift cluster.
`default Target.Builder`	`retryPolicy(Consumer<RetryPolicy.Builder> retryPolicy)` The `RetryPolicy` object that contains the retry policy configuration to use for the dead-letter queue.
`Target.Builder`	`retryPolicy(RetryPolicy retryPolicy)` The `RetryPolicy` object that contains the retry policy configuration to use for the dead-letter queue.
`Target.Builder`	`roleArn(String roleArn)` The Amazon Resource Name (ARN) of the IAM role to be used for this target when the rule is triggered.
`default Target.Builder`	`runCommandParameters(Consumer<RunCommandParameters.Builder> runCommandParameters)` Parameters used when you are using the rule to invoke Amazon EC2 Run Command.
`Target.Builder`	`runCommandParameters(RunCommandParameters runCommandParameters)` Parameters used when you are using the rule to invoke Amazon EC2 Run Command.
`default Target.Builder`	`sageMakerPipelineParameters(Consumer<SageMakerPipelineParameters.Builder> sageMakerPipelineParameters)` Contains the SageMaker Model Building Pipeline parameters to start execution of a SageMaker Model Building Pipeline.
`Target.Builder`	`sageMakerPipelineParameters(SageMakerPipelineParameters sageMakerPipelineParameters)` Contains the SageMaker Model Building Pipeline parameters to start execution of a SageMaker Model Building Pipeline.
`default Target.Builder`	`sqsParameters(Consumer<SqsParameters.Builder> sqsParameters)` Contains the message group ID to use when the target is a FIFO queue.
`Target.Builder`	`sqsParameters(SqsParameters sqsParameters)` Contains the message group ID to use when the target is a FIFO queue.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build

- Method Detail
  - id
```
Target.Builder id(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - arn
```
Target.Builder arn(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.
  - roleArn
```
Target.Builder roleArn(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.
  - input
```
Target.Builder input(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.
  - inputPath
```
Target.Builder inputPath(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.
  - inputTransformer
```
Target.Builder inputTransformer(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.
  - inputTransformer
```
default Target.Builder inputTransformer(Consumer<InputTransformer.Builder> 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.
    This is a convenience method that creates an instance of the InputTransformer.Builder avoiding the need to create one manually via InputTransformer.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to inputTransformer(InputTransformer).
    
    Parameters:
    
    inputTransformer - a consumer that will call methods on InputTransformer.Builder
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    inputTransformer(InputTransformer)
  - kinesisParameters
```
Target.Builder kinesisParameters(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - kinesisParameters
```
default Target.Builder kinesisParameters(Consumer<KinesisParameters.Builder> 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.
    This is a convenience method that creates an instance of the KinesisParameters.Builder avoiding the need to create one manually via KinesisParameters.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to kinesisParameters(KinesisParameters).
    
    Parameters:
    
    kinesisParameters - a consumer that will call methods on KinesisParameters.Builder
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    kinesisParameters(KinesisParameters)
  - runCommandParameters
```
Target.Builder runCommandParameters(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.
  - runCommandParameters
```
default Target.Builder runCommandParameters(Consumer<RunCommandParameters.Builder> runCommandParameters)
```
    Parameters used when you are using the rule to invoke Amazon EC2 Run Command.
    This is a convenience method that creates an instance of the RunCommandParameters.Builder avoiding the need to create one manually via RunCommandParameters.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to runCommandParameters(RunCommandParameters).
    
    Parameters:
    
    runCommandParameters - a consumer that will call methods on RunCommandParameters.Builder
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    runCommandParameters(RunCommandParameters)
  - ecsParameters
```
Target.Builder ecsParameters(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.
  - ecsParameters
```
default Target.Builder ecsParameters(Consumer<EcsParameters.Builder> 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.
    This is a convenience method that creates an instance of the EcsParameters.Builder avoiding the need to create one manually via EcsParameters.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to ecsParameters(EcsParameters).
    
    Parameters:
    
    ecsParameters - a consumer that will call methods on EcsParameters.Builder
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ecsParameters(EcsParameters)
  - batchParameters
```
Target.Builder batchParameters(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - batchParameters
```
default Target.Builder batchParameters(Consumer<BatchParameters.Builder> 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.
    This is a convenience method that creates an instance of the BatchParameters.Builder avoiding the need to create one manually via BatchParameters.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to batchParameters(BatchParameters).
    
    Parameters:
    
    batchParameters - a consumer that will call methods on BatchParameters.Builder
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    batchParameters(BatchParameters)
  - sqsParameters
```
Target.Builder sqsParameters(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.
  - sqsParameters
```
default Target.Builder sqsParameters(Consumer<SqsParameters.Builder> 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.
    This is a convenience method that creates an instance of the SqsParameters.Builder avoiding the need to create one manually via SqsParameters.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to sqsParameters(SqsParameters).
    
    Parameters:
    
    sqsParameters - a consumer that will call methods on SqsParameters.Builder
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    sqsParameters(SqsParameters)
  - httpParameters
```
Target.Builder httpParameters(HttpParameters httpParameters)
```
    Contains the HTTP parameters to use when the target is a API Gateway REST endpoint or EventBridge ApiDestination.
    
    If you specify an API Gateway REST 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.
    
    Parameters:
    
    httpParameters - Contains the HTTP parameters to use when the target is a API Gateway REST endpoint or EventBridge ApiDestination.
    
    If you specify an API Gateway REST 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:
    
    Returns a reference to this object so that method calls can be chained together.
  - httpParameters
```
default Target.Builder httpParameters(Consumer<HttpParameters.Builder> httpParameters)
```
    Contains the HTTP parameters to use when the target is a API Gateway REST endpoint or EventBridge ApiDestination.
    
    If you specify an API Gateway REST 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.
    This is a convenience method that creates an instance of the HttpParameters.Builder avoiding the need to create one manually via HttpParameters.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to httpParameters(HttpParameters).
    
    Parameters:
    
    httpParameters - a consumer that will call methods on HttpParameters.Builder
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    httpParameters(HttpParameters)
  - redshiftDataParameters
```
Target.Builder redshiftDataParameters(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - redshiftDataParameters
```
default Target.Builder redshiftDataParameters(Consumer<RedshiftDataParameters.Builder> 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.
    This is a convenience method that creates an instance of the RedshiftDataParameters.Builder avoiding the need to create one manually via RedshiftDataParameters.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to redshiftDataParameters(RedshiftDataParameters).
    
    Parameters:
    
    redshiftDataParameters - a consumer that will call methods on RedshiftDataParameters.Builder
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    redshiftDataParameters(RedshiftDataParameters)
  - sageMakerPipelineParameters
```
Target.Builder sageMakerPipelineParameters(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - sageMakerPipelineParameters
```
default Target.Builder sageMakerPipelineParameters(Consumer<SageMakerPipelineParameters.Builder> 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.
    This is a convenience method that creates an instance of the SageMakerPipelineParameters.Builder avoiding the need to create one manually via SageMakerPipelineParameters.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to sageMakerPipelineParameters(SageMakerPipelineParameters).
    
    Parameters:
    
    sageMakerPipelineParameters - a consumer that will call methods on SageMakerPipelineParameters.Builder
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    sageMakerPipelineParameters(SageMakerPipelineParameters)
  - deadLetterConfig
```
Target.Builder deadLetterConfig(DeadLetterConfig deadLetterConfig)
```
    The DeadLetterConfig that defines the target queue to send dead-letter queue events to.
    
    Parameters:
    
    deadLetterConfig - The DeadLetterConfig that defines the target queue to send dead-letter queue events to.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - deadLetterConfig
```
default Target.Builder deadLetterConfig(Consumer<DeadLetterConfig.Builder> deadLetterConfig)
```
    The DeadLetterConfig that defines the target queue to send dead-letter queue events to.
    This is a convenience method that creates an instance of the DeadLetterConfig.Builder avoiding the need to create one manually via DeadLetterConfig.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to deadLetterConfig(DeadLetterConfig).
    
    Parameters:
    
    deadLetterConfig - a consumer that will call methods on DeadLetterConfig.Builder
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    deadLetterConfig(DeadLetterConfig)
  - retryPolicy
```
Target.Builder retryPolicy(RetryPolicy retryPolicy)
```
    The RetryPolicy object that contains the retry policy configuration to use for the dead-letter queue.
    
    Parameters:
    
    retryPolicy - The RetryPolicy object that contains the retry policy configuration to use for the dead-letter queue.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - retryPolicy
```
default Target.Builder retryPolicy(Consumer<RetryPolicy.Builder> retryPolicy)
```
    The RetryPolicy object that contains the retry policy configuration to use for the dead-letter queue.
    This is a convenience method that creates an instance of the RetryPolicy.Builder avoiding the need to create one manually via RetryPolicy.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to retryPolicy(RetryPolicy).
    
    Parameters:
    
    retryPolicy - a consumer that will call methods on RetryPolicy.Builder
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    retryPolicy(RetryPolicy)

Interface Target.Builder

Method Summary

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

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

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

Method Detail

id

arn

roleArn

input

inputPath

inputTransformer

inputTransformer

kinesisParameters

kinesisParameters

runCommandParameters

runCommandParameters

ecsParameters

ecsParameters

batchParameters

batchParameters

sqsParameters

sqsParameters

httpParameters

httpParameters

redshiftDataParameters

redshiftDataParameters

sageMakerPipelineParameters

sageMakerPipelineParameters

deadLetterConfig

deadLetterConfig

retryPolicy

retryPolicy