Interface ICfnConnectorProps
Properties for defining a CfnConnector
.
Namespace: Amazon.CDK.AWS.KafkaConnect
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public interface ICfnConnectorProps
Syntax (vb)
Public Interface ICfnConnectorProps
Remarks
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 cfnConnectorProps = 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
Properties
Capacity | The connector's compute capacity settings. |
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. |
Properties
Capacity
The connector's compute capacity settings.
object Capacity { get; }
Property Value
System.Object
Remarks
ConnectorConfiguration
The configuration of the connector.
object ConnectorConfiguration { get; }
Property Value
System.Object
Remarks
ConnectorDescription
The description of the connector.
virtual string ConnectorDescription { get; }
Property Value
System.String
Remarks
ConnectorName
The name of the connector.
string ConnectorName { get; }
Property Value
System.String
Remarks
KafkaCluster
The details of the Apache Kafka cluster to which the connector is connected.
object KafkaCluster { get; }
Property Value
System.Object
Remarks
KafkaClusterClientAuthentication
The type of client authentication used to connect to the Apache Kafka cluster.
object KafkaClusterClientAuthentication { get; }
Property Value
System.Object
Remarks
The value is NONE when no client authentication is used.
KafkaClusterEncryptionInTransit
Details of encryption in transit to the Apache Kafka cluster.
object KafkaClusterEncryptionInTransit { get; }
Property Value
System.Object
Remarks
KafkaConnectVersion
The version of Kafka Connect.
string KafkaConnectVersion { get; }
Property Value
System.String
Remarks
It has to be compatible with both the Apache Kafka cluster's version and the plugins.
LogDelivery
The settings for delivering connector logs to Amazon CloudWatch Logs.
virtual object LogDelivery { get; }
Property Value
System.Object
Remarks
Plugins
Specifies which plugin to use for the connector.
object Plugins { get; }
Property Value
System.Object
Remarks
You must specify a single-element list. Amazon MSK Connect does not currently support specifying multiple plugins.
ServiceExecutionRoleArn
The Amazon Resource Name (ARN) of the IAM role used by the connector to access Amazon Web Services resources.
string ServiceExecutionRoleArn { get; }
Property Value
System.String
Remarks
Tags
A collection of tags associated with a resource.
virtual ICfnTag[] Tags { get; }
Property Value
ICfnTag[]
Remarks
WorkerConfiguration
The worker configurations that are in use with the connector.
virtual object WorkerConfiguration { get; }
Property Value
System.Object