Package software.amazon.awscdk.services.pipes

Interface CfnPipe.PipeSourceManagedStreamingKafkaParametersProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnPipe.PipeSourceManagedStreamingKafkaParametersProperty.Jsii$Proxy

Enclosing class:

CfnPipe

@Stability(Stable)
public static interface CfnPipe.PipeSourceManagedStreamingKafkaParametersProperty
extends software.amazon.jsii.JsiiSerializable

The parameters for using an MSK stream as a source.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.pipes.*;
 PipeSourceManagedStreamingKafkaParametersProperty pipeSourceManagedStreamingKafkaParametersProperty = PipeSourceManagedStreamingKafkaParametersProperty.builder()
         .topicName("topicName")
         // the properties below are optional
         .batchSize(123)
         .consumerGroupId("consumerGroupId")
         .credentials(MSKAccessCredentialsProperty.builder()
                 .clientCertificateTlsAuth("clientCertificateTlsAuth")
                 .saslScram512Auth("saslScram512Auth")
                 .build())
         .maximumBatchingWindowInSeconds(123)
         .startingPosition("startingPosition")
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnPipe.PipeSourceManagedStreamingKafkaParametersProperty.Builder	A builder for CfnPipe.PipeSourceManagedStreamingKafkaParametersProperty
static final class	CfnPipe.PipeSourceManagedStreamingKafkaParametersProperty.Jsii$Proxy	An implementation for CfnPipe.PipeSourceManagedStreamingKafkaParametersProperty

Method Summary

Modifier and Type	Method	Description
static CfnPipe.PipeSourceManagedStreamingKafkaParametersProperty.Builder	builder()
default Number	getBatchSize()	The maximum number of records to include in each batch.
default String	getConsumerGroupId()	The name of the destination queue to consume.
default Object	getCredentials()	The credentials needed to access the resource.
default Number	getMaximumBatchingWindowInSeconds()	The maximum length of a time to wait for events.
default String	getStartingPosition()	(Streams only) The position in a stream from which to start reading.
String	getTopicName()	The name of the topic that the pipe will read from.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getTopicName

@Stability(Stable)
@NotNull
String getTopicName()

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

getBatchSize

@Stability(Stable)
@Nullable
default Number getBatchSize()

The maximum number of records to include in each batch.

getConsumerGroupId

@Stability(Stable)
@Nullable
default String getConsumerGroupId()

The name of the destination queue to consume.

getCredentials

@Stability(Stable)
@Nullable
default Object getCredentials()

The credentials needed to access the resource.

getMaximumBatchingWindowInSeconds

@Stability(Stable)
@Nullable
default Number getMaximumBatchingWindowInSeconds()

The maximum length of a time to wait for events.

getStartingPosition

@Stability(Stable)
@Nullable
default String getStartingPosition()

(Streams only) The position in a stream from which to start reading.

builder

@Stability(Stable)
static CfnPipe.PipeSourceManagedStreamingKafkaParametersProperty.Builder builder()

Returns:

a CfnPipe.PipeSourceManagedStreamingKafkaParametersProperty.Builder of CfnPipe.PipeSourceManagedStreamingKafkaParametersProperty