PipeSourceParametersProperty Struct
The parameters required to set up a source for your pipe.
Example
ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_pipes as pipes } from 'aws-cdk-lib';
const pipeSourceParametersProperty: pipes.CfnPipe.PipeSourceParametersProperty = {
activeMqBrokerParameters: {
credentials: {
basicAuth: 'basicAuth',
},
queueName: 'queueName',
// the properties below are optional
batchSize: 123,
maximumBatchingWindowInSeconds: 123,
},
dynamoDbStreamParameters: {
startingPosition: 'startingPosition',
// the properties below are optional
batchSize: 123,
deadLetterConfig: {
arn: 'arn',
},
maximumBatchingWindowInSeconds: 123,
maximumRecordAgeInSeconds: 123,
maximumRetryAttempts: 123,
onPartialBatchItemFailure: 'onPartialBatchItemFailure',
parallelizationFactor: 123,
},
filterCriteria: {
filters: [{
pattern: 'pattern',
}],
},
kinesisStreamParameters: {
startingPosition: 'startingPosition',
// the properties below are optional
batchSize: 123,
deadLetterConfig: {
arn: 'arn',
},
maximumBatchingWindowInSeconds: 123,
maximumRecordAgeInSeconds: 123,
maximumRetryAttempts: 123,
onPartialBatchItemFailure: 'onPartialBatchItemFailure',
parallelizationFactor: 123,
startingPositionTimestamp: 'startingPositionTimestamp',
},
managedStreamingKafkaParameters: {
topicName: 'topicName',
// the properties below are optional
batchSize: 123,
consumerGroupId: 'consumerGroupId',
credentials: {
clientCertificateTlsAuth: 'clientCertificateTlsAuth',
saslScram512Auth: 'saslScram512Auth',
},
maximumBatchingWindowInSeconds: 123,
startingPosition: 'startingPosition',
},
rabbitMqBrokerParameters: {
credentials: {
basicAuth: 'basicAuth',
},
queueName: 'queueName',
// the properties below are optional
batchSize: 123,
maximumBatchingWindowInSeconds: 123,
virtualHost: 'virtualHost',
},
selfManagedKafkaParameters: {
topicName: 'topicName',
// the properties below are optional
additionalBootstrapServers: ['additionalBootstrapServers'],
batchSize: 123,
consumerGroupId: 'consumerGroupId',
credentials: {
basicAuth: 'basicAuth',
clientCertificateTlsAuth: 'clientCertificateTlsAuth',
saslScram256Auth: 'saslScram256Auth',
saslScram512Auth: 'saslScram512Auth',
},
maximumBatchingWindowInSeconds: 123,
serverRootCaCertificate: 'serverRootCaCertificate',
startingPosition: 'startingPosition',
vpc: {
securityGroup: ['securityGroup'],
subnets: ['subnets'],
},
},
sqsQueueParameters: {
batchSize: 123,
maximumBatchingWindowInSeconds: 123,
},
};
Properties
activeMqBrokerParametersIResolvable | CfnPipe.PipeSourceActiveMQBrokerParametersPropertyactive_mq_broker_parameterstyping.Union[IResolvable, PipeSourceActiveMQBrokerParametersProperty]activeMqBrokerParametersIResolvableActiveMqBrokerParametersIResolvableActiveMqBrokerParametersinterface{}#The parameters for using an Active MQ broker as a source.
dynamoDbStreamParametersIResolvable | CfnPipe.PipeSourceDynamoDBStreamParametersPropertydynamo_db_stream_parameterstyping.Union[IResolvable, PipeSourceDynamoDBStreamParametersProperty]dynamoDbStreamParametersIResolvableDynamoDbStreamParametersIResolvableDynamoDbStreamParametersinterface{}#The parameters for using a DynamoDB stream as a source.
filterCriteriaIResolvable | CfnPipe.FilterCriteriaPropertyfilter_criteriatyping.Union[IResolvable, FilterCriteriaProperty]filterCriteriaIResolvableFilterCriteriaIResolvableFilterCriteriainterface{}#The collection of event patterns used to filter events.
notes
To remove a filter, specify a FilterCriteria object with an empty array of Filter objects.
For more information, see Events and Event Patterns in the Amazon EventBridge User Guide .
kinesisStreamParametersIResolvable | CfnPipe.PipeSourceKinesisStreamParametersPropertykinesis_stream_parameterstyping.Union[IResolvable, PipeSourceKinesisStreamParametersProperty]kinesisStreamParametersIResolvableKinesisStreamParametersIResolvableKinesisStreamParametersinterface{}#The parameters for using a Kinesis stream as a source.
managedStreamingKafkaParametersIResolvable | CfnPipe.PipeSourceManagedStreamingKafkaParametersPropertymanaged_streaming_kafka_parameterstyping.Union[IResolvable, PipeSourceManagedStreamingKafkaParametersProperty]managedStreamingKafkaParametersIResolvableManagedStreamingKafkaParametersIResolvableManagedStreamingKafkaParametersinterface{}#The parameters for using an MSK stream as a source.
rabbitMqBrokerParametersIResolvable | CfnPipe.PipeSourceRabbitMQBrokerParametersPropertyrabbit_mq_broker_parameterstyping.Union[IResolvable, PipeSourceRabbitMQBrokerParametersProperty]rabbitMqBrokerParametersIResolvableRabbitMqBrokerParametersIResolvableRabbitMqBrokerParametersinterface{}#The parameters for using a Rabbit MQ broker as a source.
selfManagedKafkaParametersIResolvable | CfnPipe.PipeSourceSelfManagedKafkaParametersPropertyself_managed_kafka_parameterstyping.Union[IResolvable, PipeSourceSelfManagedKafkaParametersProperty]selfManagedKafkaParametersIResolvableSelfManagedKafkaParametersIResolvableSelfManagedKafkaParametersinterface{}#The parameters for using a self-managed Apache Kafka stream as a source.
notes
A self managed cluster refers to any Apache Kafka cluster not hosted by AWS . This includes both clusters you manage yourself, as well as those hosted by a third-party provider, such as Confluent Cloud , CloudKarafka , or Redpanda . For more information, see Apache Kafka streams as a source in the Amazon EventBridge User Guide .
sqsQueueParametersIResolvable | CfnPipe.PipeSourceSqsQueueParametersPropertysqs_queue_parameterstyping.Union[IResolvable, PipeSourceSqsQueueParametersProperty]sqsQueueParametersIResolvableSqsQueueParametersIResolvableSqsQueueParametersinterface{}#The parameters for using a Amazon SQS stream as a source.