latest--aws-kafkaconnect-connector

shared
Type object
Schema URL https://catalog.lintel.tools/schemas/schemastore/serverless-framework-configuration/_shared/latest--aws-kafkaconnect-connector.json
Parent schema serverless-framework-configuration
Type: object

Resource Type definition for AWS::KafkaConnect::Connector. Source:- https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-kafkaconnect.git

Properties

Capacity object required

Information about the capacity allocated to the connector.

One of: variant, variant
2 nested properties
AutoScaling object

Details about auto scaling of a connector.

5 nested properties
MaxWorkerCount integer required

The maximum number of workers for a connector.

MinWorkerCount integer required

The minimum number of workers for a connector.

ScaleInPolicy object required

Information about the scale in policy of the connector.

1 nested properties
CpuUtilizationPercentage integer required

Specifies the CPU utilization percentage threshold at which connector scale in should trigger.

min=1max=100
ScaleOutPolicy object required

Information about the scale out policy of the connector.

1 nested properties
CpuUtilizationPercentage integer required

Specifies the CPU utilization percentage threshold at which connector scale out should trigger.

min=1max=100
McuCount integer required

Specifies how many MSK Connect Units (MCU) as the minimum scaling unit.

Values: 1 2 4 8
ProvisionedCapacity object

Details about a fixed capacity allocated to a connector.

2 nested properties
WorkerCount integer required

Number of workers for a connector.

McuCount integer

Specifies how many MSK Connect Units (MCU) are allocated to the connector.

Values: 1 2 4 8
ConnectorConfiguration object required

The configuration for the connector.

ConnectorName string | Aws_CF_FunctionString required

The name of the connector.

KafkaCluster object required

Details of how to connect to the Kafka cluster.

1 nested properties
ApacheKafkaCluster object required

Details of how to connect to an Apache Kafka cluster.

2 nested properties
BootstrapServers string | Aws_CF_FunctionString required

The bootstrap servers string of the Apache Kafka cluster.

Vpc object required

Information about a VPC used with the connector.

2 nested properties
SecurityGroups string[] required

The AWS security groups to associate with the elastic network interfaces in order to specify what the connector has access to.

uniqueItems=true
Subnets string[] required

The list of subnets to connect to in the virtual private cloud (VPC). AWS creates elastic network interfaces inside these subnets.

minItems=1uniqueItems=true
KafkaClusterClientAuthentication object required

Details of the client authentication used by the Kafka cluster.

1 nested properties
AuthenticationType string | Aws_CF_FunctionString required

The type of client authentication used to connect to the Kafka cluster. Value NONE means that no client authentication is used.

KafkaClusterEncryptionInTransit object required

Details of encryption in transit to the Kafka cluster.

1 nested properties
EncryptionType string | Aws_CF_FunctionString required

The type of encryption in transit to the Kafka cluster.

KafkaConnectVersion string | Aws_CF_FunctionString required

The version of Kafka Connect. It has to be compatible with both the Kafka cluster's version and the plugins.

Plugins Plugin[] required

List of plugins to use with the connector.

minItems=1uniqueItems=true
ServiceExecutionRoleArn string | Aws_CF_FunctionString required

The Amazon Resource Name (ARN) of the IAM role used by the connector to access Amazon S3 objects and other external resources.

ConnectorDescription string | Aws_CF_FunctionString

A summary description of the connector.

LogDelivery object

Details of what logs are delivered and where they are delivered.

1 nested properties
WorkerLogDelivery object required

Specifies where worker logs are delivered.

3 nested properties
CloudWatchLogs object

Details about delivering logs to Amazon CloudWatch Logs.

2 nested properties
Enabled boolean required

Specifies whether the logs get sent to the specified CloudWatch Logs destination.

LogGroup string | Aws_CF_FunctionString

The CloudWatch log group that is the destination for log delivery.

Firehose object

Details about delivering logs to Amazon Kinesis Data Firehose.

2 nested properties
Enabled boolean required

Specifies whether the logs get sent to the specified Kinesis Data Firehose delivery stream.

DeliveryStream string | Aws_CF_FunctionString

The Kinesis Data Firehose delivery stream that is the destination for log delivery.

S3 object

Details about delivering logs to Amazon S3.

3 nested properties
Enabled boolean required

Specifies whether the logs get sent to the specified Amazon S3 destination.

Bucket string | Aws_CF_FunctionString

The name of the S3 bucket that is the destination for log delivery.

Prefix string | Aws_CF_FunctionString

The S3 prefix that is the destination for log delivery.

WorkerConfiguration object

Specifies the worker configuration to use with the connector.

2 nested properties
Revision integer required

The revision of the worker configuration to use.

format=int64min=1
WorkerConfigurationArn string | Aws_CF_FunctionString required

The Amazon Resource Name (ARN) of the worker configuration to use.

Definitions

ApacheKafkaCluster object

Details of how to connect to an Apache Kafka cluster.

BootstrapServers string | Aws_CF_FunctionString required

The bootstrap servers string of the Apache Kafka cluster.

Vpc object required

Information about a VPC used with the connector.

2 nested properties
SecurityGroups string[] required

The AWS security groups to associate with the elastic network interfaces in order to specify what the connector has access to.

uniqueItems=true
Subnets string[] required

The list of subnets to connect to in the virtual private cloud (VPC). AWS creates elastic network interfaces inside these subnets.

minItems=1uniqueItems=true
AutoScaling object

Details about auto scaling of a connector.

MaxWorkerCount integer required

The maximum number of workers for a connector.

MinWorkerCount integer required

The minimum number of workers for a connector.

ScaleInPolicy object required

Information about the scale in policy of the connector.

1 nested properties
CpuUtilizationPercentage integer required

Specifies the CPU utilization percentage threshold at which connector scale in should trigger.

min=1max=100
ScaleOutPolicy object required

Information about the scale out policy of the connector.

1 nested properties
CpuUtilizationPercentage integer required

Specifies the CPU utilization percentage threshold at which connector scale out should trigger.

min=1max=100
McuCount integer required

Specifies how many MSK Connect Units (MCU) as the minimum scaling unit.

Values: 1 2 4 8
Capacity object

Information about the capacity allocated to the connector.

AutoScaling object

Details about auto scaling of a connector.

5 nested properties
MaxWorkerCount integer required

The maximum number of workers for a connector.

MinWorkerCount integer required

The minimum number of workers for a connector.

ScaleInPolicy object required

Information about the scale in policy of the connector.

1 nested properties
CpuUtilizationPercentage integer required

Specifies the CPU utilization percentage threshold at which connector scale in should trigger.

min=1max=100
ScaleOutPolicy object required

Information about the scale out policy of the connector.

1 nested properties
CpuUtilizationPercentage integer required

Specifies the CPU utilization percentage threshold at which connector scale out should trigger.

min=1max=100
McuCount integer required

Specifies how many MSK Connect Units (MCU) as the minimum scaling unit.

Values: 1 2 4 8
ProvisionedCapacity object

Details about a fixed capacity allocated to a connector.

2 nested properties
WorkerCount integer required

Number of workers for a connector.

McuCount integer

Specifies how many MSK Connect Units (MCU) are allocated to the connector.

Values: 1 2 4 8
CloudWatchLogsLogDelivery object

Details about delivering logs to Amazon CloudWatch Logs.

Enabled boolean required

Specifies whether the logs get sent to the specified CloudWatch Logs destination.

LogGroup string | Aws_CF_FunctionString

The CloudWatch log group that is the destination for log delivery.

CustomPlugin object

Details about a custom plugin.

CustomPluginArn string | Aws_CF_FunctionString required

The Amazon Resource Name (ARN) of the custom plugin to use.

Revision integer required

The revision of the custom plugin to use.

format=int64min=1
FirehoseLogDelivery object

Details about delivering logs to Amazon Kinesis Data Firehose.

Enabled boolean required

Specifies whether the logs get sent to the specified Kinesis Data Firehose delivery stream.

DeliveryStream string | Aws_CF_FunctionString

The Kinesis Data Firehose delivery stream that is the destination for log delivery.

KafkaCluster object

Details of how to connect to the Kafka cluster.

ApacheKafkaCluster object required

Details of how to connect to an Apache Kafka cluster.

2 nested properties
BootstrapServers string | Aws_CF_FunctionString required

The bootstrap servers string of the Apache Kafka cluster.

Vpc object required

Information about a VPC used with the connector.

2 nested properties
SecurityGroups string[] required

The AWS security groups to associate with the elastic network interfaces in order to specify what the connector has access to.

uniqueItems=true
Subnets string[] required

The list of subnets to connect to in the virtual private cloud (VPC). AWS creates elastic network interfaces inside these subnets.

minItems=1uniqueItems=true
KafkaClusterClientAuthentication object

Details of the client authentication used by the Kafka cluster.

AuthenticationType string | Aws_CF_FunctionString required

The type of client authentication used to connect to the Kafka cluster. Value NONE means that no client authentication is used.

KafkaClusterClientAuthenticationType string | Aws_CF_FunctionString

The type of client authentication used to connect to the Kafka cluster. Value NONE means that no client authentication is used.

KafkaClusterEncryptionInTransit object

Details of encryption in transit to the Kafka cluster.

EncryptionType string | Aws_CF_FunctionString required

The type of encryption in transit to the Kafka cluster.

KafkaClusterEncryptionInTransitType string | Aws_CF_FunctionString

The type of encryption in transit to the Kafka cluster.

LogDelivery object

Details of what logs are delivered and where they are delivered.

WorkerLogDelivery object required

Specifies where worker logs are delivered.

3 nested properties
CloudWatchLogs object

Details about delivering logs to Amazon CloudWatch Logs.

2 nested properties
Enabled boolean required

Specifies whether the logs get sent to the specified CloudWatch Logs destination.

LogGroup string | Aws_CF_FunctionString

The CloudWatch log group that is the destination for log delivery.

Firehose object

Details about delivering logs to Amazon Kinesis Data Firehose.

2 nested properties
Enabled boolean required

Specifies whether the logs get sent to the specified Kinesis Data Firehose delivery stream.

DeliveryStream string | Aws_CF_FunctionString

The Kinesis Data Firehose delivery stream that is the destination for log delivery.

S3 object

Details about delivering logs to Amazon S3.

3 nested properties
Enabled boolean required

Specifies whether the logs get sent to the specified Amazon S3 destination.

Bucket string | Aws_CF_FunctionString

The name of the S3 bucket that is the destination for log delivery.

Prefix string | Aws_CF_FunctionString

The S3 prefix that is the destination for log delivery.

Plugin object

Details about a Kafka Connect plugin which will be used with the connector.

CustomPlugin object required

Details about a custom plugin.

2 nested properties
CustomPluginArn string | Aws_CF_FunctionString required

The Amazon Resource Name (ARN) of the custom plugin to use.

Revision integer required

The revision of the custom plugin to use.

format=int64min=1
ProvisionedCapacity object

Details about a fixed capacity allocated to a connector.

WorkerCount integer required

Number of workers for a connector.

McuCount integer

Specifies how many MSK Connect Units (MCU) are allocated to the connector.

Values: 1 2 4 8
S3LogDelivery object

Details about delivering logs to Amazon S3.

Enabled boolean required

Specifies whether the logs get sent to the specified Amazon S3 destination.

Bucket string | Aws_CF_FunctionString

The name of the S3 bucket that is the destination for log delivery.

Prefix string | Aws_CF_FunctionString

The S3 prefix that is the destination for log delivery.

ScaleInPolicy object

Information about the scale in policy of the connector.

CpuUtilizationPercentage integer required

Specifies the CPU utilization percentage threshold at which connector scale in should trigger.

min=1max=100
ScaleOutPolicy object

Information about the scale out policy of the connector.

CpuUtilizationPercentage integer required

Specifies the CPU utilization percentage threshold at which connector scale out should trigger.

min=1max=100
Vpc object

Information about a VPC used with the connector.

SecurityGroups string[] required

The AWS security groups to associate with the elastic network interfaces in order to specify what the connector has access to.

uniqueItems=true
Subnets string[] required

The list of subnets to connect to in the virtual private cloud (VPC). AWS creates elastic network interfaces inside these subnets.

minItems=1uniqueItems=true
WorkerConfiguration object

Specifies the worker configuration to use with the connector.

Revision integer required

The revision of the worker configuration to use.

format=int64min=1
WorkerConfigurationArn string | Aws_CF_FunctionString required

The Amazon Resource Name (ARN) of the worker configuration to use.

WorkerLogDelivery object

Specifies where worker logs are delivered.

CloudWatchLogs object

Details about delivering logs to Amazon CloudWatch Logs.

2 nested properties
Enabled boolean required

Specifies whether the logs get sent to the specified CloudWatch Logs destination.

LogGroup string | Aws_CF_FunctionString

The CloudWatch log group that is the destination for log delivery.

Firehose object

Details about delivering logs to Amazon Kinesis Data Firehose.

2 nested properties
Enabled boolean required

Specifies whether the logs get sent to the specified Kinesis Data Firehose delivery stream.

DeliveryStream string | Aws_CF_FunctionString

The Kinesis Data Firehose delivery stream that is the destination for log delivery.

S3 object

Details about delivering logs to Amazon S3.

3 nested properties
Enabled boolean required

Specifies whether the logs get sent to the specified Amazon S3 destination.

Bucket string | Aws_CF_FunctionString

The name of the S3 bucket that is the destination for log delivery.

Prefix string | Aws_CF_FunctionString

The S3 prefix that is the destination for log delivery.