CfnConnectorMixinProps

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

Bases: object

Properties for CfnConnectorPropsMixin.

Parameters:

capacity (Union[IResolvable, CapacityProperty, Dict[str, Any], None]) – The connector’s compute capacity settings.
connector_configuration (Union[Mapping[str, str], IResolvable, None]) – The configuration of the connector.
connector_description (Optional[str]) – The description of the connector.
connector_name (Optional[str]) – The name of the connector. The connector name must be unique and can include up to 128 characters. Valid characters you can include in a connector name are: a-z, A-Z, 0-9, and -.
kafka_cluster (Union[IResolvable, KafkaClusterProperty, Dict[str, Any], None]) – The details of the Apache Kafka cluster to which the connector is connected.
kafka_cluster_client_authentication (Union[IResolvable, KafkaClusterClientAuthenticationProperty, Dict[str, Any], None]) – 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], None]) – Details of encryption in transit to the Apache Kafka cluster.
kafka_connect_version (Optional[str]) – The version of Kafka Connect. It has to be compatible with both the Apache Kafka cluster’s version and the plugins.
log_delivery (Union[IResolvable, LogDeliveryProperty, Dict[str, Any], None]) – The settings for delivering connector logs to Amazon CloudWatch Logs.
plugins (Union[IResolvable, Sequence[Union[IResolvable, PluginProperty, Dict[str, Any]]], None]) – 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 (Optional[str]) – The Amazon Resource Name (ARN) of the IAM role used by the connector to access Amazon Web Services resources.
tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – A collection of tags associated with a resource.
worker_configuration (Union[IResolvable, WorkerConfigurationProperty, Dict[str, Any], None]) – The worker configurations that are in use with the connector.

See:

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.
from aws_cdk.mixins_preview.aws_kafkaconnect import mixins as kafkaconnect_mixins

cfn_connector_mixin_props = kafkaconnect_mixins.CfnConnectorMixinProps(
    capacity=kafkaconnect_mixins.CfnConnectorPropsMixin.CapacityProperty(
        auto_scaling=kafkaconnect_mixins.CfnConnectorPropsMixin.AutoScalingProperty(
            max_worker_count=123,
            mcu_count=123,
            min_worker_count=123,
            scale_in_policy=kafkaconnect_mixins.CfnConnectorPropsMixin.ScaleInPolicyProperty(
                cpu_utilization_percentage=123
            ),
            scale_out_policy=kafkaconnect_mixins.CfnConnectorPropsMixin.ScaleOutPolicyProperty(
                cpu_utilization_percentage=123
            )
        ),
        provisioned_capacity=kafkaconnect_mixins.CfnConnectorPropsMixin.ProvisionedCapacityProperty(
            mcu_count=123,
            worker_count=123
        )
    ),
    connector_configuration={
        "connector_configuration_key": "connectorConfiguration"
    },
    connector_description="connectorDescription",
    connector_name="connectorName",
    kafka_cluster=kafkaconnect_mixins.CfnConnectorPropsMixin.KafkaClusterProperty(
        apache_kafka_cluster=kafkaconnect_mixins.CfnConnectorPropsMixin.ApacheKafkaClusterProperty(
            bootstrap_servers="bootstrapServers",
            vpc=kafkaconnect_mixins.CfnConnectorPropsMixin.VpcProperty(
                security_groups=["securityGroups"],
                subnets=["subnets"]
            )
        )
    ),
    kafka_cluster_client_authentication=kafkaconnect_mixins.CfnConnectorPropsMixin.KafkaClusterClientAuthenticationProperty(
        authentication_type="authenticationType"
    ),
    kafka_cluster_encryption_in_transit=kafkaconnect_mixins.CfnConnectorPropsMixin.KafkaClusterEncryptionInTransitProperty(
        encryption_type="encryptionType"
    ),
    kafka_connect_version="kafkaConnectVersion",
    log_delivery=kafkaconnect_mixins.CfnConnectorPropsMixin.LogDeliveryProperty(
        worker_log_delivery=kafkaconnect_mixins.CfnConnectorPropsMixin.WorkerLogDeliveryProperty(
            cloud_watch_logs=kafkaconnect_mixins.CfnConnectorPropsMixin.CloudWatchLogsLogDeliveryProperty(
                enabled=False,
                log_group="logGroup"
            ),
            firehose=kafkaconnect_mixins.CfnConnectorPropsMixin.FirehoseLogDeliveryProperty(
                delivery_stream="deliveryStream",
                enabled=False
            ),
            s3=kafkaconnect_mixins.CfnConnectorPropsMixin.S3LogDeliveryProperty(
                bucket="bucket",
                enabled=False,
                prefix="prefix"
            )
        )
    ),
    plugins=[kafkaconnect_mixins.CfnConnectorPropsMixin.PluginProperty(
        custom_plugin=kafkaconnect_mixins.CfnConnectorPropsMixin.CustomPluginProperty(
            custom_plugin_arn="customPluginArn",
            revision=123
        )
    )],
    service_execution_role_arn="serviceExecutionRoleArn",
    tags=[CfnTag(
        key="key",
        value="value"
    )],
    worker_configuration=kafkaconnect_mixins.CfnConnectorPropsMixin.WorkerConfigurationProperty(
        revision=123,
        worker_configuration_arn="workerConfigurationArn"
    )
)

Attributes

capacity

The connector’s compute capacity settings.

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

connector_configuration

The configuration of the connector.

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

connector_description

The description of the connector.

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

connector_name

The name of the connector.

The connector name must be unique and can include up to 128 characters. Valid characters you can include in a connector name are: a-z, A-Z, 0-9, and -.