Interface CfnPipe.IPipeSourceManagedStreamingKafkaParametersProperty

The parameters for using an MSK stream as a source.

Namespace: Amazon.CDK.AWS.Pipes
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public interface IPipeSourceManagedStreamingKafkaParametersProperty
Syntax (vb)
Public Interface IPipeSourceManagedStreamingKafkaParametersProperty
Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipesourcemanagedstreamingkafkaparameters.html

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

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

The position in a stream from which to start reading.
TopicName

The name of the topic that the pipe will read from.

Properties

BatchSize

The maximum number of records to include in each batch.

virtual Nullable<double> BatchSize { get; }
Property Value

System.Nullable<System.Double>

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipesourcemanagedstreamingkafkaparameters.html#cfn-pipes-pipe-pipesourcemanagedstreamingkafkaparameters-batchsize

ConsumerGroupId

The name of the destination queue to consume.

virtual string ConsumerGroupId { get; }
Property Value

System.String

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipesourcemanagedstreamingkafkaparameters.html#cfn-pipes-pipe-pipesourcemanagedstreamingkafkaparameters-consumergroupid

Credentials

The credentials needed to access the resource.

virtual object Credentials { get; }
Property Value

System.Object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipesourcemanagedstreamingkafkaparameters.html#cfn-pipes-pipe-pipesourcemanagedstreamingkafkaparameters-credentials

MaximumBatchingWindowInSeconds

The maximum length of a time to wait for events.

virtual Nullable<double> MaximumBatchingWindowInSeconds { get; }
Property Value

System.Nullable<System.Double>

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipesourcemanagedstreamingkafkaparameters.html#cfn-pipes-pipe-pipesourcemanagedstreamingkafkaparameters-maximumbatchingwindowinseconds

StartingPosition

The position in a stream from which to start reading.

virtual string StartingPosition { get; }
Property Value

System.String

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipesourcemanagedstreamingkafkaparameters.html#cfn-pipes-pipe-pipesourcemanagedstreamingkafkaparameters-startingposition

TopicName

The name of the topic that the pipe will read from.

string TopicName { get; }
Property Value

System.String

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipesourcemanagedstreamingkafkaparameters.html#cfn-pipes-pipe-pipesourcemanagedstreamingkafkaparameters-topicname