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.
Syntax
To declare this entity in your AWS CloudFormation template, use the following syntax:
JSON
{
"BatchJobParameters" : PipeTargetBatchJobParameters,
"CloudWatchLogsParameters" : PipeTargetCloudWatchLogsParameters,
"EcsTaskParameters" : PipeTargetEcsTaskParameters,
"EventBridgeEventBusParameters" : PipeTargetEventBridgeEventBusParameters,
"HttpParameters" : PipeTargetHttpParameters,
"InputTemplate" : String,
"KinesisStreamParameters" : PipeTargetKinesisStreamParameters,
"LambdaFunctionParameters" : PipeTargetLambdaFunctionParameters,
"RedshiftDataParameters" : PipeTargetRedshiftDataParameters,
"SageMakerPipelineParameters" : PipeTargetSageMakerPipelineParameters,
"SqsQueueParameters" : PipeTargetSqsQueueParameters,
"StepFunctionStateMachineParameters" : PipeTargetStateMachineParameters,
"TimestreamParameters" : PipeTargetTimestreamParameters
}
YAML
BatchJobParameters:
PipeTargetBatchJobParameters
CloudWatchLogsParameters:
PipeTargetCloudWatchLogsParameters
EcsTaskParameters:
PipeTargetEcsTaskParameters
EventBridgeEventBusParameters:
PipeTargetEventBridgeEventBusParameters
HttpParameters:
PipeTargetHttpParameters
InputTemplate: String
KinesisStreamParameters:
PipeTargetKinesisStreamParameters
LambdaFunctionParameters:
PipeTargetLambdaFunctionParameters
RedshiftDataParameters:
PipeTargetRedshiftDataParameters
SageMakerPipelineParameters:
PipeTargetSageMakerPipelineParameters
SqsQueueParameters:
PipeTargetSqsQueueParameters
StepFunctionStateMachineParameters:
PipeTargetStateMachineParameters
TimestreamParameters:
PipeTargetTimestreamParameters
Properties
BatchJobParameters-
The parameters for using an AWS Batch job as a target.
Required: No
Type: PipeTargetBatchJobParameters
Update requires: No interruption
CloudWatchLogsParameters-
The parameters for using an CloudWatch Logs log stream as a target.
Required: No
Type: PipeTargetCloudWatchLogsParameters
Update requires: No interruption
EcsTaskParameters-
The parameters for using an Amazon ECS task as a target.
Required: No
Type: PipeTargetEcsTaskParameters
Update requires: No interruption
EventBridgeEventBusParameters-
The parameters for using an EventBridge event bus as a target.
Required: No
Type: PipeTargetEventBridgeEventBusParameters
Update requires: No interruption
HttpParameters-
These are custom parameter to be used when the target is an API Gateway REST APIs or EventBridge ApiDestinations.
Required: No
Type: PipeTargetHttpParameters
Update requires: No interruption
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.
Required: No
Type: String
Minimum:
0Maximum:
8192Update requires: No interruption
KinesisStreamParameters-
The parameters for using a Kinesis stream as a target.
Required: No
Type: PipeTargetKinesisStreamParameters
Update requires: No interruption
LambdaFunctionParameters-
The parameters for using a Lambda function as a target.
Required: No
Type: PipeTargetLambdaFunctionParameters
Update requires: No interruption
RedshiftDataParameters-
These are custom parameters to be used when the target is a Amazon Redshift cluster to invoke the Amazon Redshift Data API BatchExecuteStatement.
Required: No
Type: PipeTargetRedshiftDataParameters
Update requires: No interruption
SageMakerPipelineParameters-
The parameters for using a SageMaker AI pipeline as a target.
Required: No
Type: PipeTargetSageMakerPipelineParameters
Update requires: No interruption
SqsQueueParameters-
The parameters for using a Amazon SQS stream as a target.
Required: No
Type: PipeTargetSqsQueueParameters
Update requires: No interruption
StepFunctionStateMachineParameters-
The parameters for using a Step Functions state machine as a target.
Required: No
Type: PipeTargetStateMachineParameters
Update requires: No interruption
TimestreamParameters-
The parameters for using a Timestream for LiveAnalytics table as a target.
Required: No
Type: PipeTargetTimestreamParameters
Update requires: No interruption
