Class CfnConnector

Creates a connector using the specified properties.

Inheritance
System.Object
CfnElement
CfnRefElement
CfnResource
CfnConnector
Inherited Members
Namespace: Amazon.CDK.AWS.KafkaConnect
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnConnector : CfnResource, IInspectable, ITaggableV2
Syntax (vb)
Public Class CfnConnector
    Inherits CfnResource
    Implements IInspectable, ITaggableV2
Remarks

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

CloudformationResource: AWS::KafkaConnect::Connector

ExampleMetadata: fixture=_generated

Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.KafkaConnect;

var cfnConnector = new CfnConnector(this, "MyCfnConnector", new CfnConnectorProps {
    Capacity = new CapacityProperty {
        AutoScaling = new AutoScalingProperty {
            MaxWorkerCount = 123,
            McuCount = 123,
            MinWorkerCount = 123,
            ScaleInPolicy = new ScaleInPolicyProperty {
                CpuUtilizationPercentage = 123
            },
            ScaleOutPolicy = new ScaleOutPolicyProperty {
                CpuUtilizationPercentage = 123
            }
        },
        ProvisionedCapacity = new ProvisionedCapacityProperty {
            WorkerCount = 123,

            // the properties below are optional
            McuCount = 123
        }
    },
    ConnectorConfiguration = new Dictionary<string, string> {
        { "connectorConfigurationKey", "connectorConfiguration" }
    },
    ConnectorName = "connectorName",
    KafkaCluster = new KafkaClusterProperty {
        ApacheKafkaCluster = new ApacheKafkaClusterProperty {
            BootstrapServers = "bootstrapServers",
            Vpc = new VpcProperty {
                SecurityGroups = new [] { "securityGroups" },
                Subnets = new [] { "subnets" }
            }
        }
    },
    KafkaClusterClientAuthentication = new KafkaClusterClientAuthenticationProperty {
        AuthenticationType = "authenticationType"
    },
    KafkaClusterEncryptionInTransit = new KafkaClusterEncryptionInTransitProperty {
        EncryptionType = "encryptionType"
    },
    KafkaConnectVersion = "kafkaConnectVersion",
    Plugins = new [] { new PluginProperty {
        CustomPlugin = new CustomPluginProperty {
            CustomPluginArn = "customPluginArn",
            Revision = 123
        }
    } },
    ServiceExecutionRoleArn = "serviceExecutionRoleArn",

    // the properties below are optional
    ConnectorDescription = "connectorDescription",
    LogDelivery = new LogDeliveryProperty {
        WorkerLogDelivery = new WorkerLogDeliveryProperty {
            CloudWatchLogs = new CloudWatchLogsLogDeliveryProperty {
                Enabled = false,

                // the properties below are optional
                LogGroup = "logGroup"
            },
            Firehose = new FirehoseLogDeliveryProperty {
                Enabled = false,

                // the properties below are optional
                DeliveryStream = "deliveryStream"
            },
            S3 = new S3LogDeliveryProperty {
                Enabled = false,

                // the properties below are optional
                Bucket = "bucket",
                Prefix = "prefix"
            }
        }
    },
    Tags = new [] { new CfnTag {
        Key = "key",
        Value = "value"
    } },
    WorkerConfiguration = new WorkerConfigurationProperty {
        Revision = 123,
        WorkerConfigurationArn = "workerConfigurationArn"
    }
});

Synopsis

Constructors

CfnConnector(ByRefValue)

Used by jsii to construct an instance of this class from a Javascript-owned object reference
CfnConnector(DeputyBase.DeputyProps)

Used by jsii to construct an instance of this class from DeputyProps
CfnConnector(Construct, String, ICfnConnectorProps)

Properties

AttrConnectorArn

The Amazon Resource Name (ARN) of the newly created connector.
Capacity

The connector's compute capacity settings.
CdkTagManager

Tag Manager which manages the tags for this resource.
CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.
CfnProperties
ConnectorConfiguration

The configuration of the connector.
ConnectorDescription

The description of the connector.
ConnectorName

The name of the connector.
KafkaCluster

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

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

Details of encryption in transit to the Apache Kafka cluster.
KafkaConnectVersion

The version of Kafka Connect.
LogDelivery

The settings for delivering connector logs to Amazon CloudWatch Logs.
Plugins

Specifies which plugin to use for the connector.
ServiceExecutionRoleArn

The Amazon Resource Name (ARN) of the IAM role used by the connector to access Amazon Web Services resources.
Tags

A collection of tags associated with a resource.
WorkerConfiguration

The worker configurations that are in use with the connector.

Methods

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.
RenderProperties(IDictionary<String, Object>)

Constructors

CfnConnector(ByRefValue)

Used by jsii to construct an instance of this class from a Javascript-owned object reference

protected CfnConnector(ByRefValue reference)
Parameters
reference Amazon.JSII.Runtime.Deputy.ByRefValue

The Javascript-owned object reference

CfnConnector(DeputyBase.DeputyProps)

Used by jsii to construct an instance of this class from DeputyProps

protected CfnConnector(DeputyBase.DeputyProps props)
Parameters
props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps

The deputy props

CfnConnector(Construct, String, ICfnConnectorProps)

public CfnConnector(Construct scope, string id, ICfnConnectorProps props)
Parameters
scope Constructs.Construct

Scope in which this resource is defined.

id System.String

Construct identifier for this resource (unique in its scope).

props ICfnConnectorProps

Resource properties.

Properties

AttrConnectorArn

The Amazon Resource Name (ARN) of the newly created connector.

public virtual string AttrConnectorArn { get; }
Property Value

System.String

Remarks

CloudformationAttribute: ConnectorArn

Capacity

The connector's compute capacity settings.

public virtual object Capacity { get; set; }
Property Value

System.Object

CdkTagManager

Tag Manager which manages the tags for this resource.

public virtual TagManager CdkTagManager { get; }
Property Value

TagManager

CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value

System.String

CfnProperties

protected override IDictionary<string, object> CfnProperties { get; }
Property Value

System.Collections.Generic.IDictionary<System.String, System.Object>

Overrides

ConnectorConfiguration

The configuration of the connector.

public virtual object ConnectorConfiguration { get; set; }
Property Value

System.Object

ConnectorDescription

The description of the connector.

public virtual string ConnectorDescription { get; set; }
Property Value

System.String

ConnectorName

The name of the connector.

public virtual string ConnectorName { get; set; }
Property Value

System.String

KafkaCluster

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

public virtual object KafkaCluster { get; set; }
Property Value

System.Object

KafkaClusterClientAuthentication

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

public virtual object KafkaClusterClientAuthentication { get; set; }
Property Value

System.Object

KafkaClusterEncryptionInTransit

Details of encryption in transit to the Apache Kafka cluster.

public virtual object KafkaClusterEncryptionInTransit { get; set; }
Property Value

System.Object

KafkaConnectVersion

The version of Kafka Connect.

public virtual string KafkaConnectVersion { get; set; }
Property Value

System.String

LogDelivery

The settings for delivering connector logs to Amazon CloudWatch Logs.

public virtual object LogDelivery { get; set; }
Property Value

System.Object

Plugins

Specifies which plugin to use for the connector.

public virtual object Plugins { get; set; }
Property Value

System.Object

ServiceExecutionRoleArn

The Amazon Resource Name (ARN) of the IAM role used by the connector to access Amazon Web Services resources.

public virtual string ServiceExecutionRoleArn { get; set; }
Property Value

System.String

Tags

A collection of tags associated with a resource.

public virtual ICfnTag[] Tags { get; set; }
Property Value

ICfnTag[]

WorkerConfiguration

The worker configurations that are in use with the connector.

public virtual object WorkerConfiguration { get; set; }
Property Value

System.Object

Methods

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.

public virtual void Inspect(TreeInspector inspector)
Parameters
inspector TreeInspector

tree inspector to collect and process attributes.

RenderProperties(IDictionary<String, Object>)

protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns

System.Collections.Generic.IDictionary<System.String, System.Object>

Overrides

Implements