Interface ISourceConfig

(experimental) Source properties.

Namespace: Amazon.CDK.AWS.Pipes.Alpha
Assembly: Amazon.CDK.AWS.Pipes.Alpha.dll
Syntax (csharp)
public interface ISourceConfig
Syntax (vb)
Public Interface ISourceConfig
Remarks

Stability: Experimental

ExampleMetadata: fixture=_generated

Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.Pipes.Alpha;

var sourceConfig = new SourceConfig {
    SourceParameters = new SourceParameters {
        ActiveMqBrokerParameters = new PipeSourceActiveMQBrokerParametersProperty {
            Credentials = new MQBrokerAccessCredentialsProperty {
                BasicAuth = "basicAuth"
            },
            QueueName = "queueName",

            // the properties below are optional
            BatchSize = 123,
            MaximumBatchingWindowInSeconds = 123
        },
        DynamoDbStreamParameters = new PipeSourceDynamoDBStreamParametersProperty {
            StartingPosition = "startingPosition",

            // the properties below are optional
            BatchSize = 123,
            DeadLetterConfig = new DeadLetterConfigProperty {
                Arn = "arn"
            },
            MaximumBatchingWindowInSeconds = 123,
            MaximumRecordAgeInSeconds = 123,
            MaximumRetryAttempts = 123,
            OnPartialBatchItemFailure = "onPartialBatchItemFailure",
            ParallelizationFactor = 123
        },
        KinesisStreamParameters = new PipeSourceKinesisStreamParametersProperty {
            StartingPosition = "startingPosition",

            // the properties below are optional
            BatchSize = 123,
            DeadLetterConfig = new DeadLetterConfigProperty {
                Arn = "arn"
            },
            MaximumBatchingWindowInSeconds = 123,
            MaximumRecordAgeInSeconds = 123,
            MaximumRetryAttempts = 123,
            OnPartialBatchItemFailure = "onPartialBatchItemFailure",
            ParallelizationFactor = 123,
            StartingPositionTimestamp = "startingPositionTimestamp"
        },
        ManagedStreamingKafkaParameters = new PipeSourceManagedStreamingKafkaParametersProperty {
            TopicName = "topicName",

            // the properties below are optional
            BatchSize = 123,
            ConsumerGroupId = "consumerGroupId",
            Credentials = new MSKAccessCredentialsProperty {
                ClientCertificateTlsAuth = "clientCertificateTlsAuth",
                SaslScram512Auth = "saslScram512Auth"
            },
            MaximumBatchingWindowInSeconds = 123,
            StartingPosition = "startingPosition"
        },
        RabbitMqBrokerParameters = new PipeSourceRabbitMQBrokerParametersProperty {
            Credentials = new MQBrokerAccessCredentialsProperty {
                BasicAuth = "basicAuth"
            },
            QueueName = "queueName",

            // the properties below are optional
            BatchSize = 123,
            MaximumBatchingWindowInSeconds = 123,
            VirtualHost = "virtualHost"
        },
        SelfManagedKafkaParameters = new PipeSourceSelfManagedKafkaParametersProperty {
            TopicName = "topicName",

            // the properties below are optional
            AdditionalBootstrapServers = new [] { "additionalBootstrapServers" },
            BatchSize = 123,
            ConsumerGroupId = "consumerGroupId",
            Credentials = new SelfManagedKafkaAccessConfigurationCredentialsProperty {
                BasicAuth = "basicAuth",
                ClientCertificateTlsAuth = "clientCertificateTlsAuth",
                SaslScram256Auth = "saslScram256Auth",
                SaslScram512Auth = "saslScram512Auth"
            },
            MaximumBatchingWindowInSeconds = 123,
            ServerRootCaCertificate = "serverRootCaCertificate",
            StartingPosition = "startingPosition",
            Vpc = new SelfManagedKafkaAccessConfigurationVpcProperty {
                SecurityGroup = new [] { "securityGroup" },
                Subnets = new [] { "subnets" }
            }
        },
        SqsQueueParameters = new PipeSourceSqsQueueParametersProperty {
            BatchSize = 123,
            MaximumBatchingWindowInSeconds = 123
        }
    }
};

Synopsis

Properties

SourceParameters

(experimental) The parameters required to set up a source for your pipe.

Properties

SourceParameters

(experimental) The parameters required to set up a source for your pipe.

virtual ISourceParameters SourceParameters { get; }
Property Value

ISourceParameters

Remarks

Default: - none

Stability: Experimental