Package software.amazon.awscdk.services.pipes

Interface CfnPipe.PipeTargetParametersProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnPipe.PipeTargetParametersProperty.Jsii$Proxy

Enclosing class:

CfnPipe

@Stability(Stable)
public static interface CfnPipe.PipeTargetParametersProperty
extends software.amazon.jsii.JsiiSerializable

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 .

Example:

 Queue sourceQueue;
 Queue targetQueue;
 SqsSource pipeSource = SqsSource.Builder.create(sourceQueue)
         .batchSize(10)
         .maximumBatchingWindow(Duration.seconds(10))
         .build();
 Pipe pipe = Pipe.Builder.create(this, "Pipe")
         .source(pipeSource)
         .target(new SomeTarget(targetQueue))
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnPipe.PipeTargetParametersProperty.Builder	A builder for CfnPipe.PipeTargetParametersProperty
static final class	CfnPipe.PipeTargetParametersProperty.Jsii$Proxy	An implementation for CfnPipe.PipeTargetParametersProperty

Method Summary

Modifier and Type	Method	Description
static CfnPipe.PipeTargetParametersProperty.Builder	builder()
default Object	getBatchJobParameters()	The parameters for using an AWS Batch job as a target.
default Object	getCloudWatchLogsParameters()	The parameters for using an CloudWatch Logs log stream as a target.
default Object	getEcsTaskParameters()	The parameters for using an Amazon ECS task as a target.
default Object	getEventBridgeEventBusParameters()	The parameters for using an EventBridge event bus as a target.
default Object	getHttpParameters()	These are custom parameter to be used when the target is an API Gateway REST APIs or EventBridge ApiDestinations.
default String	getInputTemplate()	Valid JSON text passed to the target.
default Object	getKinesisStreamParameters()	The parameters for using a Kinesis stream as a target.
default Object	getLambdaFunctionParameters()	The parameters for using a Lambda function as a target.
default Object	getRedshiftDataParameters()	These are custom parameters to be used when the target is a Amazon Redshift cluster to invoke the Amazon Redshift Data API BatchExecuteStatement.
default Object	getSageMakerPipelineParameters()	The parameters for using a SageMaker pipeline as a target.
default Object	getSqsQueueParameters()	The parameters for using a Amazon SQS stream as a target.
default Object	getStepFunctionStateMachineParameters()	The parameters for using a Step Functions state machine as a target.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getBatchJobParameters

@Stability(Stable)
@Nullable
default Object getBatchJobParameters()

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

getCloudWatchLogsParameters

@Stability(Stable)
@Nullable
default Object getCloudWatchLogsParameters()

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

getEcsTaskParameters

@Stability(Stable)
@Nullable
default Object getEcsTaskParameters()

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

getEventBridgeEventBusParameters

@Stability(Stable)
@Nullable
default Object getEventBridgeEventBusParameters()

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

getHttpParameters

@Stability(Stable)
@Nullable
default Object getHttpParameters()

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

getInputTemplate

@Stability(Stable)
@Nullable
default String getInputTemplate()

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

getKinesisStreamParameters

@Stability(Stable)
@Nullable
default Object getKinesisStreamParameters()

The parameters for using a Kinesis stream as a target.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipetargetparameters.html#cfn-pipes-pipe-pipetargetparameters-kinesisstreamparameters

getLambdaFunctionParameters

@Stability(Stable)
@Nullable
default Object getLambdaFunctionParameters()

The parameters for using a Lambda function as a target.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipetargetparameters.html#cfn-pipes-pipe-pipetargetparameters-lambdafunctionparameters

getRedshiftDataParameters

@Stability(Stable)
@Nullable
default Object getRedshiftDataParameters()

These are custom parameters to be used when the target is a Amazon Redshift cluster to invoke the Amazon Redshift Data API BatchExecuteStatement.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipetargetparameters.html#cfn-pipes-pipe-pipetargetparameters-redshiftdataparameters

getSageMakerPipelineParameters

@Stability(Stable)
@Nullable
default Object getSageMakerPipelineParameters()

The parameters for using a SageMaker pipeline as a target.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipetargetparameters.html#cfn-pipes-pipe-pipetargetparameters-sagemakerpipelineparameters

getSqsQueueParameters

@Stability(Stable)
@Nullable
default Object getSqsQueueParameters()

The parameters for using a Amazon SQS stream as a target.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipetargetparameters.html#cfn-pipes-pipe-pipetargetparameters-sqsqueueparameters

getStepFunctionStateMachineParameters

@Stability(Stable)
@Nullable
default Object getStepFunctionStateMachineParameters()

The parameters for using a Step Functions state machine as a target.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipetargetparameters.html#cfn-pipes-pipe-pipetargetparameters-stepfunctionstatemachineparameters

builder

@Stability(Stable)
static CfnPipe.PipeTargetParametersProperty.Builder builder()

Returns:

a CfnPipe.PipeTargetParametersProperty.Builder of CfnPipe.PipeTargetParametersProperty