KafkaStreamingSourceOptions - AWS Glue

KafkaStreamingSourceOptions

Additional options for streaming.

Contents

Assign

The specific TopicPartitions to consume. You must specify at least one of "topicName", "assign" or "subscribePattern".

Type: String

Pattern: ([\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF]|[^\S\r\n"'])*

Required: No

BootstrapServers

A list of bootstrap server URLs, for example, as b-1.vpc-test-2.o4q88o.c6.kafka.us-east-1.amazonaws.com:9094. This option must be specified in the API call or defined in the table metadata in the Data Catalog.

Type: String

Pattern: ([\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF]|[^\S\r\n"'])*

Required: No

Classification

An optional classification.

Type: String

Pattern: ([\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF]|[^\S\r\n"'])*

Required: No

ConnectionName

The name of the connection.

Type: String

Pattern: ([\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF]|[^\S\r\n"'])*

Required: No

Delimiter

Specifies the delimiter character.

Type: String

Pattern: ([\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF]|[^\S\r\n"'])*

Required: No

EndingOffsets

The end point when a batch query is ended. Possible values are either "latest" or a JSON string that specifies an ending offset for each TopicPartition.

Type: String

Pattern: ([\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF]|[^\S\r\n"'])*

Required: No

MaxOffsetsPerTrigger

The rate limit on the maximum number of offsets that are processed per trigger interval. The specified total number of offsets is proportionally split across topicPartitions of different volumes. The default value is null, which means that the consumer reads all offsets until the known latest offset.

Type: Long

Valid Range: Minimum value of 0.

Required: No

MinPartitions

The desired minimum number of partitions to read from Kafka. The default value is null, which means that the number of spark partitions is equal to the number of Kafka partitions.

Type: Integer

Valid Range: Minimum value of 0.

Required: No

NumRetries

The number of times to retry before failing to fetch Kafka offsets. The default value is 3.

Type: Integer

Valid Range: Minimum value of 0.

Required: No

PollTimeoutMs

The timeout in milliseconds to poll data from Kafka in Spark job executors. The default value is 512.

Type: Long

Valid Range: Minimum value of 0.

Required: No

RetryIntervalMs

The time in milliseconds to wait before retrying to fetch Kafka offsets. The default value is 10.

Type: Long

Valid Range: Minimum value of 0.

Required: No

SecurityProtocol

The protocol used to communicate with brokers. The possible values are "SSL" or "PLAINTEXT".

Type: String

Pattern: ([\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF]|[^\S\r\n"'])*

Required: No

StartingOffsets

The starting position in the Kafka topic to read data from. The possible values are "earliest" or "latest". The default value is "latest".

Type: String

Pattern: ([\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF]|[^\S\r\n"'])*

Required: No

SubscribePattern

A Java regex string that identifies the topic list to subscribe to. You must specify at least one of "topicName", "assign" or "subscribePattern".

Type: String

Pattern: ([\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF]|[^\S\r\n"'])*

Required: No

TopicName

The topic name as specified in Apache Kafka. You must specify at least one of "topicName", "assign" or "subscribePattern".

Type: String

Pattern: ([\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF]|[^\S\r\n"'])*

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: