Skip to content
v2.277.0

Experimental

@aws-cdk/aws-pipes-alpha is an experimental (alpha) package: its API may change in any release, without a major version bump.

SourceConfig Struct ​

Source properties.

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as pipes_alpha from '@aws-cdk/aws-pipes-alpha';
const sourceConfig: pipes_alpha.SourceConfig = {
  sourceParameters: {
    activeMqBrokerParameters: {
      credentials: {
        basicAuth: 'basicAuth',
      },
      queueName: 'queueName',

      // the properties below are optional
      batchSize: 123,
      maximumBatchingWindowInSeconds: 123,
    },
    dynamoDbStreamParameters: {
      startingPosition: 'startingPosition',

      // the properties below are optional
      batchSize: 123,
      deadLetterConfig: {
        arn: 'arn',
      },
      maximumBatchingWindowInSeconds: 123,
      maximumRecordAgeInSeconds: 123,
      maximumRetryAttempts: 123,
      onPartialBatchItemFailure: 'onPartialBatchItemFailure',
      parallelizationFactor: 123,
    },
    kinesisStreamParameters: {
      startingPosition: 'startingPosition',

      // the properties below are optional
      batchSize: 123,
      deadLetterConfig: {
        arn: 'arn',
      },
      maximumBatchingWindowInSeconds: 123,
      maximumRecordAgeInSeconds: 123,
      maximumRetryAttempts: 123,
      onPartialBatchItemFailure: 'onPartialBatchItemFailure',
      parallelizationFactor: 123,
      startingPositionTimestamp: 'startingPositionTimestamp',
    },
    managedStreamingKafkaParameters: {
      topicName: 'topicName',

      // the properties below are optional
      batchSize: 123,
      consumerGroupId: 'consumerGroupId',
      credentials: {
        clientCertificateTlsAuth: 'clientCertificateTlsAuth',
        saslScram512Auth: 'saslScram512Auth',
      },
      maximumBatchingWindowInSeconds: 123,
      startingPosition: 'startingPosition',
    },
    rabbitMqBrokerParameters: {
      credentials: {
        basicAuth: 'basicAuth',
      },
      queueName: 'queueName',

      // the properties below are optional
      batchSize: 123,
      maximumBatchingWindowInSeconds: 123,
      virtualHost: 'virtualHost',
    },
    selfManagedKafkaParameters: {
      topicName: 'topicName',

      // the properties below are optional
      additionalBootstrapServers: ['additionalBootstrapServers'],
      batchSize: 123,
      consumerGroupId: 'consumerGroupId',
      credentials: {
        basicAuth: 'basicAuth',
        clientCertificateTlsAuth: 'clientCertificateTlsAuth',
        saslScram256Auth: 'saslScram256Auth',
        saslScram512Auth: 'saslScram512Auth',
      },
      maximumBatchingWindowInSeconds: 123,
      serverRootCaCertificate: 'serverRootCaCertificate',
      startingPosition: 'startingPosition',
      vpc: {
        securityGroup: ['securityGroup'],
        subnets: ['subnets'],
      },
    },
    sqsQueueParameters: {
      batchSize: 123,
      maximumBatchingWindowInSeconds: 123,
    },
  },
};
python
from aws_cdk.aws_pipes.PipeSourceActiveMQBrokerParametersProperty import PipeSourceActiveMQBrokerParametersProperty
from aws_cdk.aws_pipes.MQBrokerAccessCredentialsProperty import MQBrokerAccessCredentialsProperty, MQBrokerAccessCredentialsProperty
from aws_cdk.aws_pipes.PipeSourceDynamoDBStreamParametersProperty import PipeSourceDynamoDBStreamParametersProperty
from aws_cdk.aws_pipes.DeadLetterConfigProperty import DeadLetterConfigProperty, DeadLetterConfigProperty
from aws_cdk.aws_pipes.PipeSourceKinesisStreamParametersProperty import PipeSourceKinesisStreamParametersProperty
from aws_cdk.aws_pipes.PipeSourceManagedStreamingKafkaParametersProperty import PipeSourceManagedStreamingKafkaParametersProperty
from aws_cdk.aws_pipes.MSKAccessCredentialsProperty import MSKAccessCredentialsProperty
from aws_cdk.aws_pipes.PipeSourceRabbitMQBrokerParametersProperty import PipeSourceRabbitMQBrokerParametersProperty
from aws_cdk.aws_pipes.PipeSourceSelfManagedKafkaParametersProperty import PipeSourceSelfManagedKafkaParametersProperty
from aws_cdk.aws_pipes.SelfManagedKafkaAccessConfigurationCredentialsProperty import SelfManagedKafkaAccessConfigurationCredentialsProperty
from aws_cdk.aws_pipes.SelfManagedKafkaAccessConfigurationVpcProperty import SelfManagedKafkaAccessConfigurationVpcProperty
from aws_cdk.aws_pipes.PipeSourceSqsQueueParametersProperty import PipeSourceSqsQueueParametersProperty
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_pipes_alpha as pipes_alpha

source_config = pipes_alpha.SourceConfig(
    source_parameters=pipes_alpha.SourceParameters(
        active_mq_broker_parameters=PipeSourceActiveMQBrokerParametersProperty(
            credentials=MQBrokerAccessCredentialsProperty(
                basic_auth="basicAuth"
            ),
            queue_name="queueName",

            # the properties below are optional
            batch_size=123,
            maximum_batching_window_in_seconds=123
        ),
        dynamo_db_stream_parameters=PipeSourceDynamoDBStreamParametersProperty(
            starting_position="startingPosition",

            # the properties below are optional
            batch_size=123,
            dead_letter_config=DeadLetterConfigProperty(
                arn="arn"
            ),
            maximum_batching_window_in_seconds=123,
            maximum_record_age_in_seconds=123,
            maximum_retry_attempts=123,
            on_partial_batch_item_failure="onPartialBatchItemFailure",
            parallelization_factor=123
        ),
        kinesis_stream_parameters=PipeSourceKinesisStreamParametersProperty(
            starting_position="startingPosition",

            # the properties below are optional
            batch_size=123,
            dead_letter_config=DeadLetterConfigProperty(
                arn="arn"
            ),
            maximum_batching_window_in_seconds=123,
            maximum_record_age_in_seconds=123,
            maximum_retry_attempts=123,
            on_partial_batch_item_failure="onPartialBatchItemFailure",
            parallelization_factor=123,
            starting_position_timestamp="startingPositionTimestamp"
        ),
        managed_streaming_kafka_parameters=PipeSourceManagedStreamingKafkaParametersProperty(
            topic_name="topicName",

            # the properties below are optional
            batch_size=123,
            consumer_group_id="consumerGroupId",
            credentials=MSKAccessCredentialsProperty(
                client_certificate_tls_auth="clientCertificateTlsAuth",
                sasl_scram512_auth="saslScram512Auth"
            ),
            maximum_batching_window_in_seconds=123,
            starting_position="startingPosition"
        ),
        rabbit_mq_broker_parameters=PipeSourceRabbitMQBrokerParametersProperty(
            credentials=MQBrokerAccessCredentialsProperty(
                basic_auth="basicAuth"
            ),
            queue_name="queueName",

            # the properties below are optional
            batch_size=123,
            maximum_batching_window_in_seconds=123,
            virtual_host="virtualHost"
        ),
        self_managed_kafka_parameters=PipeSourceSelfManagedKafkaParametersProperty(
            topic_name="topicName",

            # the properties below are optional
            additional_bootstrap_servers=["additionalBootstrapServers"],
            batch_size=123,
            consumer_group_id="consumerGroupId",
            credentials=SelfManagedKafkaAccessConfigurationCredentialsProperty(
                basic_auth="basicAuth",
                client_certificate_tls_auth="clientCertificateTlsAuth",
                sasl_scram256_auth="saslScram256Auth",
                sasl_scram512_auth="saslScram512Auth"
            ),
            maximum_batching_window_in_seconds=123,
            server_root_ca_certificate="serverRootCaCertificate",
            starting_position="startingPosition",
            vpc=SelfManagedKafkaAccessConfigurationVpcProperty(
                security_group=["securityGroup"],
                subnets=["subnets"]
            )
        ),
        sqs_queue_parameters=PipeSourceSqsQueueParametersProperty(
            batch_size=123,
            maximum_batching_window_in_seconds=123
        )
    )
)
java
// 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();
csharp
// Install: dotnet add package Amazon.CDK.AWS.Pipes.Alpha
// 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
        }
    }
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdkpipesalpha/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import pipes_alpha "github.com/aws/aws-cdk-go/awscdkpipesalpha"

sourceConfig := &SourceConfig{
	SourceParameters: &SourceParameters{
		ActiveMqBrokerParameters: &PipeSourceActiveMQBrokerParametersProperty{
			Credentials: &MQBrokerAccessCredentialsProperty{
				BasicAuth: jsii.String("basicAuth"),
			},
			QueueName: jsii.String("queueName"),

			// the properties below are optional
			BatchSize: jsii.Number(123),
			MaximumBatchingWindowInSeconds: jsii.Number(123),
		},
		DynamoDbStreamParameters: &PipeSourceDynamoDBStreamParametersProperty{
			StartingPosition: jsii.String("startingPosition"),

			// the properties below are optional
			BatchSize: jsii.Number(123),
			DeadLetterConfig: &DeadLetterConfigProperty{
				Arn: jsii.String("arn"),
			},
			MaximumBatchingWindowInSeconds: jsii.Number(123),
			MaximumRecordAgeInSeconds: jsii.Number(123),
			MaximumRetryAttempts: jsii.Number(123),
			OnPartialBatchItemFailure: jsii.String("onPartialBatchItemFailure"),
			ParallelizationFactor: jsii.Number(123),
		},
		KinesisStreamParameters: &PipeSourceKinesisStreamParametersProperty{
			StartingPosition: jsii.String("startingPosition"),

			// the properties below are optional
			BatchSize: jsii.Number(123),
			DeadLetterConfig: &DeadLetterConfigProperty{
				Arn: jsii.String("arn"),
			},
			MaximumBatchingWindowInSeconds: jsii.Number(123),
			MaximumRecordAgeInSeconds: jsii.Number(123),
			MaximumRetryAttempts: jsii.Number(123),
			OnPartialBatchItemFailure: jsii.String("onPartialBatchItemFailure"),
			ParallelizationFactor: jsii.Number(123),
			StartingPositionTimestamp: jsii.String("startingPositionTimestamp"),
		},
		ManagedStreamingKafkaParameters: &PipeSourceManagedStreamingKafkaParametersProperty{
			TopicName: jsii.String("topicName"),

			// the properties below are optional
			BatchSize: jsii.Number(123),
			ConsumerGroupId: jsii.String("consumerGroupId"),
			Credentials: &MSKAccessCredentialsProperty{
				ClientCertificateTlsAuth: jsii.String("clientCertificateTlsAuth"),
				SaslScram512Auth: jsii.String("saslScram512Auth"),
			},
			MaximumBatchingWindowInSeconds: jsii.Number(123),
			StartingPosition: jsii.String("startingPosition"),
		},
		RabbitMqBrokerParameters: &PipeSourceRabbitMQBrokerParametersProperty{
			Credentials: &MQBrokerAccessCredentialsProperty{
				BasicAuth: jsii.String("basicAuth"),
			},
			QueueName: jsii.String("queueName"),

			// the properties below are optional
			BatchSize: jsii.Number(123),
			MaximumBatchingWindowInSeconds: jsii.Number(123),
			VirtualHost: jsii.String("virtualHost"),
		},
		SelfManagedKafkaParameters: &PipeSourceSelfManagedKafkaParametersProperty{
			TopicName: jsii.String("topicName"),

			// the properties below are optional
			AdditionalBootstrapServers: []*string{
				jsii.String("additionalBootstrapServers"),
			},
			BatchSize: jsii.Number(123),
			ConsumerGroupId: jsii.String("consumerGroupId"),
			Credentials: &SelfManagedKafkaAccessConfigurationCredentialsProperty{
				BasicAuth: jsii.String("basicAuth"),
				ClientCertificateTlsAuth: jsii.String("clientCertificateTlsAuth"),
				SaslScram256Auth: jsii.String("saslScram256Auth"),
				SaslScram512Auth: jsii.String("saslScram512Auth"),
			},
			MaximumBatchingWindowInSeconds: jsii.Number(123),
			ServerRootCaCertificate: jsii.String("serverRootCaCertificate"),
			StartingPosition: jsii.String("startingPosition"),
			Vpc: &SelfManagedKafkaAccessConfigurationVpcProperty{
				SecurityGroup: []*string{
					jsii.String("securityGroup"),
				},
				Subnets: []*string{
					jsii.String("subnets"),
				},
			},
		},
		SqsQueueParameters: &PipeSourceSqsQueueParametersProperty{
			BatchSize: jsii.Number(123),
			MaximumBatchingWindowInSeconds: jsii.Number(123),
		},
	},
}

Properties ​

sourceParametersoptionalSourceParameterssource_parametersoptionalSourceParameterssourceParametersoptionalSourceParametersSourceParametersoptionalSourceParametersSourceParametersoptionalSourceParameters= none#
The parameters required to set up a source for your pipe.