interface PipeSourceSelfManagedKafkaParametersProperty
Language | Type name |
---|---|
.NET | Amazon.CDK.AWS.Pipes.CfnPipe.PipeSourceSelfManagedKafkaParametersProperty |
Go | github.com/aws/aws-cdk-go/awscdk/v2/awspipes#CfnPipe_PipeSourceSelfManagedKafkaParametersProperty |
Java | software.amazon.awscdk.services.pipes.CfnPipe.PipeSourceSelfManagedKafkaParametersProperty |
Python | aws_cdk.aws_pipes.CfnPipe.PipeSourceSelfManagedKafkaParametersProperty |
TypeScript | aws-cdk-lib » aws_pipes » CfnPipe » PipeSourceSelfManagedKafkaParametersProperty |
The parameters for using a 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
// 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
Name | Type | Description |
---|---|---|
topic | string | The name of the topic that the pipe will read from. |
additional | string[] | An array of server URLs. |
batch | number | The maximum number of records to include in each batch. |
consumer | string | The name of the destination queue to consume. |
credentials? | IResolvable | Self | The credentials needed to access the resource. |
maximum | number | The maximum length of a time to wait for events. |
server | string | The ARN of the Secrets Manager secret used for certification. |
starting | string | (Streams only) The position in a stream from which to start reading. |
vpc? | IResolvable | Self | 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
|
Self
(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
|
Self
(optional)
This structure specifies the VPC subnets and security groups for the stream, and whether a public IP address is to be used.