# PipeSourceParametersProperty

The parameters required to set up a source for your pipe.

- Source: Generated code
- Type last changed: v2.93.0 · 23 Aug 2023

## 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

- `activeMqBrokerParameters`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnPipe.PipeSourceActiveMQBrokerParametersProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_pipes.CfnPipe.PipeSourceActiveMQBrokerParametersProperty.html) — The parameters for using an Active MQ broker as a source.

- `dynamoDbStreamParameters`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnPipe.PipeSourceDynamoDBStreamParametersProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_pipes.CfnPipe.PipeSourceDynamoDBStreamParametersProperty.html) — The parameters for using a DynamoDB stream as a source.

- `filterCriteria`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnPipe.FilterCriteriaProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_pipes.CfnPipe.FilterCriteriaProperty.html) — The collection of event patterns used to filter events.

  To remove a filter, specify a `FilterCriteria` object with an empty array of `Filter` objects.

  For more information, see [Events and Event Patterns](https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html) in the *Amazon EventBridge User Guide* .

- `kinesisStreamParameters`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnPipe.PipeSourceKinesisStreamParametersProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_pipes.CfnPipe.PipeSourceKinesisStreamParametersProperty.html) — The parameters for using a Kinesis stream as a source.

- `managedStreamingKafkaParameters`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnPipe.PipeSourceManagedStreamingKafkaParametersProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_pipes.CfnPipe.PipeSourceManagedStreamingKafkaParametersProperty.html) — The parameters for using an MSK stream as a source.

- `rabbitMqBrokerParameters`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnPipe.PipeSourceRabbitMQBrokerParametersProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_pipes.CfnPipe.PipeSourceRabbitMQBrokerParametersProperty.html) — The parameters for using a Rabbit MQ broker as a source.

- `selfManagedKafkaParameters`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnPipe.PipeSourceSelfManagedKafkaParametersProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_pipes.CfnPipe.PipeSourceSelfManagedKafkaParametersProperty.html) — The parameters for using a self-managed Apache Kafka stream as a source.

  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](https://docs.aws.amazon.com/https://www.confluent.io/) , [CloudKarafka](https://docs.aws.amazon.com/https://www.cloudkarafka.com/) , or [Redpanda](https://docs.aws.amazon.com/https://redpanda.com/) . For more information, see [Apache Kafka streams as a source](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-pipes-kafka.html) in the *Amazon EventBridge User Guide* .

- `sqsQueueParameters`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnPipe.PipeSourceSqsQueueParametersProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_pipes.CfnPipe.PipeSourceSqsQueueParametersProperty.html) — The parameters for using a Amazon SQS stream as a source.