aws-cdk-lib.aws_pipes.CfnPipe.PipeSourceManagedStreamingKafkaParametersProperty

interface PipeSourceManagedStreamingKafkaParametersProperty

LanguageType name
.NETAmazon.CDK.AWS.Pipes.CfnPipe.PipeSourceManagedStreamingKafkaParametersProperty
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awspipes#CfnPipe_PipeSourceManagedStreamingKafkaParametersProperty
Javasoftware.amazon.awscdk.services.pipes.CfnPipe.PipeSourceManagedStreamingKafkaParametersProperty
Pythonaws_cdk.aws_pipes.CfnPipe.PipeSourceManagedStreamingKafkaParametersProperty
TypeScript aws-cdk-lib » aws_pipes » CfnPipe » PipeSourceManagedStreamingKafkaParametersProperty

The parameters for using an MSK stream as a source.

Example

// 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 pipeSourceManagedStreamingKafkaParametersProperty: pipes.CfnPipe.PipeSourceManagedStreamingKafkaParametersProperty = {
  topicName: 'topicName',

  // the properties below are optional
  batchSize: 123,
  consumerGroupId: 'consumerGroupId',
  credentials: {
    clientCertificateTlsAuth: 'clientCertificateTlsAuth',
    saslScram512Auth: 'saslScram512Auth',
  },
  maximumBatchingWindowInSeconds: 123,
  startingPosition: 'startingPosition',
};

Properties

NameTypeDescription
topicNamestringThe name of the topic that the pipe will read from.
batchSize?numberThe maximum number of records to include in each batch.
consumerGroupId?stringThe name of the destination queue to consume.
credentials?IResolvable | MSKAccessCredentialsPropertyThe credentials needed to access the resource.
maximumBatchingWindowInSeconds?numberThe maximum length of a time to wait for events.
startingPosition?string(Streams only) The position in a stream from which to start reading.

topicName

Type: string

The name of the topic that the pipe will read from.


batchSize?

Type: number (optional)

The maximum number of records to include in each batch.


consumerGroupId?

Type: string (optional)

The name of the destination queue to consume.


credentials?

Type: IResolvable | MSKAccessCredentialsProperty (optional)

The credentials needed to access the resource.


maximumBatchingWindowInSeconds?

Type: number (optional)

The maximum length of a time to wait for events.


startingPosition?

Type: string (optional)

(Streams only) The position in a stream from which to start reading.