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.

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();

  • Method Details

    • getTopicName

      @Stability(Stable) @NotNull String getTopicName()
      The name of the topic that the pipe will read from.

    • getAdditionalBootstrapServers

      @Stability(Stable) @Nullable default List<String> getAdditionalBootstrapServers()
      An array of server URLs.

    • 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.

    • getServerRootCaCertificate

      @Stability(Stable) @Nullable default String getServerRootCaCertificate()
      The ARN of the Secrets Manager secret used for certification.

    • getStartingPosition

      @Stability(Stable) @Nullable default String getStartingPosition()
      (Streams only) The position in a stream from which to start reading.

    • 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.

    • builder

      @Stability(Stable) static CfnPipe.PipeSourceSelfManagedKafkaParametersProperty.Builder builder()
      Returns:
      a CfnPipe.PipeSourceSelfManagedKafkaParametersProperty.Builder of CfnPipe.PipeSourceSelfManagedKafkaParametersProperty