aws-cdk-lib.aws_pipes.CfnPipe.PipeSourceSelfManagedKafkaParametersProperty

interface PipeSourceSelfManagedKafkaParametersProperty

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

The parameters for using a self-managed Apache Kafka 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 pipeSourceSelfManagedKafkaParametersProperty: pipes.CfnPipe.PipeSourceSelfManagedKafkaParametersProperty = {
  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'],
  },
};

Properties

NameTypeDescription
topicNamestringThe name of the topic that the pipe will read from.
additionalBootstrapServers?string[]An array of server URLs.
batchSize?numberThe maximum number of records to include in each batch.
consumerGroupId?stringThe name of the destination queue to consume.
credentials?IResolvable | SelfManagedKafkaAccessConfigurationCredentialsPropertyThe credentials needed to access the resource.
maximumBatchingWindowInSeconds?numberThe maximum length of a time to wait for events.
serverRootCaCertificate?stringThe ARN of the Secrets Manager secret used for certification.
startingPosition?string(Streams only) The position in a stream from which to start reading.
vpc?IResolvable | SelfManagedKafkaAccessConfigurationVpcPropertyThis structure specifies the VPC subnets and security groups for the stream, and whether a public IP address is to be used.

topicName

Type: string

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


additionalBootstrapServers?

Type: string[] (optional)

An array of server URLs.


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 | SelfManagedKafkaAccessConfigurationCredentialsProperty (optional)

The credentials needed to access the resource.


maximumBatchingWindowInSeconds?

Type: number (optional)

The maximum length of a time to wait for events.


serverRootCaCertificate?

Type: string (optional)

The ARN of the Secrets Manager secret used for certification.


startingPosition?

Type: string (optional)

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


vpc?

Type: IResolvable | SelfManagedKafkaAccessConfigurationVpcProperty (optional)

This structure specifies the VPC subnets and security groups for the stream, and whether a public IP address is to be used.