Interface Target.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<Target.Builder,
,Target> SdkBuilder<Target.Builder,
,Target> SdkPojo
- Enclosing class:
Target
-
Method Summary
Modifier and TypeMethodDescriptiondefault Target.Builder
appSyncParameters
(Consumer<AppSyncParameters.Builder> appSyncParameters) Contains the GraphQL operation to be parsed and executed, if the event target is an AppSync API.appSyncParameters
(AppSyncParameters appSyncParameters) Contains the GraphQL operation to be parsed and executed, if the event target is an AppSync API.The Amazon Resource Name (ARN) of the target.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.batchParameters
(BatchParameters 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) TheDeadLetterConfig
that defines the target queue to send dead-letter queue events to.deadLetterConfig
(DeadLetterConfig deadLetterConfig) TheDeadLetterConfig
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.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 endpoint or EventBridge ApiDestination.httpParameters
(HttpParameters httpParameters) Contains the HTTP parameters to use when the target is a API Gateway endpoint or EventBridge ApiDestination.The ID of the target within the specified rule.Valid JSON text passed to the target.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.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.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.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) TheRetryPolicy
object that contains the retry policy configuration to use for the dead-letter queue.retryPolicy
(RetryPolicy retryPolicy) TheRetryPolicy
object that contains the retry policy configuration to use for the dead-letter queue.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.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.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.sqsParameters
(SqsParameters sqsParameters) Contains the message group ID to use when the target is a FIFO queue.Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
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
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
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
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
The value of the JSONPath that is used for extracting part of the matched event when passing it to the target. You may use JSON dot notation or 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 may use JSON dot notation or 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
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
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 theInputTransformer.Builder
avoiding the need to create one manually viaInputTransformer.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toinputTransformer(InputTransformer)
.- Parameters:
inputTransformer
- a consumer that will call methods onInputTransformer.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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 theeventId
as the partition key.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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
This is a convenience method that creates an instance of theeventId
as the partition key.KinesisParameters.Builder
avoiding the need to create one manually viaKinesisParameters.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tokinesisParameters(KinesisParameters)
.- Parameters:
kinesisParameters
- a consumer that will call methods onKinesisParameters.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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 theRunCommandParameters.Builder
avoiding the need to create one manually viaRunCommandParameters.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed torunCommandParameters(RunCommandParameters)
.- Parameters:
runCommandParameters
- a consumer that will call methods onRunCommandParameters.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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
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 theEcsParameters.Builder
avoiding the need to create one manually viaEcsParameters.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toecsParameters(EcsParameters)
.- Parameters:
ecsParameters
- a consumer that will call methods onEcsParameters.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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
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 theBatchParameters.Builder
avoiding the need to create one manually viaBatchParameters.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tobatchParameters(BatchParameters)
.- Parameters:
batchParameters
- a consumer that will call methods onBatchParameters.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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
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 theSqsParameters.Builder
avoiding the need to create one manually viaSqsParameters.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tosqsParameters(SqsParameters)
.- Parameters:
sqsParameters
- a consumer that will call methods onSqsParameters.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
httpParameters
Contains the HTTP parameters to use when the target is a API Gateway endpoint or EventBridge ApiDestination.
If you specify an API Gateway 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 endpoint or EventBridge ApiDestination.If you specify an API Gateway 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
Contains the HTTP parameters to use when the target is a API Gateway endpoint or EventBridge ApiDestination.
If you specify an API Gateway 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 theHttpParameters.Builder
avoiding the need to create one manually viaHttpParameters.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tohttpParameters(HttpParameters)
.- Parameters:
httpParameters
- a consumer that will call methods onHttpParameters.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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 theRedshiftDataParameters.Builder
avoiding the need to create one manually viaRedshiftDataParameters.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toredshiftDataParameters(RedshiftDataParameters)
.- Parameters:
redshiftDataParameters
- a consumer that will call methods onRedshiftDataParameters.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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 theSageMakerPipelineParameters.Builder
avoiding the need to create one manually viaSageMakerPipelineParameters.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tosageMakerPipelineParameters(SageMakerPipelineParameters)
.- Parameters:
sageMakerPipelineParameters
- a consumer that will call methods onSageMakerPipelineParameters.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
deadLetterConfig
The
DeadLetterConfig
that defines the target queue to send dead-letter queue events to.- Parameters:
deadLetterConfig
- TheDeadLetterConfig
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
The
This is a convenience method that creates an instance of theDeadLetterConfig
that defines the target queue to send dead-letter queue events to.DeadLetterConfig.Builder
avoiding the need to create one manually viaDeadLetterConfig.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed todeadLetterConfig(DeadLetterConfig)
.- Parameters:
deadLetterConfig
- a consumer that will call methods onDeadLetterConfig.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
retryPolicy
The
RetryPolicy
object that contains the retry policy configuration to use for the dead-letter queue.- Parameters:
retryPolicy
- TheRetryPolicy
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
The
This is a convenience method that creates an instance of theRetryPolicy
object that contains the retry policy configuration to use for the dead-letter queue.RetryPolicy.Builder
avoiding the need to create one manually viaRetryPolicy.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toretryPolicy(RetryPolicy)
.- Parameters:
retryPolicy
- a consumer that will call methods onRetryPolicy.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
appSyncParameters
Contains the GraphQL operation to be parsed and executed, if the event target is an AppSync API.
- Parameters:
appSyncParameters
- Contains the GraphQL operation to be parsed and executed, if the event target is an AppSync API.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
appSyncParameters
Contains the GraphQL operation to be parsed and executed, if the event target is an AppSync API.
This is a convenience method that creates an instance of theAppSyncParameters.Builder
avoiding the need to create one manually viaAppSyncParameters.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toappSyncParameters(AppSyncParameters)
.- Parameters:
appSyncParameters
- a consumer that will call methods onAppSyncParameters.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-