Package software.amazon.awscdk.services.pipes.alpha

Interface SourceParameters

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

SourceParameters.Jsii$Proxy

@Generated(value="jsii-pacmak/1.113.0 (build fc68b25)",
           date="2025-09-02T11:25:43.420Z")
@Stability(Experimental)
public interface SourceParameters
extends software.amazon.jsii.JsiiSerializable

(experimental) Source properties.

Example:

 Queue sourceQueue;
 IFunction targetFunction;
 LambdaFunction pipeTarget = LambdaFunction.Builder.create(targetFunction)
         .invocationType(LambdaFunctionInvocationType.FIRE_AND_FORGET)
         .build();
 Pipe pipe = Pipe.Builder.create(this, "Pipe")
         .source(new SqsSource(sourceQueue))
         .target(pipeTarget)
         .build();
 

See Also:

• https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-pipes-event-source.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static SourceParameters.Builder	builder()
default CfnPipe.PipeSourceActiveMQBrokerParametersProperty	getActiveMqBrokerParameters()	(experimental) ActiveMQBroker configuration parameters.
default CfnPipe.PipeSourceDynamoDBStreamParametersProperty	getDynamoDbStreamParameters()	(experimental) DynamoDB stream configuration parameters.
default CfnPipe.PipeSourceKinesisStreamParametersProperty	getKinesisStreamParameters()	(experimental) Kinesis stream configuration parameters.
default CfnPipe.PipeSourceManagedStreamingKafkaParametersProperty	getManagedStreamingKafkaParameters()	(experimental) Managed streaming Kafka configuration parameters.
default CfnPipe.PipeSourceRabbitMQBrokerParametersProperty	getRabbitMqBrokerParameters()	(experimental) RabbitMQ broker configuration parameters.
default CfnPipe.PipeSourceSelfManagedKafkaParametersProperty	getSelfManagedKafkaParameters()	(experimental) Self-managed Kafka configuration parameters.
default CfnPipe.PipeSourceSqsQueueParametersProperty	getSqsQueueParameters()	(experimental) SQS queue configuration parameters.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getActiveMqBrokerParameters

@Stability(Experimental)
@Nullable
default CfnPipe.PipeSourceActiveMQBrokerParametersProperty getActiveMqBrokerParameters()

(experimental) ActiveMQBroker configuration parameters.

Default: - none

See Also:

• https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-pipes-mq.html

getDynamoDbStreamParameters

@Stability(Experimental)
@Nullable
default CfnPipe.PipeSourceDynamoDBStreamParametersProperty getDynamoDbStreamParameters()

(experimental) DynamoDB stream configuration parameters.

Default: - none

See Also:

• https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-pipes-dynamodb.html

getKinesisStreamParameters

@Stability(Experimental)
@Nullable
default CfnPipe.PipeSourceKinesisStreamParametersProperty getKinesisStreamParameters()

(experimental) Kinesis stream configuration parameters.

Default: - none

See Also:

• https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-pipes-kinesis.html

getManagedStreamingKafkaParameters

@Stability(Experimental)
@Nullable
default CfnPipe.PipeSourceManagedStreamingKafkaParametersProperty getManagedStreamingKafkaParameters()

(experimental) Managed streaming Kafka configuration parameters.

Default: - none

See Also:

• https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-pipes-msk.html

getRabbitMqBrokerParameters

@Stability(Experimental)
@Nullable
default CfnPipe.PipeSourceRabbitMQBrokerParametersProperty getRabbitMqBrokerParameters()

(experimental) RabbitMQ broker configuration parameters.

Default: - none

See Also:

• https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-pipes-mq.html

getSelfManagedKafkaParameters

@Stability(Experimental)
@Nullable
default CfnPipe.PipeSourceSelfManagedKafkaParametersProperty getSelfManagedKafkaParameters()

(experimental) Self-managed Kafka configuration parameters.

Default: - none

See Also:

• https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-pipes-kafka.html

getSqsQueueParameters

@Stability(Experimental)
@Nullable
default CfnPipe.PipeSourceSqsQueueParametersProperty getSqsQueueParameters()

(experimental) SQS queue configuration parameters.

Default: - none

See Also:

• https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-pipes-sqs.html

builder

@Stability(Experimental)
static SourceParameters.Builder builder()

Returns:

a SourceParameters.Builder of SourceParameters