interface PipeSourceManagedStreamingKafkaParametersProperty

Language	Type name
.NET	Amazon.CDK.AWS.Pipes.CfnPipe.PipeSourceManagedStreamingKafkaParametersProperty
Go	github.com/aws/aws-cdk-go/awscdk/v2/awspipes#CfnPipe_PipeSourceManagedStreamingKafkaParametersProperty
Java	software.amazon.awscdk.services.pipes.CfnPipe.PipeSourceManagedStreamingKafkaParametersProperty
Python	aws_cdk.aws_pipes.CfnPipe.PipeSourceManagedStreamingKafkaParametersProperty
TypeScript	aws-cdk-lib » aws_pipes » CfnPipe » PipeSourceManagedStreamingKafkaParametersProperty

The parameters for using an MSK stream as a source.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipesourcemanagedstreamingkafkaparameters.html

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

Name	Type	Description
topicName	string	The name of the topic that the pipe will read from.
batchSize?	number	The maximum number of records to include in each batch.
consumerGroupId?	string	The name of the destination queue to consume.
credentials?	IResolvable | MSKAccessCredentialsProperty	The credentials needed to access the resource.
maximumBatchingWindowInSeconds?	number	The maximum length of a time to wait for events.
startingPosition?	string	The position in a stream from which to start reading.

---

topicName

Type: string

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

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipesourcemanagedstreamingkafkaparameters.html#cfn-pipes-pipe-pipesourcemanagedstreamingkafkaparameters-topicname

---

batchSize?

Type: number (optional)

The maximum number of records to include in each batch.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipesourcemanagedstreamingkafkaparameters.html#cfn-pipes-pipe-pipesourcemanagedstreamingkafkaparameters-batchsize

---

consumerGroupId?

Type: string (optional)

The name of the destination queue to consume.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipesourcemanagedstreamingkafkaparameters.html#cfn-pipes-pipe-pipesourcemanagedstreamingkafkaparameters-consumergroupid

---

credentials?

Type: IResolvable | MSKAccessCredentialsProperty (optional)

The credentials needed to access the resource.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipesourcemanagedstreamingkafkaparameters.html#cfn-pipes-pipe-pipesourcemanagedstreamingkafkaparameters-credentials

---

maximumBatchingWindowInSeconds?

Type: number (optional)

The maximum length of a time to wait for events.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipesourcemanagedstreamingkafkaparameters.html#cfn-pipes-pipe-pipesourcemanagedstreamingkafkaparameters-maximumbatchingwindowinseconds

---

startingPosition?

Type: string (optional)

The position in a stream from which to start reading.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipesourcemanagedstreamingkafkaparameters.html#cfn-pipes-pipe-pipesourcemanagedstreamingkafkaparameters-startingposition