Class CfnPipe.PipeTargetParametersProperty
The parameters required to set up a target for your pipe.
Inheritance
Implements
Namespace: Amazon.CDK.AWS.Pipes
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class PipeTargetParametersProperty : Object, CfnPipe.IPipeTargetParametersProperty
Syntax (vb)
Public Class PipeTargetParametersProperty
Inherits Object
Implements CfnPipe.IPipeTargetParametersProperty
Remarks
For more information about pipe target parameters, including how to use dynamic path parameters, see Target parameters in the Amazon EventBridge User Guide .
ExampleMetadata: infused
Examples
Queue sourceQueue;
Queue targetQueue;
var pipeSource = new SqsSource(sourceQueue, new SqsSourceParameters {
BatchSize = 10,
MaximumBatchingWindow = Duration.Seconds(10)
});
var pipe = new Pipe(this, "Pipe", new PipeProps {
Source = pipeSource,
Target = new SomeTarget(targetQueue)
});
Synopsis
Constructors
PipeTargetParametersProperty() |
Properties
BatchJobParameters | The parameters for using an AWS Batch job as a target. |
CloudWatchLogsParameters | The parameters for using an CloudWatch Logs log stream as a target. |
EcsTaskParameters | The parameters for using an Amazon ECS task as a target. |
EventBridgeEventBusParameters | The parameters for using an EventBridge event bus as a target. |
HttpParameters | These are custom parameter to be used when the target is an API Gateway REST APIs or EventBridge ApiDestinations. |
InputTemplate | Valid JSON text passed to the target. |
KinesisStreamParameters | The parameters for using a Kinesis stream as a target. |
LambdaFunctionParameters | The parameters for using a Lambda function as a target. |
RedshiftDataParameters | These are custom parameters to be used when the target is a Amazon Redshift cluster to invoke the Amazon Redshift Data API BatchExecuteStatement. |
SageMakerPipelineParameters | The parameters for using a SageMaker pipeline as a target. |
SqsQueueParameters | The parameters for using a Amazon SQS stream as a target. |
StepFunctionStateMachineParameters | The parameters for using a Step Functions state machine as a target. |
Constructors
PipeTargetParametersProperty()
public PipeTargetParametersProperty()
Properties
BatchJobParameters
The parameters for using an AWS Batch job as a target.
public object BatchJobParameters { get; set; }
Property Value
System.Object
Remarks
CloudWatchLogsParameters
The parameters for using an CloudWatch Logs log stream as a target.
public object CloudWatchLogsParameters { get; set; }
Property Value
System.Object
Remarks
EcsTaskParameters
The parameters for using an Amazon ECS task as a target.
public object EcsTaskParameters { get; set; }
Property Value
System.Object
Remarks
EventBridgeEventBusParameters
The parameters for using an EventBridge event bus as a target.
public object EventBridgeEventBusParameters { get; set; }
Property Value
System.Object
Remarks
HttpParameters
These are custom parameter to be used when the target is an API Gateway REST APIs or EventBridge ApiDestinations.
public object HttpParameters { get; set; }
Property Value
System.Object
Remarks
InputTemplate
Valid JSON text passed to the target.
public string InputTemplate { get; set; }
Property Value
System.String
Remarks
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.
KinesisStreamParameters
The parameters for using a Kinesis stream as a target.
public object KinesisStreamParameters { get; set; }
Property Value
System.Object
Remarks
LambdaFunctionParameters
The parameters for using a Lambda function as a target.
public object LambdaFunctionParameters { get; set; }
Property Value
System.Object
Remarks
RedshiftDataParameters
These are custom parameters to be used when the target is a Amazon Redshift cluster to invoke the Amazon Redshift Data API BatchExecuteStatement.
public object RedshiftDataParameters { get; set; }
Property Value
System.Object
Remarks
SageMakerPipelineParameters
The parameters for using a SageMaker pipeline as a target.
public object SageMakerPipelineParameters { get; set; }
Property Value
System.Object
Remarks
SqsQueueParameters
The parameters for using a Amazon SQS stream as a target.
public object SqsQueueParameters { get; set; }
Property Value
System.Object
Remarks
StepFunctionStateMachineParameters
The parameters for using a Step Functions state machine as a target.
public object StepFunctionStateMachineParameters { get; set; }
Property Value
System.Object