public static interface Target.Builder extends SdkPojo, CopyableBuilder<Target.Builder,Target>
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.
|
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.
|
equalsBySdkFields, sdkFields
copy
applyMutation, build
Target.Builder id(String id)
The ID of the target. We recommend using a memorable and unique string.
id
- The ID of the target. We recommend using a memorable and unique string.Target.Builder arn(String arn)
The Amazon Resource Name (ARN) of the target.
arn
- The Amazon Resource Name (ARN) of the target.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.
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.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.
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.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.
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.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.
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.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 that creates an instance of theInputTransformer.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)
.inputTransformer
- a consumer that will call methods on InputTransformer.Builder
inputTransformer(InputTransformer)
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.
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.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.
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)
.kinesisParameters
- a consumer that will call methods on KinesisParameters.Builder
kinesisParameters(KinesisParameters)
Target.Builder runCommandParameters(RunCommandParameters runCommandParameters)
Parameters used when you are using the rule to invoke Amazon EC2 Run Command.
runCommandParameters
- Parameters used when you are using the rule to invoke Amazon EC2 Run Command.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 that creates an instance of theRunCommandParameters.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)
.runCommandParameters
- a consumer that will call methods on RunCommandParameters.Builder
runCommandParameters(RunCommandParameters)
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.
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.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 that creates an instance of theEcsParameters.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)
.ecsParameters
- a consumer that will call methods on EcsParameters.Builder
ecsParameters(EcsParameters)
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.
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.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 that creates an instance of theBatchParameters.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)
.batchParameters
- a consumer that will call methods on BatchParameters.Builder
batchParameters(BatchParameters)
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.
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.
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 that creates an instance of theSqsParameters.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)
.sqsParameters
- a consumer that will call methods on SqsParameters.Builder
sqsParameters(SqsParameters)
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.
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.
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 that creates an instance of theHttpParameters.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)
.httpParameters
- a consumer that will call methods on HttpParameters.Builder
httpParameters(HttpParameters)
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.
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.
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 that creates an instance of theRedshiftDataParameters.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)
.redshiftDataParameters
- a consumer that will call methods on RedshiftDataParameters.Builder
redshiftDataParameters(RedshiftDataParameters)
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.
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.
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 that creates an instance of theSageMakerPipelineParameters.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)
.sageMakerPipelineParameters
- a consumer that will call methods on SageMakerPipelineParameters.Builder
sageMakerPipelineParameters(SageMakerPipelineParameters)
Target.Builder deadLetterConfig(DeadLetterConfig deadLetterConfig)
The DeadLetterConfig
that defines the target queue to send dead-letter queue events to.
deadLetterConfig
- The DeadLetterConfig
that defines the target queue to send dead-letter queue events to.default Target.Builder deadLetterConfig(Consumer<DeadLetterConfig.Builder> deadLetterConfig)
The DeadLetterConfig
that defines the target queue to send dead-letter queue events to.
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)
.deadLetterConfig
- a consumer that will call methods on DeadLetterConfig.Builder
deadLetterConfig(DeadLetterConfig)
Target.Builder retryPolicy(RetryPolicy retryPolicy)
The RetryPolicy
object that contains the retry policy configuration to use for the dead-letter
queue.
retryPolicy
- The RetryPolicy
object that contains the retry policy configuration to use for the
dead-letter queue.default Target.Builder retryPolicy(Consumer<RetryPolicy.Builder> retryPolicy)
The RetryPolicy
object that contains the retry policy configuration to use for the dead-letter
queue.
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)
.retryPolicy
- a consumer that will call methods on RetryPolicy.Builder
retryPolicy(RetryPolicy)
Copyright © 2022. All rights reserved.