Package software.amazon.awscdk.services.pipes

Interface CfnPipe.PipeSourceSelfManagedKafkaParametersProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnPipe.PipeSourceSelfManagedKafkaParametersProperty.Jsii$Proxy

Enclosing class:

CfnPipe

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

The parameters for using a self-managed Apache Kafka 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 software.amazon.awscdk.services.pipes.*;
 PipeSourceSelfManagedKafkaParametersProperty pipeSourceSelfManagedKafkaParametersProperty = PipeSourceSelfManagedKafkaParametersProperty.builder()
         .topicName("topicName")
         // the properties below are optional
         .additionalBootstrapServers(List.of("additionalBootstrapServers"))
         .batchSize(123)
         .consumerGroupId("consumerGroupId")
         .credentials(SelfManagedKafkaAccessConfigurationCredentialsProperty.builder()
                 .basicAuth("basicAuth")
                 .clientCertificateTlsAuth("clientCertificateTlsAuth")
                 .saslScram256Auth("saslScram256Auth")
                 .saslScram512Auth("saslScram512Auth")
                 .build())
         .maximumBatchingWindowInSeconds(123)
         .serverRootCaCertificate("serverRootCaCertificate")
         .startingPosition("startingPosition")
         .vpc(SelfManagedKafkaAccessConfigurationVpcProperty.builder()
                 .securityGroup(List.of("securityGroup"))
                 .subnets(List.of("subnets"))
                 .build())
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnPipe.PipeSourceSelfManagedKafkaParametersProperty.Builder	builder()
default List<String>	getAdditionalBootstrapServers()	An array of server URLs.
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	getServerRootCaCertificate()	The ARN of the Secrets Manager secret used for certification.
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.
default Object	getVpc()	This structure specifies the VPC subnets and security groups for the stream, and whether a public IP address is to be used.

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.

See Also:

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

getAdditionalBootstrapServers

@Stability(Stable)
@Nullable
default List<String> getAdditionalBootstrapServers()

An array of server URLs.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipesourceselfmanagedkafkaparameters.html#cfn-pipes-pipe-pipesourceselfmanagedkafkaparameters-additionalbootstrapservers

getBatchSize

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

The maximum number of records to include in each batch.

See Also:

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

getConsumerGroupId

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

The name of the destination queue to consume.

See Also:

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

getCredentials

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

The credentials needed to access the resource.

See Also:

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

getMaximumBatchingWindowInSeconds

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

The maximum length of a time to wait for events.

See Also:

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

getServerRootCaCertificate

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

The ARN of the Secrets Manager secret used for certification.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipesourceselfmanagedkafkaparameters.html#cfn-pipes-pipe-pipesourceselfmanagedkafkaparameters-serverrootcacertificate

getStartingPosition

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

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

See Also:

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

getVpc

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

This structure specifies the VPC subnets and security groups for the stream, and whether a public IP address is to be used.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipesourceselfmanagedkafkaparameters.html#cfn-pipes-pipe-pipesourceselfmanagedkafkaparameters-vpc

builder

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

Returns:

a CfnPipe.PipeSourceSelfManagedKafkaParametersProperty.Builder of CfnPipe.PipeSourceSelfManagedKafkaParametersProperty