Package software.amazon.awssdk.services.pipes.model

Interface PipeTargetParameters.Builder

All Superinterfaces:

Buildable, CopyableBuilder<PipeTargetParameters.Builder,PipeTargetParameters>, SdkBuilder<PipeTargetParameters.Builder,PipeTargetParameters>, SdkPojo

Enclosing class:

PipeTargetParameters

public static interface PipeTargetParameters.Builder
extends SdkPojo, CopyableBuilder<PipeTargetParameters.Builder,PipeTargetParameters>

Method Summary

Modifier and Type	Method	Description
default PipeTargetParameters.Builder	batchJobParameters(Consumer<PipeTargetBatchJobParameters.Builder> batchJobParameters)	The parameters for using an Batch job as a target.
PipeTargetParameters.Builder	batchJobParameters(PipeTargetBatchJobParameters batchJobParameters)	The parameters for using an Batch job as a target.
default PipeTargetParameters.Builder	cloudWatchLogsParameters(Consumer<PipeTargetCloudWatchLogsParameters.Builder> cloudWatchLogsParameters)	The parameters for using an CloudWatch Logs log stream as a target.
PipeTargetParameters.Builder	cloudWatchLogsParameters(PipeTargetCloudWatchLogsParameters cloudWatchLogsParameters)	The parameters for using an CloudWatch Logs log stream as a target.
default PipeTargetParameters.Builder	ecsTaskParameters(Consumer<PipeTargetEcsTaskParameters.Builder> ecsTaskParameters)	The parameters for using an Amazon ECS task as a target.
PipeTargetParameters.Builder	ecsTaskParameters(PipeTargetEcsTaskParameters ecsTaskParameters)	The parameters for using an Amazon ECS task as a target.
default PipeTargetParameters.Builder	eventBridgeEventBusParameters(Consumer<PipeTargetEventBridgeEventBusParameters.Builder> eventBridgeEventBusParameters)	The parameters for using an EventBridge event bus as a target.
PipeTargetParameters.Builder	eventBridgeEventBusParameters(PipeTargetEventBridgeEventBusParameters eventBridgeEventBusParameters)	The parameters for using an EventBridge event bus as a target.
default PipeTargetParameters.Builder	httpParameters(Consumer<PipeTargetHttpParameters.Builder> httpParameters)	These are custom parameter to be used when the target is an API Gateway REST APIs or EventBridge ApiDestinations.
PipeTargetParameters.Builder	httpParameters(PipeTargetHttpParameters httpParameters)	These are custom parameter to be used when the target is an API Gateway REST APIs or EventBridge ApiDestinations.
PipeTargetParameters.Builder	inputTemplate(String inputTemplate)	Valid JSON text passed to the target.
default PipeTargetParameters.Builder	kinesisStreamParameters(Consumer<PipeTargetKinesisStreamParameters.Builder> kinesisStreamParameters)	The parameters for using a Kinesis stream as a target.
PipeTargetParameters.Builder	kinesisStreamParameters(PipeTargetKinesisStreamParameters kinesisStreamParameters)	The parameters for using a Kinesis stream as a target.
default PipeTargetParameters.Builder	lambdaFunctionParameters(Consumer<PipeTargetLambdaFunctionParameters.Builder> lambdaFunctionParameters)	The parameters for using a Lambda function as a target.
PipeTargetParameters.Builder	lambdaFunctionParameters(PipeTargetLambdaFunctionParameters lambdaFunctionParameters)	The parameters for using a Lambda function as a target.
default PipeTargetParameters.Builder	redshiftDataParameters(Consumer<PipeTargetRedshiftDataParameters.Builder> redshiftDataParameters)	These are custom parameters to be used when the target is a Amazon Redshift cluster to invoke the Amazon Redshift Data API BatchExecuteStatement.
PipeTargetParameters.Builder	redshiftDataParameters(PipeTargetRedshiftDataParameters redshiftDataParameters)	These are custom parameters to be used when the target is a Amazon Redshift cluster to invoke the Amazon Redshift Data API BatchExecuteStatement.
default PipeTargetParameters.Builder	sageMakerPipelineParameters(Consumer<PipeTargetSageMakerPipelineParameters.Builder> sageMakerPipelineParameters)	The parameters for using a SageMaker pipeline as a target.
PipeTargetParameters.Builder	sageMakerPipelineParameters(PipeTargetSageMakerPipelineParameters sageMakerPipelineParameters)	The parameters for using a SageMaker pipeline as a target.
default PipeTargetParameters.Builder	sqsQueueParameters(Consumer<PipeTargetSqsQueueParameters.Builder> sqsQueueParameters)	The parameters for using a Amazon SQS stream as a target.
PipeTargetParameters.Builder	sqsQueueParameters(PipeTargetSqsQueueParameters sqsQueueParameters)	The parameters for using a Amazon SQS stream as a target.
default PipeTargetParameters.Builder	stepFunctionStateMachineParameters(Consumer<PipeTargetStateMachineParameters.Builder> stepFunctionStateMachineParameters)	The parameters for using a Step Functions state machine as a target.
PipeTargetParameters.Builder	stepFunctionStateMachineParameters(PipeTargetStateMachineParameters stepFunctionStateMachineParameters)	The parameters for using a Step Functions state machine as a target.
default PipeTargetParameters.Builder	timestreamParameters(Consumer<PipeTargetTimestreamParameters.Builder> timestreamParameters)	The parameters for using a Timestream for LiveAnalytics table as a target.
PipeTargetParameters.Builder	timestreamParameters(PipeTargetTimestreamParameters timestreamParameters)	The parameters for using a Timestream for LiveAnalytics table as a target.

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Method Details

inputTemplate

PipeTargetParameters.Builder inputTemplate(String 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

lambdaFunctionParameters

PipeTargetParameters.Builder lambdaFunctionParameters(PipeTargetLambdaFunctionParameters lambdaFunctionParameters)

The parameters for using a Lambda function as a target.

Parameters:

lambdaFunctionParameters - The parameters for using a Lambda function as a target.

Returns:

Returns a reference to this object so that method calls can be chained together.

lambdaFunctionParameters

default PipeTargetParameters.Builder lambdaFunctionParameters(Consumer<PipeTargetLambdaFunctionParameters.Builder> lambdaFunctionParameters)

The parameters for using a Lambda function as a target.

This is a convenience method that creates an instance of the PipeTargetLambdaFunctionParameters.Builder avoiding the need to create one manually via PipeTargetLambdaFunctionParameters.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to lambdaFunctionParameters(PipeTargetLambdaFunctionParameters).

Parameters:

lambdaFunctionParameters - a consumer that will call methods on PipeTargetLambdaFunctionParameters.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• lambdaFunctionParameters(PipeTargetLambdaFunctionParameters)

stepFunctionStateMachineParameters

PipeTargetParameters.Builder stepFunctionStateMachineParameters(PipeTargetStateMachineParameters stepFunctionStateMachineParameters)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

stepFunctionStateMachineParameters

default PipeTargetParameters.Builder stepFunctionStateMachineParameters(Consumer<PipeTargetStateMachineParameters.Builder> stepFunctionStateMachineParameters)

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

This is a convenience method that creates an instance of the PipeTargetStateMachineParameters.Builder avoiding the need to create one manually via PipeTargetStateMachineParameters.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to stepFunctionStateMachineParameters(PipeTargetStateMachineParameters).

Parameters:

stepFunctionStateMachineParameters - a consumer that will call methods on PipeTargetStateMachineParameters.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• stepFunctionStateMachineParameters(PipeTargetStateMachineParameters)

kinesisStreamParameters

PipeTargetParameters.Builder kinesisStreamParameters(PipeTargetKinesisStreamParameters kinesisStreamParameters)

The parameters for using a Kinesis stream as a target.

Parameters:

kinesisStreamParameters - The parameters for using a Kinesis stream as a target.

Returns:

Returns a reference to this object so that method calls can be chained together.

kinesisStreamParameters

default PipeTargetParameters.Builder kinesisStreamParameters(Consumer<PipeTargetKinesisStreamParameters.Builder> kinesisStreamParameters)

The parameters for using a Kinesis stream as a target.

This is a convenience method that creates an instance of the PipeTargetKinesisStreamParameters.Builder avoiding the need to create one manually via PipeTargetKinesisStreamParameters.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to kinesisStreamParameters(PipeTargetKinesisStreamParameters).

Parameters:

kinesisStreamParameters - a consumer that will call methods on PipeTargetKinesisStreamParameters.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• kinesisStreamParameters(PipeTargetKinesisStreamParameters)

ecsTaskParameters

PipeTargetParameters.Builder ecsTaskParameters(PipeTargetEcsTaskParameters ecsTaskParameters)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

ecsTaskParameters

default PipeTargetParameters.Builder ecsTaskParameters(Consumer<PipeTargetEcsTaskParameters.Builder> ecsTaskParameters)

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

This is a convenience method that creates an instance of the PipeTargetEcsTaskParameters.Builder avoiding the need to create one manually via PipeTargetEcsTaskParameters.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to ecsTaskParameters(PipeTargetEcsTaskParameters).

Parameters:

ecsTaskParameters - a consumer that will call methods on PipeTargetEcsTaskParameters.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• ecsTaskParameters(PipeTargetEcsTaskParameters)

batchJobParameters

PipeTargetParameters.Builder batchJobParameters(PipeTargetBatchJobParameters batchJobParameters)

The parameters for using an Batch job as a target.

Parameters:

batchJobParameters - The parameters for using an Batch job as a target.

Returns:

Returns a reference to this object so that method calls can be chained together.

batchJobParameters

default PipeTargetParameters.Builder batchJobParameters(Consumer<PipeTargetBatchJobParameters.Builder> batchJobParameters)

The parameters for using an Batch job as a target.

This is a convenience method that creates an instance of the PipeTargetBatchJobParameters.Builder avoiding the need to create one manually via PipeTargetBatchJobParameters.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to batchJobParameters(PipeTargetBatchJobParameters).

Parameters:

batchJobParameters - a consumer that will call methods on PipeTargetBatchJobParameters.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• batchJobParameters(PipeTargetBatchJobParameters)

sqsQueueParameters

PipeTargetParameters.Builder sqsQueueParameters(PipeTargetSqsQueueParameters sqsQueueParameters)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

sqsQueueParameters

default PipeTargetParameters.Builder sqsQueueParameters(Consumer<PipeTargetSqsQueueParameters.Builder> sqsQueueParameters)

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

This is a convenience method that creates an instance of the PipeTargetSqsQueueParameters.Builder avoiding the need to create one manually via PipeTargetSqsQueueParameters.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to sqsQueueParameters(PipeTargetSqsQueueParameters).

Parameters:

sqsQueueParameters - a consumer that will call methods on PipeTargetSqsQueueParameters.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• sqsQueueParameters(PipeTargetSqsQueueParameters)

httpParameters

PipeTargetParameters.Builder httpParameters(PipeTargetHttpParameters httpParameters)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

httpParameters

default PipeTargetParameters.Builder httpParameters(Consumer<PipeTargetHttpParameters.Builder> httpParameters)

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

This is a convenience method that creates an instance of the PipeTargetHttpParameters.Builder avoiding the need to create one manually via PipeTargetHttpParameters.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to httpParameters(PipeTargetHttpParameters).

Parameters:

httpParameters - a consumer that will call methods on PipeTargetHttpParameters.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• httpParameters(PipeTargetHttpParameters)

redshiftDataParameters

PipeTargetParameters.Builder redshiftDataParameters(PipeTargetRedshiftDataParameters redshiftDataParameters)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

redshiftDataParameters

default PipeTargetParameters.Builder redshiftDataParameters(Consumer<PipeTargetRedshiftDataParameters.Builder> redshiftDataParameters)

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

This is a convenience method that creates an instance of the PipeTargetRedshiftDataParameters.Builder avoiding the need to create one manually via PipeTargetRedshiftDataParameters.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to redshiftDataParameters(PipeTargetRedshiftDataParameters).

Parameters:

redshiftDataParameters - a consumer that will call methods on PipeTargetRedshiftDataParameters.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• redshiftDataParameters(PipeTargetRedshiftDataParameters)

sageMakerPipelineParameters

PipeTargetParameters.Builder sageMakerPipelineParameters(PipeTargetSageMakerPipelineParameters sageMakerPipelineParameters)

The parameters for using a SageMaker pipeline as a target.

Parameters:

sageMakerPipelineParameters - The parameters for using a SageMaker pipeline as a target.

Returns:

Returns a reference to this object so that method calls can be chained together.

sageMakerPipelineParameters

default PipeTargetParameters.Builder sageMakerPipelineParameters(Consumer<PipeTargetSageMakerPipelineParameters.Builder> sageMakerPipelineParameters)

The parameters for using a SageMaker pipeline as a target.

This is a convenience method that creates an instance of the PipeTargetSageMakerPipelineParameters.Builder avoiding the need to create one manually via PipeTargetSageMakerPipelineParameters.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to sageMakerPipelineParameters(PipeTargetSageMakerPipelineParameters).

Parameters:

sageMakerPipelineParameters - a consumer that will call methods on PipeTargetSageMakerPipelineParameters.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• sageMakerPipelineParameters(PipeTargetSageMakerPipelineParameters)

eventBridgeEventBusParameters

PipeTargetParameters.Builder eventBridgeEventBusParameters(PipeTargetEventBridgeEventBusParameters eventBridgeEventBusParameters)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

eventBridgeEventBusParameters

default PipeTargetParameters.Builder eventBridgeEventBusParameters(Consumer<PipeTargetEventBridgeEventBusParameters.Builder> eventBridgeEventBusParameters)

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

This is a convenience method that creates an instance of the PipeTargetEventBridgeEventBusParameters.Builder avoiding the need to create one manually via PipeTargetEventBridgeEventBusParameters.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to eventBridgeEventBusParameters(PipeTargetEventBridgeEventBusParameters).

Parameters:

eventBridgeEventBusParameters - a consumer that will call methods on PipeTargetEventBridgeEventBusParameters.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• eventBridgeEventBusParameters(PipeTargetEventBridgeEventBusParameters)

cloudWatchLogsParameters

PipeTargetParameters.Builder cloudWatchLogsParameters(PipeTargetCloudWatchLogsParameters cloudWatchLogsParameters)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

cloudWatchLogsParameters

default PipeTargetParameters.Builder cloudWatchLogsParameters(Consumer<PipeTargetCloudWatchLogsParameters.Builder> cloudWatchLogsParameters)

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

This is a convenience method that creates an instance of the PipeTargetCloudWatchLogsParameters.Builder avoiding the need to create one manually via PipeTargetCloudWatchLogsParameters.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to cloudWatchLogsParameters(PipeTargetCloudWatchLogsParameters).

Parameters:

cloudWatchLogsParameters - a consumer that will call methods on PipeTargetCloudWatchLogsParameters.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• cloudWatchLogsParameters(PipeTargetCloudWatchLogsParameters)

timestreamParameters

PipeTargetParameters.Builder timestreamParameters(PipeTargetTimestreamParameters timestreamParameters)

The parameters for using a Timestream for LiveAnalytics table as a target.

Parameters:

timestreamParameters - The parameters for using a Timestream for LiveAnalytics table as a target.

Returns:

Returns a reference to this object so that method calls can be chained together.

timestreamParameters

default PipeTargetParameters.Builder timestreamParameters(Consumer<PipeTargetTimestreamParameters.Builder> timestreamParameters)

The parameters for using a Timestream for LiveAnalytics table as a target.

This is a convenience method that creates an instance of the PipeTargetTimestreamParameters.Builder avoiding the need to create one manually via PipeTargetTimestreamParameters.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to timestreamParameters(PipeTargetTimestreamParameters).

Parameters:

timestreamParameters - a consumer that will call methods on PipeTargetTimestreamParameters.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• timestreamParameters(PipeTargetTimestreamParameters)