CfnConnectorProps

class aws_cdk.aws_kafkaconnect.CfnConnectorProps(*, capacity, connector_configuration, connector_name, kafka_cluster, kafka_cluster_client_authentication, kafka_cluster_encryption_in_transit, kafka_connect_version, plugins, service_execution_role_arn, connector_description=None, log_delivery=None, worker_configuration=None)

Bases: object

Properties for defining a CfnConnector.

Parameters:

capacity (Union[CapacityProperty, Dict[str, Any], IResolvable]) – The connector’s compute capacity settings.
connector_configuration (Union[IResolvable, Mapping[str, str]]) – The configuration of the connector.
connector_name (str) – The name of the connector.
kafka_cluster (Union[IResolvable, KafkaClusterProperty, Dict[str, Any]]) – The details of the Apache Kafka cluster to which the connector is connected.
kafka_cluster_client_authentication (Union[IResolvable, KafkaClusterClientAuthenticationProperty, Dict[str, Any]]) – The type of client authentication used to connect to the Apache Kafka cluster. The value is NONE when no client authentication is used.
kafka_cluster_encryption_in_transit (Union[IResolvable, KafkaClusterEncryptionInTransitProperty, Dict[str, Any]]) – Details of encryption in transit to the Apache Kafka cluster.
kafka_connect_version (str) – The version of Kafka Connect. It has to be compatible with both the Apache Kafka cluster’s version and the plugins.
plugins (Union[IResolvable, Sequence[Union[IResolvable, PluginProperty, Dict[str, Any]]]]) – Specifies which plugin to use for the connector. You must specify a single-element list. Amazon MSK Connect does not currently support specifying multiple plugins.
service_execution_role_arn (str) – The Amazon Resource Name (ARN) of the IAM role used by the connector to access Amazon Web Services resources.
connector_description (Optional[str]) – The description of the connector.
log_delivery (Union[IResolvable, LogDeliveryProperty, Dict[str, Any], None]) – The settings for delivering connector logs to Amazon CloudWatch Logs.
worker_configuration (Union[IResolvable, WorkerConfigurationProperty, Dict[str, Any], None]) – The worker configurations that are in use with the connector.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kafkaconnect-connector.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_kafkaconnect as kafkaconnect

cfn_connector_props = kafkaconnect.CfnConnectorProps(
    capacity=kafkaconnect.CfnConnector.CapacityProperty(
        auto_scaling=kafkaconnect.CfnConnector.AutoScalingProperty(
            max_worker_count=123,
            mcu_count=123,
            min_worker_count=123,
            scale_in_policy=kafkaconnect.CfnConnector.ScaleInPolicyProperty(
                cpu_utilization_percentage=123
            ),
            scale_out_policy=kafkaconnect.CfnConnector.ScaleOutPolicyProperty(
                cpu_utilization_percentage=123
            )
        ),
        provisioned_capacity=kafkaconnect.CfnConnector.ProvisionedCapacityProperty(
            worker_count=123,

            # the properties below are optional
            mcu_count=123
        )
    ),
    connector_configuration={
        "connector_configuration_key": "connectorConfiguration"
    },
    connector_name="connectorName",
    kafka_cluster=kafkaconnect.CfnConnector.KafkaClusterProperty(
        apache_kafka_cluster=kafkaconnect.CfnConnector.ApacheKafkaClusterProperty(
            bootstrap_servers="bootstrapServers",
            vpc=kafkaconnect.CfnConnector.VpcProperty(
                security_groups=["securityGroups"],
                subnets=["subnets"]
            )
        )
    ),
    kafka_cluster_client_authentication=kafkaconnect.CfnConnector.KafkaClusterClientAuthenticationProperty(
        authentication_type="authenticationType"
    ),
    kafka_cluster_encryption_in_transit=kafkaconnect.CfnConnector.KafkaClusterEncryptionInTransitProperty(
        encryption_type="encryptionType"
    ),
    kafka_connect_version="kafkaConnectVersion",
    plugins=[kafkaconnect.CfnConnector.PluginProperty(
        custom_plugin=kafkaconnect.CfnConnector.CustomPluginProperty(
            custom_plugin_arn="customPluginArn",
            revision=123
        )
    )],
    service_execution_role_arn="serviceExecutionRoleArn",

    # the properties below are optional
    connector_description="connectorDescription",
    log_delivery=kafkaconnect.CfnConnector.LogDeliveryProperty(
        worker_log_delivery=kafkaconnect.CfnConnector.WorkerLogDeliveryProperty(
            cloud_watch_logs=kafkaconnect.CfnConnector.CloudWatchLogsLogDeliveryProperty(
                enabled=False,

                # the properties below are optional
                log_group="logGroup"
            ),
            firehose=kafkaconnect.CfnConnector.FirehoseLogDeliveryProperty(
                enabled=False,

                # the properties below are optional
                delivery_stream="deliveryStream"
            ),
            s3=kafkaconnect.CfnConnector.S3LogDeliveryProperty(
                enabled=False,

                # the properties below are optional
                bucket="bucket",
                prefix="prefix"
            )
        )
    ),
    worker_configuration=kafkaconnect.CfnConnector.WorkerConfigurationProperty(
        revision=123,
        worker_configuration_arn="workerConfigurationArn"
    )
)