PipeTargetParameters
The parameters required to set up a target for your pipe.
For more information about pipe target parameters, including how to use dynamic path parameters, see Target parameters in the Amazon EventBridge User Guide.
Contents
- BatchJobParameters
-
The parameters for using an AWS Batch job as a target.
Type: PipeTargetBatchJobParameters object
Required: No
- CloudWatchLogsParameters
-
The parameters for using an CloudWatch Logs log stream as a target.
Type: PipeTargetCloudWatchLogsParameters object
Required: No
- EcsTaskParameters
-
The parameters for using an Amazon ECS task as a target.
Type: PipeTargetEcsTaskParameters object
Required: No
- EventBridgeEventBusParameters
-
The parameters for using an EventBridge event bus as a target.
Type: PipeTargetEventBridgeEventBusParameters object
Required: No
- HttpParameters
-
These are custom parameter to be used when the target is an API Gateway REST APIs or EventBridge ApiDestinations.
Type: PipeTargetHttpParameters object
Required: No
- InputTemplate
-
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
. To remove an input template, specify an empty string.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 8192.
Required: No
- KinesisStreamParameters
-
The parameters for using a Kinesis stream as a target.
Type: PipeTargetKinesisStreamParameters object
Required: No
- LambdaFunctionParameters
-
The parameters for using a Lambda function as a target.
Type: PipeTargetLambdaFunctionParameters object
Required: No
- RedshiftDataParameters
-
These are custom parameters to be used when the target is a Amazon Redshift cluster to invoke the Amazon Redshift Data API BatchExecuteStatement.
Type: PipeTargetRedshiftDataParameters object
Required: No
- SageMakerPipelineParameters
-
The parameters for using a SageMaker AI pipeline as a target.
Type: PipeTargetSageMakerPipelineParameters object
Required: No
- SqsQueueParameters
-
The parameters for using a Amazon SQS stream as a target.
Type: PipeTargetSqsQueueParameters object
Required: No
- StepFunctionStateMachineParameters
-
The parameters for using a Step Functions state machine as a target.
Type: PipeTargetStateMachineParameters object
Required: No
- TimestreamParameters
-
The parameters for using a Timestream for LiveAnalytics table as a target.
Type: PipeTargetTimestreamParameters object
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
