AWS CDK Reference

Appearance

v2.275.0

Experimental

@aws-cdk/aws-pipes-alpha is an experimental (alpha) package: its API may change in any release, without a major version bump.

SourceConfig Struct ​

Source properties.

Stability
Experimental
Source
lib/source.ts

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as pipes_alpha from '@aws-cdk/aws-pipes-alpha';
const sourceConfig: pipes_alpha.SourceConfig = {
  sourceParameters: {
    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,
    },
    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 ​

sourceParametersoptionalSourceParameterssource_parametersoptionalSourceParameterssourceParametersoptionalSourceParametersSourceParametersoptionalSourceParametersSourceParametersoptionalSourceParameters= none#
The parameters required to set up a source for your pipe.