PipeSourceSelfManagedKafkaParametersProperty Struct
The parameters for using a self-managed Apache Kafka stream as a source.
A self managed cluster refers to any Apache Kafka cluster not hosted by AWS . This includes both clusters you manage yourself, as well as those hosted by a third-party provider, such as Confluent Cloud , CloudKarafka , or Redpanda . For more information, see Apache Kafka streams as a source in the Amazon EventBridge User Guide .
Example
ts
// 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
additionalBootstrapServersoptionalstring[]additional_bootstrap_serversoptionaltyping.List[str]additionalBootstrapServersoptionalList<String>AdditionalBootstrapServersoptionalstring[]AdditionalBootstrapServersoptional*[]*string#An array of server URLs.
batchSizeoptionalnumberbatch_sizeoptionalint | floatbatchSizeoptionalNumberBatchSizeoptionaldoubleBatchSizeoptional*float64#The maximum number of records to include in each batch.
consumerGroupIdoptionalstringconsumer_group_idoptionalstrconsumerGroupIdoptionalStringConsumerGroupIdoptionalstringConsumerGroupIdoptional*string#The name of the destination queue to consume.
credentialsoptionalIResolvable | CfnPipe.SelfManagedKafkaAccessConfigurationCredentialsPropertycredentialsoptionaltyping.Union[IResolvable, SelfManagedKafkaAccessConfigurationCredentialsProperty]credentialsoptionalIResolvableCredentialsoptionalIResolvableCredentialsoptionalinterface{}#The credentials needed to access the resource.
maximumBatchingWindowInSecondsoptionalnumbermaximum_batching_window_in_secondsoptionalint | floatmaximumBatchingWindowInSecondsoptionalNumberMaximumBatchingWindowInSecondsoptionaldoubleMaximumBatchingWindowInSecondsoptional*float64#The maximum length of a time to wait for events.
serverRootCaCertificateoptionalstringserver_root_ca_certificateoptionalstrserverRootCaCertificateoptionalStringServerRootCaCertificateoptionalstringServerRootCaCertificateoptional*string#The ARN of the Secrets Manager secret used for certification.
startingPositionoptionalstringstarting_positionoptionalstrstartingPositionoptionalStringStartingPositionoptionalstringStartingPositionoptional*string#The position in a stream from which to start reading.
The name of the topic that the pipe will read from.
vpcoptionalIResolvable | CfnPipe.SelfManagedKafkaAccessConfigurationVpcPropertyvpcoptionaltyping.Union[IResolvable, SelfManagedKafkaAccessConfigurationVpcProperty]vpcoptionalIResolvableVpcoptionalIResolvableVpcoptionalinterface{}#This structure specifies the VPC subnets and security groups for the stream, and whether a public IP address is to be used.