interface PipeTargetParametersProperty

Language	Type name
.NET	`Amazon.CDK.AWS.Pipes.CfnPipe.PipeTargetParametersProperty`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awspipes#CfnPipe_PipeTargetParametersProperty`
Java	`software.amazon.awscdk.services.pipes.CfnPipe.PipeTargetParametersProperty`
Python	`aws_cdk.aws_pipes.CfnPipe.PipeTargetParametersProperty`
TypeScript	`aws-cdk-lib` » `aws_pipes` » `CfnPipe` » `PipeTargetParametersProperty`

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 .

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipetargetparameters.html

Example

declare const sourceQueue: sqs.Queue;
declare const targetQueue: sqs.Queue;

const pipeSource = new sources.SqsSource(sourceQueue, {
  batchSize: 10,
  maximumBatchingWindow: cdk.Duration.seconds(10)
});

const pipe = new pipes.Pipe(this, 'Pipe', {
  source: pipeSource,
  target: new SqsTarget(targetQueue)
});

Properties

Name	Type	Description
batchJobParameters?	`IResolvable` `\|` `PipeTargetBatchJobParametersProperty`	The parameters for using an AWS Batch job as a target.
cloudWatchLogsParameters?	`IResolvable` `\|` `PipeTargetCloudWatchLogsParametersProperty`	The parameters for using an CloudWatch Logs log stream as a target.
ecsTaskParameters?	`IResolvable` `\|` `PipeTargetEcsTaskParametersProperty`	The parameters for using an Amazon ECS task as a target.
eventBridgeEventBusParameters?	`IResolvable` `\|` `PipeTargetEventBridgeEventBusParametersProperty`	The parameters for using an EventBridge event bus as a target.
httpParameters?	`IResolvable` `\|` `PipeTargetHttpParametersProperty`	These are custom parameter to be used when the target is an API Gateway REST APIs or EventBridge ApiDestinations.
inputTemplate?	`string`	Valid JSON text passed to the target.
kinesisStreamParameters?	`IResolvable` `\|` `PipeTargetKinesisStreamParametersProperty`	The parameters for using a Kinesis stream as a target.
lambdaFunctionParameters?	`IResolvable` `\|` `PipeTargetLambdaFunctionParametersProperty`	The parameters for using a Lambda function as a target.
redshiftDataParameters?	`IResolvable` `\|` `PipeTargetRedshiftDataParametersProperty`	These are custom parameters to be used when the target is a Amazon Redshift cluster to invoke the Amazon Redshift Data API BatchExecuteStatement.
sageMakerPipelineParameters?	`IResolvable` `\|` `PipeTargetSageMakerPipelineParametersProperty`	The parameters for using a SageMaker pipeline as a target.
sqsQueueParameters?	`IResolvable` `\|` `PipeTargetSqsQueueParametersProperty`	The parameters for using a Amazon SQS stream as a target.
stepFunctionStateMachineParameters?	`IResolvable` `\|` `PipeTargetStateMachineParametersProperty`	The parameters for using a Step Functions state machine as a target.
timestreamParameters?	`IResolvable` `\|` `PipeTargetTimestreamParametersProperty`	The parameters for using a Timestream for LiveAnalytics table as a target.

batchJobParameters?

Type: IResolvable | PipeTargetBatchJobParametersProperty (optional)

The parameters for using an AWS Batch job as a target.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipetargetparameters.html#cfn-pipes-pipe-pipetargetparameters-batchjobparameters

cloudWatchLogsParameters?

Type: IResolvable | PipeTargetCloudWatchLogsParametersProperty (optional)

The parameters for using an CloudWatch Logs log stream as a target.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipetargetparameters.html#cfn-pipes-pipe-pipetargetparameters-cloudwatchlogsparameters

ecsTaskParameters?

Type: IResolvable | PipeTargetEcsTaskParametersProperty (optional)

The parameters for using an Amazon ECS task as a target.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipetargetparameters.html#cfn-pipes-pipe-pipetargetparameters-ecstaskparameters

eventBridgeEventBusParameters?

Type: IResolvable | PipeTargetEventBridgeEventBusParametersProperty (optional)

The parameters for using an EventBridge event bus as a target.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipetargetparameters.html#cfn-pipes-pipe-pipetargetparameters-eventbridgeeventbusparameters

httpParameters?

Type: IResolvable | PipeTargetHttpParametersProperty (optional)

These are custom parameter to be used when the target is an API Gateway REST APIs or EventBridge ApiDestinations.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipetargetparameters.html#cfn-pipes-pipe-pipetargetparameters-httpparameters

inputTemplate?

Type: string (optional)

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.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipetargetparameters.html#cfn-pipes-pipe-pipetargetparameters-inputtemplate