CfnConnectorPropsMixin

class aws_cdk.mixins_preview.aws_kafkaconnect.mixins.CfnConnectorPropsMixin(props, *, strategy=None)

Bases: Mixin

Creates a connector using the specified properties.

See:

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

CloudformationResource:

AWS::KafkaConnect::Connector

Mixin:

true

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

cfn_connector_props_mixin = kafkaconnect_mixins.CfnConnectorPropsMixin(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"
    )
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

Create a mixin to apply properties to AWS::KafkaConnect::Connector.

Parameters:

  • props (Union[CfnConnectorMixinProps, Dict[str, Any]]) – L1 properties to apply.

  • strategy (Optional[PropertyMergeStrategy]) – (experimental) Strategy for merging nested properties. Default: - PropertyMergeStrategy.MERGE

Methods

apply_to(construct)

Apply the mixin properties to the construct.

Parameters:

construct (IConstruct)

Return type:

IConstruct

supports(construct)

Check if this mixin supports the given construct.

Parameters:

construct (IConstruct)

Return type:

bool

Attributes

CFN_PROPERTY_KEYS = ['capacity', 'connectorConfiguration', 'connectorDescription', 'connectorName', 'kafkaCluster', 'kafkaClusterClientAuthentication', 'kafkaClusterEncryptionInTransit', 'kafkaConnectVersion', 'logDelivery', 'plugins', 'serviceExecutionRoleArn', 'tags', 'workerConfiguration']

Static Methods

classmethod is_mixin(x)

(experimental) Checks if x is a Mixin.

Parameters:

x (Any) – Any object.

Return type:

bool

Returns:

true if x is an object created from a class which extends Mixin.

Stability:

experimental

ApacheKafkaClusterProperty

class CfnConnectorPropsMixin.ApacheKafkaClusterProperty(*, bootstrap_servers=None, vpc=None)

Bases: object

The details of the Apache Kafka cluster to which the connector is connected.

Parameters:

  • bootstrap_servers (Optional[str]) – The bootstrap servers of the cluster.

  • vpc (Union[IResolvable, VpcProperty, Dict[str, Any], None]) – Details of an Amazon VPC which has network connectivity to the Apache Kafka cluster.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kafkaconnect-connector-apachekafkacluster.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

apache_kafka_cluster_property = kafkaconnect_mixins.CfnConnectorPropsMixin.ApacheKafkaClusterProperty(
    bootstrap_servers="bootstrapServers",
    vpc=kafkaconnect_mixins.CfnConnectorPropsMixin.VpcProperty(
        security_groups=["securityGroups"],
        subnets=["subnets"]
    )
)

Attributes

bootstrap_servers

The bootstrap servers of the cluster.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kafkaconnect-connector-apachekafkacluster.html#cfn-kafkaconnect-connector-apachekafkacluster-bootstrapservers

vpc

Details of an Amazon VPC which has network connectivity to the Apache Kafka cluster.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kafkaconnect-connector-apachekafkacluster.html#cfn-kafkaconnect-connector-apachekafkacluster-vpc

AutoScalingProperty

class CfnConnectorPropsMixin.AutoScalingProperty(*, max_worker_count=None, mcu_count=None, min_worker_count=None, scale_in_policy=None, scale_out_policy=None)

Bases: object

Specifies how the connector scales.

Parameters:

  • max_worker_count (Union[int, float, None]) – The maximum number of workers allocated to the connector.

  • mcu_count (Union[int, float, None]) – The number of microcontroller units (MCUs) allocated to each connector worker. The valid values are 1,2,4,8.

  • min_worker_count (Union[int, float, None]) – The minimum number of workers allocated to the connector.

  • scale_in_policy (Union[IResolvable, ScaleInPolicyProperty, Dict[str, Any], None]) – The sacle-in policy for the connector.

  • scale_out_policy (Union[IResolvable, ScaleOutPolicyProperty, Dict[str, Any], None]) – The sacle-out policy for the connector.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kafkaconnect-connector-autoscaling.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

auto_scaling_property = 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
    )
)

Attributes

max_worker_count

The maximum number of workers allocated to the connector.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kafkaconnect-connector-autoscaling.html#cfn-kafkaconnect-connector-autoscaling-maxworkercount

mcu_count

The number of microcontroller units (MCUs) allocated to each connector worker.

The valid values are 1,2,4,8.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kafkaconnect-connector-autoscaling.html#cfn-kafkaconnect-connector-autoscaling-mcucount

min_worker_count

The minimum number of workers allocated to the connector.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kafkaconnect-connector-autoscaling.html#cfn-kafkaconnect-connector-autoscaling-minworkercount

scale_in_policy

The sacle-in policy for the connector.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kafkaconnect-connector-autoscaling.html#cfn-kafkaconnect-connector-autoscaling-scaleinpolicy

scale_out_policy

The sacle-out policy for the connector.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kafkaconnect-connector-autoscaling.html#cfn-kafkaconnect-connector-autoscaling-scaleoutpolicy

CapacityProperty

class CfnConnectorPropsMixin.CapacityProperty(*, auto_scaling=None, provisioned_capacity=None)

Bases: object

Information about the capacity of the connector, whether it is auto scaled or provisioned.

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kafkaconnect-connector-capacity.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

capacity_property = 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
    )
)

Attributes

auto_scaling

Information about the auto scaling parameters for the connector.

See:

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

provisioned_capacity

Details about a fixed capacity allocated to a connector.

See:

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

CloudWatchLogsLogDeliveryProperty

class CfnConnectorPropsMixin.CloudWatchLogsLogDeliveryProperty(*, enabled=None, log_group=None)

Bases: object

The settings for delivering connector logs to Amazon CloudWatch Logs.

Parameters:

  • enabled (Union[bool, IResolvable, None]) – Whether log delivery to Amazon CloudWatch Logs is enabled.

  • log_group (Optional[str]) – The name of the CloudWatch log group that is the destination for log delivery.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kafkaconnect-connector-cloudwatchlogslogdelivery.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

cloud_watch_logs_log_delivery_property = kafkaconnect_mixins.CfnConnectorPropsMixin.CloudWatchLogsLogDeliveryProperty(
    enabled=False,
    log_group="logGroup"
)

Attributes

enabled

Whether log delivery to Amazon CloudWatch Logs is enabled.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kafkaconnect-connector-cloudwatchlogslogdelivery.html#cfn-kafkaconnect-connector-cloudwatchlogslogdelivery-enabled

log_group

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

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kafkaconnect-connector-cloudwatchlogslogdelivery.html#cfn-kafkaconnect-connector-cloudwatchlogslogdelivery-loggroup

CustomPluginProperty

class CfnConnectorPropsMixin.CustomPluginProperty(*, custom_plugin_arn=None, revision=None)

Bases: object

A plugin is an AWS resource that contains the code that defines a connector’s logic.

Parameters:

  • custom_plugin_arn (Optional[str]) – The Amazon Resource Name (ARN) of the custom plugin.

  • revision (Union[int, float, None]) – The revision of the custom plugin.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kafkaconnect-connector-customplugin.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

custom_plugin_property = kafkaconnect_mixins.CfnConnectorPropsMixin.CustomPluginProperty(
    custom_plugin_arn="customPluginArn",
    revision=123
)

Attributes

custom_plugin_arn

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

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kafkaconnect-connector-customplugin.html#cfn-kafkaconnect-connector-customplugin-custompluginarn

revision

The revision of the custom plugin.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kafkaconnect-connector-customplugin.html#cfn-kafkaconnect-connector-customplugin-revision

FirehoseLogDeliveryProperty

class CfnConnectorPropsMixin.FirehoseLogDeliveryProperty(*, delivery_stream=None, enabled=None)

Bases: object

The settings for delivering logs to Amazon Kinesis Data Firehose.

Parameters:

  • delivery_stream (Optional[str]) – The name of the Kinesis Data Firehose delivery stream that is the destination for log delivery.

  • enabled (Union[bool, IResolvable, None]) – Specifies whether connector logs get delivered to Amazon Kinesis Data Firehose.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kafkaconnect-connector-firehoselogdelivery.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

firehose_log_delivery_property = kafkaconnect_mixins.CfnConnectorPropsMixin.FirehoseLogDeliveryProperty(
    delivery_stream="deliveryStream",
    enabled=False
)

Attributes

delivery_stream

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

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kafkaconnect-connector-firehoselogdelivery.html#cfn-kafkaconnect-connector-firehoselogdelivery-deliverystream

enabled

Specifies whether connector logs get delivered to Amazon Kinesis Data Firehose.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kafkaconnect-connector-firehoselogdelivery.html#cfn-kafkaconnect-connector-firehoselogdelivery-enabled

KafkaClusterClientAuthenticationProperty

class CfnConnectorPropsMixin.KafkaClusterClientAuthenticationProperty(*, authentication_type=None)

Bases: object

The client authentication information used in order to authenticate with the Apache Kafka cluster.

Parameters:

authentication_type (Optional[str]) – The type of client authentication used to connect to the Apache Kafka cluster. Value NONE means that no client authentication is used.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kafkaconnect-connector-kafkaclusterclientauthentication.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

kafka_cluster_client_authentication_property = kafkaconnect_mixins.CfnConnectorPropsMixin.KafkaClusterClientAuthenticationProperty(
    authentication_type="authenticationType"
)

Attributes

authentication_type

The type of client authentication used to connect to the Apache Kafka cluster.

Value NONE means that no client authentication is used.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kafkaconnect-connector-kafkaclusterclientauthentication.html#cfn-kafkaconnect-connector-kafkaclusterclientauthentication-authenticationtype

KafkaClusterEncryptionInTransitProperty

class CfnConnectorPropsMixin.KafkaClusterEncryptionInTransitProperty(*, encryption_type=None)

Bases: object

Details of encryption in transit to the Apache Kafka cluster.

Parameters:

encryption_type (Optional[str]) – The type of encryption in transit to the Apache Kafka cluster.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kafkaconnect-connector-kafkaclusterencryptionintransit.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

kafka_cluster_encryption_in_transit_property = kafkaconnect_mixins.CfnConnectorPropsMixin.KafkaClusterEncryptionInTransitProperty(
    encryption_type="encryptionType"
)

Attributes

encryption_type

The type of encryption in transit to the Apache Kafka cluster.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kafkaconnect-connector-kafkaclusterencryptionintransit.html#cfn-kafkaconnect-connector-kafkaclusterencryptionintransit-encryptiontype

KafkaClusterProperty

class CfnConnectorPropsMixin.KafkaClusterProperty(*, apache_kafka_cluster=None)

Bases: object

The details of the Apache Kafka cluster to which the connector is connected.

Parameters:

apache_kafka_cluster (Union[IResolvable, ApacheKafkaClusterProperty, Dict[str, Any], None]) – The Apache Kafka cluster to which the connector is connected.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kafkaconnect-connector-kafkacluster.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

kafka_cluster_property = kafkaconnect_mixins.CfnConnectorPropsMixin.KafkaClusterProperty(
    apache_kafka_cluster=kafkaconnect_mixins.CfnConnectorPropsMixin.ApacheKafkaClusterProperty(
        bootstrap_servers="bootstrapServers",
        vpc=kafkaconnect_mixins.CfnConnectorPropsMixin.VpcProperty(
            security_groups=["securityGroups"],
            subnets=["subnets"]
        )
    )
)

Attributes

apache_kafka_cluster

The Apache Kafka cluster to which the connector is connected.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kafkaconnect-connector-kafkacluster.html#cfn-kafkaconnect-connector-kafkacluster-apachekafkacluster

LogDeliveryProperty

class CfnConnectorPropsMixin.LogDeliveryProperty(*, worker_log_delivery=None)

Bases: object

Details about log delivery.

Parameters:

worker_log_delivery (Union[IResolvable, WorkerLogDeliveryProperty, Dict[str, Any], None]) – The workers can send worker logs to different destination types. This configuration specifies the details of these destinations.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kafkaconnect-connector-logdelivery.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

log_delivery_property = 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"
        )
    )
)

Attributes

worker_log_delivery

The workers can send worker logs to different destination types.

This configuration specifies the details of these destinations.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kafkaconnect-connector-logdelivery.html#cfn-kafkaconnect-connector-logdelivery-workerlogdelivery

PluginProperty

class CfnConnectorPropsMixin.PluginProperty(*, custom_plugin=None)

Bases: object

A plugin is an AWS resource that contains the code that defines your connector logic.

Parameters:

custom_plugin (Union[IResolvable, CustomPluginProperty, Dict[str, Any], None]) – Details about a custom plugin.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kafkaconnect-connector-plugin.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

plugin_property = kafkaconnect_mixins.CfnConnectorPropsMixin.PluginProperty(
    custom_plugin=kafkaconnect_mixins.CfnConnectorPropsMixin.CustomPluginProperty(
        custom_plugin_arn="customPluginArn",
        revision=123
    )
)

Attributes

custom_plugin

Details about a custom plugin.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kafkaconnect-connector-plugin.html#cfn-kafkaconnect-connector-plugin-customplugin

ProvisionedCapacityProperty

class CfnConnectorPropsMixin.ProvisionedCapacityProperty(*, mcu_count=None, worker_count=None)

Bases: object

Details about a connector’s provisioned capacity.

Parameters:

  • mcu_count (Union[int, float, None]) – The number of microcontroller units (MCUs) allocated to each connector worker. The valid values are 1,2,4,8.

  • worker_count (Union[int, float, None]) – The number of workers that are allocated to the connector.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kafkaconnect-connector-provisionedcapacity.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

provisioned_capacity_property = kafkaconnect_mixins.CfnConnectorPropsMixin.ProvisionedCapacityProperty(
    mcu_count=123,
    worker_count=123
)

Attributes

mcu_count

The number of microcontroller units (MCUs) allocated to each connector worker.

The valid values are 1,2,4,8.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kafkaconnect-connector-provisionedcapacity.html#cfn-kafkaconnect-connector-provisionedcapacity-mcucount

worker_count

The number of workers that are allocated to the connector.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kafkaconnect-connector-provisionedcapacity.html#cfn-kafkaconnect-connector-provisionedcapacity-workercount

S3LogDeliveryProperty

class CfnConnectorPropsMixin.S3LogDeliveryProperty(*, bucket=None, enabled=None, prefix=None)

Bases: object

Details about delivering logs to Amazon S3.

Parameters:

  • bucket (Optional[str]) – The name of the S3 bucket that is the destination for log delivery.

  • enabled (Union[bool, IResolvable, None]) – Specifies whether connector logs get sent to the specified Amazon S3 destination.

  • prefix (Optional[str]) – The S3 prefix that is the destination for log delivery.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kafkaconnect-connector-s3logdelivery.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

s3_log_delivery_property = kafkaconnect_mixins.CfnConnectorPropsMixin.S3LogDeliveryProperty(
    bucket="bucket",
    enabled=False,
    prefix="prefix"
)

Attributes

bucket

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

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kafkaconnect-connector-s3logdelivery.html#cfn-kafkaconnect-connector-s3logdelivery-bucket

enabled

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

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kafkaconnect-connector-s3logdelivery.html#cfn-kafkaconnect-connector-s3logdelivery-enabled

prefix

The S3 prefix that is the destination for log delivery.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kafkaconnect-connector-s3logdelivery.html#cfn-kafkaconnect-connector-s3logdelivery-prefix

ScaleInPolicyProperty

class CfnConnectorPropsMixin.ScaleInPolicyProperty(*, cpu_utilization_percentage=None)

Bases: object

The scale-in policy for the connector.

Parameters:

cpu_utilization_percentage (Union[int, float, None]) – Specifies the CPU utilization percentage threshold at which you want connector scale in to be triggered.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kafkaconnect-connector-scaleinpolicy.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

scale_in_policy_property = kafkaconnect_mixins.CfnConnectorPropsMixin.ScaleInPolicyProperty(
    cpu_utilization_percentage=123
)

Attributes

cpu_utilization_percentage

Specifies the CPU utilization percentage threshold at which you want connector scale in to be triggered.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kafkaconnect-connector-scaleinpolicy.html#cfn-kafkaconnect-connector-scaleinpolicy-cpuutilizationpercentage

ScaleOutPolicyProperty

class CfnConnectorPropsMixin.ScaleOutPolicyProperty(*, cpu_utilization_percentage=None)

Bases: object

The scale-out policy for the connector.

Parameters:

cpu_utilization_percentage (Union[int, float, None]) – The CPU utilization percentage threshold at which you want connector scale out to be triggered.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kafkaconnect-connector-scaleoutpolicy.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

scale_out_policy_property = kafkaconnect_mixins.CfnConnectorPropsMixin.ScaleOutPolicyProperty(
    cpu_utilization_percentage=123
)

Attributes

cpu_utilization_percentage

The CPU utilization percentage threshold at which you want connector scale out to be triggered.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kafkaconnect-connector-scaleoutpolicy.html#cfn-kafkaconnect-connector-scaleoutpolicy-cpuutilizationpercentage

VpcProperty

class CfnConnectorPropsMixin.VpcProperty(*, security_groups=None, subnets=None)

Bases: object

Information about the VPC in which the connector resides.

Parameters:

  • security_groups (Optional[Sequence[str]]) – The security group IDs for the connector.

  • subnets (Optional[Sequence[str]]) – The subnets for the connector.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kafkaconnect-connector-vpc.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

vpc_property = kafkaconnect_mixins.CfnConnectorPropsMixin.VpcProperty(
    security_groups=["securityGroups"],
    subnets=["subnets"]
)

Attributes

security_groups

The security group IDs for the connector.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kafkaconnect-connector-vpc.html#cfn-kafkaconnect-connector-vpc-securitygroups

subnets

The subnets for the connector.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kafkaconnect-connector-vpc.html#cfn-kafkaconnect-connector-vpc-subnets

WorkerConfigurationProperty

class CfnConnectorPropsMixin.WorkerConfigurationProperty(*, revision=None, worker_configuration_arn=None)

Bases: object

The configuration of the workers, which are the processes that run the connector logic.

Parameters:

  • revision (Union[int, float, None]) – The revision of the worker configuration.

  • worker_configuration_arn (Optional[str]) – The Amazon Resource Name (ARN) of the worker configuration.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kafkaconnect-connector-workerconfiguration.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

worker_configuration_property = kafkaconnect_mixins.CfnConnectorPropsMixin.WorkerConfigurationProperty(
    revision=123,
    worker_configuration_arn="workerConfigurationArn"
)

Attributes

revision

The revision of the worker configuration.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kafkaconnect-connector-workerconfiguration.html#cfn-kafkaconnect-connector-workerconfiguration-revision

worker_configuration_arn

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

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kafkaconnect-connector-workerconfiguration.html#cfn-kafkaconnect-connector-workerconfiguration-workerconfigurationarn

WorkerLogDeliveryProperty

class CfnConnectorPropsMixin.WorkerLogDeliveryProperty(*, cloud_watch_logs=None, firehose=None, s3=None)

Bases: object

Workers can send worker logs to different destination types.

This configuration specifies the details of these destinations.

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kafkaconnect-connector-workerlogdelivery.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

worker_log_delivery_property = 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"
    )
)

Attributes

cloud_watch_logs

Details about delivering logs to Amazon CloudWatch Logs.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kafkaconnect-connector-workerlogdelivery.html#cfn-kafkaconnect-connector-workerlogdelivery-cloudwatchlogs

firehose

Details about delivering logs to Amazon Kinesis Data Firehose.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kafkaconnect-connector-workerlogdelivery.html#cfn-kafkaconnect-connector-workerlogdelivery-firehose

s3

Details about delivering logs to Amazon S3.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kafkaconnect-connector-workerlogdelivery.html#cfn-kafkaconnect-connector-workerlogdelivery-s3