Package software.amazon.awscdk.services.pipes

Interface CfnPipe.PipeSourceParametersProperty

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
CfnPipe.PipeSourceParametersProperty.Jsii$Proxy
Enclosing class:
CfnPipe
@Stability(Stable) public static interface CfnPipe.PipeSourceParametersProperty extends software.amazon.jsii.JsiiSerializable
The parameters required to set up a source for your pipe.

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.*;
 PipeSourceParametersProperty pipeSourceParametersProperty = PipeSourceParametersProperty.builder()
         .activeMqBrokerParameters(PipeSourceActiveMQBrokerParametersProperty.builder()
                 .credentials(MQBrokerAccessCredentialsProperty.builder()
                         .basicAuth("basicAuth")
                         .build())
                 .queueName("queueName")
                 // the properties below are optional
                 .batchSize(123)
                 .maximumBatchingWindowInSeconds(123)
                 .build())
         .dynamoDbStreamParameters(PipeSourceDynamoDBStreamParametersProperty.builder()
                 .startingPosition("startingPosition")
                 // the properties below are optional
                 .batchSize(123)
                 .deadLetterConfig(DeadLetterConfigProperty.builder()
                         .arn("arn")
                         .build())
                 .maximumBatchingWindowInSeconds(123)
                 .maximumRecordAgeInSeconds(123)
                 .maximumRetryAttempts(123)
                 .onPartialBatchItemFailure("onPartialBatchItemFailure")
                 .parallelizationFactor(123)
                 .build())
         .filterCriteria(FilterCriteriaProperty.builder()
                 .filters(List.of(FilterProperty.builder()
                         .pattern("pattern")
                         .build()))
                 .build())
         .kinesisStreamParameters(PipeSourceKinesisStreamParametersProperty.builder()
                 .startingPosition("startingPosition")
                 // the properties below are optional
                 .batchSize(123)
                 .deadLetterConfig(DeadLetterConfigProperty.builder()
                         .arn("arn")
                         .build())
                 .maximumBatchingWindowInSeconds(123)
                 .maximumRecordAgeInSeconds(123)
                 .maximumRetryAttempts(123)
                 .onPartialBatchItemFailure("onPartialBatchItemFailure")
                 .parallelizationFactor(123)
                 .startingPositionTimestamp("startingPositionTimestamp")
                 .build())
         .managedStreamingKafkaParameters(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())
         .rabbitMqBrokerParameters(PipeSourceRabbitMQBrokerParametersProperty.builder()
                 .credentials(MQBrokerAccessCredentialsProperty.builder()
                         .basicAuth("basicAuth")
                         .build())
                 .queueName("queueName")
                 // the properties below are optional
                 .batchSize(123)
                 .maximumBatchingWindowInSeconds(123)
                 .virtualHost("virtualHost")
                 .build())
         .selfManagedKafkaParameters(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())
         .sqsQueueParameters(PipeSourceSqsQueueParametersProperty.builder()
                 .batchSize(123)
                 .maximumBatchingWindowInSeconds(123)
                 .build())
         .build();

  • Method Details

    • getActiveMqBrokerParameters

      @Stability(Stable) @Nullable default Object getActiveMqBrokerParameters()
      The parameters for using an Active MQ broker as a source.

    • getDynamoDbStreamParameters

      @Stability(Stable) @Nullable default Object getDynamoDbStreamParameters()
      The parameters for using a DynamoDB stream as a source.

    • getFilterCriteria

      @Stability(Stable) @Nullable default Object getFilterCriteria()
      The collection of event patterns used to filter events.

      To remove a filter, specify a FilterCriteria object with an empty array of Filter objects.

      For more information, see Events and Event Patterns in the Amazon EventBridge User Guide .

    • getKinesisStreamParameters

      @Stability(Stable) @Nullable default Object getKinesisStreamParameters()
      The parameters for using a Kinesis stream as a source.

    • getManagedStreamingKafkaParameters

      @Stability(Stable) @Nullable default Object getManagedStreamingKafkaParameters()
      The parameters for using an MSK stream as a source.

    • getRabbitMqBrokerParameters

      @Stability(Stable) @Nullable default Object getRabbitMqBrokerParameters()
      The parameters for using a Rabbit MQ broker as a source.

    • getSelfManagedKafkaParameters

      @Stability(Stable) @Nullable default Object getSelfManagedKafkaParameters()
      The parameters for using a self-managed Apache Kafka stream as a source.

    • getSqsQueueParameters

      @Stability(Stable) @Nullable default Object getSqsQueueParameters()
      The parameters for using a Amazon SQS stream as a source.

    • builder

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