create_connector
¶
create_connector(
capacity: Capacity,
connector_configuration: ConnectorConfiguration,
connector_name: __stringMin1Max128,
kafka_cluster: KafkaCluster,
kafka_cluster_client_authentication: KafkaClusterClientAuthentication,
kafka_cluster_encryption_in_transit: KafkaClusterEncryptionInTransit,
kafka_connect_version: __string,
plugins: __listOfPlugin,
service_execution_role_arn: __string,
*,
config_overrides: Optional[KafkaConnectClientConfig] = None,
connector_description: Optional[__stringMax1024] = None,
log_delivery: Optional[LogDelivery] = None,
network_type: Optional[NetworkType] = None,
worker_configuration: Optional[WorkerConfiguration] = None,
tags: Optional[Tags] = None,
) -> CreateConnectorResponse
Creates a connector using the specified properties.
Parameters:
-
capacity(Capacity) –Information about the capacity allocated to the connector. Exactly one of the two properties must be specified.
-
connector_configuration(ConnectorConfiguration) –A map of keys to values that represent the configuration for the connector.
-
connector_description(Optional[__stringMax1024], default:None) –A summary description of the connector.
-
connector_name(__stringMin1Max128) –The name of the connector.
-
kafka_cluster(KafkaCluster) –Specifies which Apache Kafka cluster to connect to.
-
kafka_cluster_client_authentication(KafkaClusterClientAuthentication) –Details of the client authentication used by the Apache Kafka cluster.
-
kafka_cluster_encryption_in_transit(KafkaClusterEncryptionInTransit) –Details of encryption in transit to the Apache Kafka cluster.
-
kafka_connect_version(__string) –The version of Kafka Connect. It has to be compatible with both the Apache Kafka cluster's version and the plugins.
-
log_delivery(Optional[LogDelivery], default:None) –Details about log delivery.
-
network_type(Optional[NetworkType], default:None) –The network type of the connector. It gives connectors connectivity to either IPv4 (IPV4) or IPv4 and IPv6 (DUAL) destinations. Defaults to IPV4.
-
plugins(__listOfPlugin) –Amazon MSK Connect does not currently support specifying multiple plugins as a list. To use more than one plugin for your connector, you can create a single custom plugin using a ZIP file that bundles multiple plugins together.
Specifies which plugin to use for the connector. You must specify a single-element list containing one
customPluginobject. -
service_execution_role_arn(__string) –The Amazon Resource Name (ARN) of the IAM role used by the connector to access the Amazon Web Services resources that it needs. The types of resources depends on the logic of the connector. For example, a connector that has Amazon S3 as a destination must have permissions that allow it to write to the S3 destination bucket.
-
worker_configuration(Optional[WorkerConfiguration], default:None) –Specifies which worker configuration to use with the connector.
-
tags(Optional[Tags], default:None) –The tags you want to attach to the connector.
Raises:
-
BadRequestException–HTTP Status Code 400: Bad request due to incorrect input. Correct your request and then retry it.
-
ConflictException–HTTP Status Code 409: Conflict. A resource with this name already exists. Retry your request with another name.
-
ForbiddenException–HTTP Status Code 403: Access forbidden. Correct your credentials and then retry your request.
-
InternalServerErrorException–HTTP Status Code 500: Unexpected internal server error. Retrying your request might resolve the issue.
-
NotFoundException–HTTP Status Code 404: Resource not found due to incorrect input. Correct your request and then retry it.
-
ServiceUnavailableException–HTTP Status Code 503: Service Unavailable. Retrying your request in some time might resolve the issue.
-
TooManyRequestsException–HTTP Status Code 429: Limit exceeded. Resource limit reached.
-
UnauthorizedException–HTTP Status Code 401: Unauthorized request. The provided credentials couldn't be validated.
-
UnknownServiceError–The service returned an error code this client does not model.
Source code in docs_src/capo_kafkaconnect/_services/kafka_connect.py
208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 | |