Class CfnPipe.PipeSourceManagedStreamingKafkaParametersProperty
The parameters for using an MSK stream as a source.
Inheritance
Namespace: Amazon.CDK.AWS.Pipes
Assembly: Amazon.CDK.AWS.Pipes.dll
Syntax (csharp)
public class PipeSourceManagedStreamingKafkaParametersProperty : Object, CfnPipe.IPipeSourceManagedStreamingKafkaParametersProperty
Syntax (vb)
Public Class PipeSourceManagedStreamingKafkaParametersProperty
Inherits Object
Implements CfnPipe.IPipeSourceManagedStreamingKafkaParametersProperty
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 pipeSourceManagedStreamingKafkaParametersProperty = new PipeSourceManagedStreamingKafkaParametersProperty {
TopicName = "topicName",
// the properties below are optional
BatchSize = 123,
ConsumerGroupId = "consumerGroupId",
Credentials = new MSKAccessCredentialsProperty {
ClientCertificateTlsAuth = "clientCertificateTlsAuth",
SaslScram512Auth = "saslScram512Auth"
},
MaximumBatchingWindowInSeconds = 123,
StartingPosition = "startingPosition"
};
Synopsis
Constructors
PipeSourceManagedStreamingKafkaParametersProperty() |
Properties
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. |
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. |
Constructors
PipeSourceManagedStreamingKafkaParametersProperty()
public PipeSourceManagedStreamingKafkaParametersProperty()
Properties
BatchSize
The maximum number of records to include in each batch.
public Nullable<double> BatchSize { get; set; }
Property Value
System.Nullable<System.Double>
Remarks
ConsumerGroupId
The name of the destination queue to consume.
public string ConsumerGroupId { get; set; }
Property Value
System.String
Remarks
Credentials
The credentials needed to access the resource.
public object Credentials { get; set; }
Property Value
System.Object
Remarks
MaximumBatchingWindowInSeconds
The maximum length of a time to wait for events.
public Nullable<double> MaximumBatchingWindowInSeconds { get; set; }
Property Value
System.Nullable<System.Double>
Remarks
StartingPosition
(Streams only) The position in a stream from which to start reading.
public string StartingPosition { get; set; }
Property Value
System.String
Remarks
TopicName
The name of the topic that the pipe will read from.
public string TopicName { get; set; }
Property Value
System.String