AWS::Pipes::Pipe 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.
Syntax
To declare this entity in your Amazon 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}
YAML
BatchJobParameters:PipeTargetBatchJobParametersCloudWatchLogsParameters:PipeTargetCloudWatchLogsParametersEcsTaskParameters:PipeTargetEcsTaskParametersEventBridgeEventBusParameters:PipeTargetEventBridgeEventBusParametersHttpParameters:PipeTargetHttpParametersInputTemplate:StringKinesisStreamParameters:PipeTargetKinesisStreamParametersLambdaFunctionParameters:PipeTargetLambdaFunctionParametersRedshiftDataParameters:PipeTargetRedshiftDataParametersSageMakerPipelineParameters:PipeTargetSageMakerPipelineParametersSqsQueueParameters:PipeTargetSqsQueueParametersStepFunctionStateMachineParameters:PipeTargetStateMachineParameters
Properties
BatchJobParametersThe parameters for using an Amazon Batch job as a target.
Required: No
Type: PipeTargetBatchJobParameters
Update requires: No interruption
CloudWatchLogsParametersThe parameters for using an CloudWatch Logs log stream as a target.
Required: No
Type: PipeTargetCloudWatchLogsParameters
Update requires: No interruption
EcsTaskParametersThe parameters for using an Amazon ECS task as a target.
Required: No
Type: PipeTargetEcsTaskParameters
Update requires: No interruption
EventBridgeEventBusParametersThe parameters for using an EventBridge event bus as a target.
Required: No
Type: PipeTargetEventBridgeEventBusParameters
Update requires: No interruption
HttpParametersThese 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
Update requires: No interruption
KinesisStreamParametersThe parameters for using a Kinesis stream as a source.
Required: No
Type: PipeTargetKinesisStreamParameters
Update requires: No interruption
LambdaFunctionParametersThe parameters for using a Lambda function as a target.
Required: No
Type: PipeTargetLambdaFunctionParameters
Update requires: No interruption
RedshiftDataParametersThese 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
SageMakerPipelineParametersThe parameters for using a SageMaker pipeline as a target.
Required: No
Type: PipeTargetSageMakerPipelineParameters
Update requires: No interruption
SqsQueueParametersThe parameters for using a Amazon SQS stream as a source.
Required: No
Type: PipeTargetSqsQueueParameters
Update requires: No interruption
StepFunctionStateMachineParametersThe parameters for using a Step Functions state machine as a target.
Required: No
Type: PipeTargetStateMachineParameters
Update requires: No interruption