Interface CfnConnectorProps
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnConnectorProps.Jsii$Proxy
CfnConnector.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.kafkaconnect.*;
CfnConnectorProps cfnConnectorProps = CfnConnectorProps.builder()
.capacity(CapacityProperty.builder()
.autoScaling(AutoScalingProperty.builder()
.maxWorkerCount(123)
.mcuCount(123)
.minWorkerCount(123)
.scaleInPolicy(ScaleInPolicyProperty.builder()
.cpuUtilizationPercentage(123)
.build())
.scaleOutPolicy(ScaleOutPolicyProperty.builder()
.cpuUtilizationPercentage(123)
.build())
.build())
.provisionedCapacity(ProvisionedCapacityProperty.builder()
.workerCount(123)
// the properties below are optional
.mcuCount(123)
.build())
.build())
.connectorConfiguration(Map.of(
"connectorConfigurationKey", "connectorConfiguration"))
.connectorName("connectorName")
.kafkaCluster(KafkaClusterProperty.builder()
.apacheKafkaCluster(ApacheKafkaClusterProperty.builder()
.bootstrapServers("bootstrapServers")
.vpc(VpcProperty.builder()
.securityGroups(List.of("securityGroups"))
.subnets(List.of("subnets"))
.build())
.build())
.build())
.kafkaClusterClientAuthentication(KafkaClusterClientAuthenticationProperty.builder()
.authenticationType("authenticationType")
.build())
.kafkaClusterEncryptionInTransit(KafkaClusterEncryptionInTransitProperty.builder()
.encryptionType("encryptionType")
.build())
.kafkaConnectVersion("kafkaConnectVersion")
.plugins(List.of(PluginProperty.builder()
.customPlugin(CustomPluginProperty.builder()
.customPluginArn("customPluginArn")
.revision(123)
.build())
.build()))
.serviceExecutionRoleArn("serviceExecutionRoleArn")
// the properties below are optional
.connectorDescription("connectorDescription")
.logDelivery(LogDeliveryProperty.builder()
.workerLogDelivery(WorkerLogDeliveryProperty.builder()
.cloudWatchLogs(CloudWatchLogsLogDeliveryProperty.builder()
.enabled(false)
// the properties below are optional
.logGroup("logGroup")
.build())
.firehose(FirehoseLogDeliveryProperty.builder()
.enabled(false)
// the properties below are optional
.deliveryStream("deliveryStream")
.build())
.s3(S3LogDeliveryProperty.builder()
.enabled(false)
// the properties below are optional
.bucket("bucket")
.prefix("prefix")
.build())
.build())
.build())
.tags(List.of(CfnTag.builder()
.key("key")
.value("value")
.build()))
.workerConfiguration(WorkerConfigurationProperty.builder()
.revision(123)
.workerConfigurationArn("workerConfigurationArn")
.build())
.build();
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final classA builder forCfnConnectorPropsstatic final classAn implementation forCfnConnectorProps -
Method Summary
Modifier and TypeMethodDescriptionstatic CfnConnectorProps.Builderbuilder()The connector's compute capacity settings.The configuration of the connector.default StringThe description of the connector.The name of the connector.The details of the Apache Kafka cluster to which the connector is connected.The type of client authentication used to connect to the Apache Kafka cluster.Details of encryption in transit to the Apache Kafka cluster.The version of Kafka Connect.default ObjectThe settings for delivering connector logs to Amazon CloudWatch Logs.Specifies which plugin to use for the connector.The Amazon Resource Name (ARN) of the IAM role used by the connector to access Amazon Web Services resources.getTags()A collection of tags associated with a resource.default ObjectThe worker configurations that are in use with the connector.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getCapacity
The connector's compute capacity settings.Returns union: either
IResolvableorCfnConnector.CapacityProperty- See Also:
-
getConnectorConfiguration
The configuration of the connector.Returns union: either Mapinvalid input: '<'String,
String> orIResolvable- See Also:
-
getConnectorName
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 -.
- See Also:
-
getKafkaCluster
The details of the Apache Kafka cluster to which the connector is connected.Returns union: either
IResolvableorCfnConnector.KafkaClusterProperty- See Also:
-
getKafkaClusterClientAuthentication
The type of client authentication used to connect to the Apache Kafka cluster.The value is NONE when no client authentication is used.
Returns union: either
IResolvableorCfnConnector.KafkaClusterClientAuthenticationProperty- See Also:
-
getKafkaClusterEncryptionInTransit
Details of encryption in transit to the Apache Kafka cluster.Returns union: either
IResolvableorCfnConnector.KafkaClusterEncryptionInTransitProperty- See Also:
-
getKafkaConnectVersion
The version of Kafka Connect.It has to be compatible with both the Apache Kafka cluster's version and the plugins.
- See Also:
-
getPlugins
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.
Returns union: either
IResolvableor Listinvalid input: '<'eitherIResolvableorCfnConnector.PluginProperty>- See Also:
-
getServiceExecutionRoleArn
The Amazon Resource Name (ARN) of the IAM role used by the connector to access Amazon Web Services resources.- See Also:
-
getConnectorDescription
The description of the connector.- See Also:
-
getLogDelivery
The settings for delivering connector logs to Amazon CloudWatch Logs.Returns union: either
IResolvableorCfnConnector.LogDeliveryProperty- See Also:
-
getTags
A collection of tags associated with a resource.- See Also:
-
getWorkerConfiguration
The worker configurations that are in use with the connector.Returns union: either
IResolvableorCfnConnector.WorkerConfigurationProperty- See Also:
-
builder
- Returns:
- a
CfnConnectorProps.BuilderofCfnConnectorProps
-