Interface SourceConfig
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
SourceConfig.Jsii$Proxy
@Generated(value="jsii-pacmak/1.119.0 (build 1634eac)",
date="2025-11-17T14:41:05.159Z")
@Stability(Experimental)
public interface SourceConfig
extends software.amazon.jsii.JsiiSerializable
(experimental) Source properties.
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.alpha.*;
SourceConfig sourceConfig = SourceConfig.builder()
.sourceParameters(SourceParameters.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())
.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())
.build();
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final classA builder forSourceConfigstatic final classAn implementation forSourceConfig -
Method Summary
Modifier and TypeMethodDescriptionstatic SourceConfig.Builderbuilder()default SourceParameters(experimental) The parameters required to set up a source for your pipe.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getSourceParameters
(experimental) The parameters required to set up a source for your pipe.Default: - none
-
builder
- Returns:
- a
SourceConfig.BuilderofSourceConfig
-