2.233.0

interface PipeSourceManagedStreamingKafkaParametersProperty

LanguageType name
.NETAmazon.CDK.Mixins.Preview.AWS.Pipes.Mixins.CfnPipePropsMixin.PipeSourceManagedStreamingKafkaParametersProperty
Gogithub.com/aws/aws-cdk-go/awscdkmixinspreview/v2/awspipes/mixins#CfnPipePropsMixin_PipeSourceManagedStreamingKafkaParametersProperty
Javasoftware.amazon.awscdk.mixins.preview.services.pipes.mixins.CfnPipePropsMixin.PipeSourceManagedStreamingKafkaParametersProperty
Pythonaws_cdk.mixins_preview.aws_pipes.mixins.CfnPipePropsMixin.PipeSourceManagedStreamingKafkaParametersProperty
TypeScript @aws-cdk/mixins-preview » aws_pipes » mixins » CfnPipePropsMixin » 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 { mixins as pipes_mixins } from '@aws-cdk/mixins-preview/aws-pipes';
const pipeSourceManagedStreamingKafkaParametersProperty: pipes_mixins.CfnPipePropsMixin.PipeSourceManagedStreamingKafkaParametersProperty = {
  batchSize: 123,
  consumerGroupId: 'consumerGroupId',
  credentials: {
    clientCertificateTlsAuth: 'clientCertificateTlsAuth',
    saslScram512Auth: 'saslScram512Auth',
  },
  maximumBatchingWindowInSeconds: 123,
  startingPosition: 'startingPosition',
  topicName: 'topicName',
};

Properties

NameTypeDescription
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?stringThe position in a stream from which to start reading.
topicName?stringThe name of the topic that the pipe will read from.

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

topicName?

Type: string (optional)

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

← PreviousNext →