Interface CfnPipe.IPipeSourceSelfManagedKafkaParametersProperty
The parameters for using a self-managed Apache Kafka stream as a source.
Namespace: Amazon.CDK.AWS.Pipes
Assembly: Amazon.CDK.AWS.Pipes.dll
Syntax (csharp)
public interface IPipeSourceSelfManagedKafkaParametersProperty
Syntax (vb)
Public Interface IPipeSourceSelfManagedKafkaParametersProperty
Remarks
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.Pipes;
var pipeSourceSelfManagedKafkaParametersProperty = new PipeSourceSelfManagedKafkaParametersProperty {
TopicName = "topicName",
// the properties below are optional
AdditionalBootstrapServers = new [] { "additionalBootstrapServers" },
BatchSize = 123,
ConsumerGroupId = "consumerGroupId",
Credentials = new SelfManagedKafkaAccessConfigurationCredentialsProperty {
BasicAuth = "basicAuth",
ClientCertificateTlsAuth = "clientCertificateTlsAuth",
SaslScram256Auth = "saslScram256Auth",
SaslScram512Auth = "saslScram512Auth"
},
MaximumBatchingWindowInSeconds = 123,
ServerRootCaCertificate = "serverRootCaCertificate",
StartingPosition = "startingPosition",
Vpc = new SelfManagedKafkaAccessConfigurationVpcProperty {
SecurityGroup = new [] { "securityGroup" },
Subnets = new [] { "subnets" }
}
};
Synopsis
Properties
AdditionalBootstrapServers | An array of server URLs. |
BatchSize | The maximum number of records to include in each batch. |
ConsumerGroupId | The name of the destination queue to consume. |
Credentials | The credentials needed to access the resource. |
MaximumBatchingWindowInSeconds | The maximum length of a time to wait for events. |
ServerRootCaCertificate | The ARN of the Secrets Manager secret used for certification. |
StartingPosition | (Streams only) The position in a stream from which to start reading. |
TopicName | The name of the topic that the pipe will read from. |
Vpc | This structure specifies the VPC subnets and security groups for the stream, and whether a public IP address is to be used. |
Properties
AdditionalBootstrapServers
An array of server URLs.
virtual string[] AdditionalBootstrapServers { get; }
Property Value
System.String[]
Remarks
BatchSize
The maximum number of records to include in each batch.
virtual Nullable<double> BatchSize { get; }
Property Value
System.Nullable<System.Double>
Remarks
ConsumerGroupId
The name of the destination queue to consume.
virtual string ConsumerGroupId { get; }
Property Value
System.String
Remarks
Credentials
The credentials needed to access the resource.
virtual object Credentials { get; }
Property Value
System.Object
Remarks
MaximumBatchingWindowInSeconds
The maximum length of a time to wait for events.
virtual Nullable<double> MaximumBatchingWindowInSeconds { get; }
Property Value
System.Nullable<System.Double>
Remarks
ServerRootCaCertificate
The ARN of the Secrets Manager secret used for certification.
virtual string ServerRootCaCertificate { get; }
Property Value
System.String
Remarks
StartingPosition
(Streams only) The position in a stream from which to start reading.
virtual string StartingPosition { get; }
Property Value
System.String
Remarks
TopicName
The name of the topic that the pipe will read from.
string TopicName { get; }
Property Value
System.String
Remarks
Vpc
This structure specifies the VPC subnets and security groups for the stream, and whether a public IP address is to be used.
virtual object Vpc { get; }
Property Value
System.Object