interface PipeSourceSelfManagedKafkaParametersProperty

Language	Type name
.NET	`Amazon.CDK.AWS.Pipes.CfnPipe.PipeSourceSelfManagedKafkaParametersProperty`
Java	`software.amazon.awscdk.services.pipes.CfnPipe.PipeSourceSelfManagedKafkaParametersProperty`
Python	`aws_cdk.aws_pipes.CfnPipe.PipeSourceSelfManagedKafkaParametersProperty`
TypeScript	`@aws-cdk/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 * as pipes from '@aws-cdk/aws-pipes';
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

Name	Type	Description
topicName	`string`	The name of the topic that the pipe will read from.
additionalBootstrapServers?	`string[]`	An array of server URLs.
batchSize?	`number`	The maximum number of records to include in each batch.
consumerGroupId?	`string`	The name of the destination queue to consume.
credentials?	`IResolvable` `\|` `SelfManagedKafkaAccessConfigurationCredentialsProperty`	The credentials needed to access the resource.
maximumBatchingWindowInSeconds?	`number`	The maximum length of a time to wait for events.
serverRootCaCertificate?	`string`	The 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` `\|` `SelfManagedKafkaAccessConfigurationVpcProperty`	This 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.