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 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: 0

Maximum: 8192

Update requires: No interruption

KinesisStreamParameters