Skip to content

update_connectivity

update_connectivity(
    cluster_arn: __string,
    *,
    config_overrides: Optional[KafkaClientConfig] = None,
    connectivity_info: Optional[ConnectivityInfo] = None,
    current_version: Optional[__string] = None,
    zookeeper_access: Optional[ZookeeperAccess] = None,
) -> UpdateConnectivityResponse

Updates the cluster's connectivity configuration.

Parameters:

  • cluster_arn (__string) –

    The Amazon Resource Name (ARN) of the configuration.

  • connectivity_info (Optional[ConnectivityInfo], default: None ) –

    Information about the broker access configuration.

  • current_version (Optional[__string], default: None ) –

    The version of the MSK cluster to update. Cluster versions aren't simple numbers. You can describe an MSK cluster to find its version. When this update operation is successful, it generates a new cluster version.

  • zookeeper_access (Optional[ZookeeperAccess], default: None ) –

    Access control settings for zookeeper

Raises:

Source code in docs_src/capo_kafka/_services/kafka.py
def update_connectivity(
    self,
    cluster_arn: "capo_kafka.types.__string.__string",
    *,
    config_overrides: Optional[KafkaClientConfig] = None,
    connectivity_info: Optional[
        "capo_kafka.types.connectivity_info.ConnectivityInfo"
    ] = None,
    current_version: Optional["capo_kafka.types.__string.__string"] = None,
    zookeeper_access: Optional[
        "capo_kafka.types.zookeeper_access.ZookeeperAccess"
    ] = None,
) -> "capo_kafka.types.update_connectivity_response.UpdateConnectivityResponse":
    """<p>Updates the cluster's connectivity configuration.</p>

    Args:
        cluster_arn: <p>The Amazon Resource Name (ARN) of the configuration.</p>
        connectivity_info: <p>Information about the broker access configuration.</p>
        current_version: <p>The version of the MSK cluster to update. Cluster versions aren't simple numbers. You can describe an MSK cluster to find its version. When this update operation is successful, it generates a new cluster version.</p>
        zookeeper_access: <p>Access control settings for zookeeper</p>

    Raises:
        capo_kafka.errors.bad_request_exception.BadRequestException: <p>Returns information about an error.</p>
        capo_kafka.errors.forbidden_exception.ForbiddenException: <p>Returns information about an error.</p>
        capo_kafka.errors.internal_server_error_exception.InternalServerErrorException: <p>Returns information about an error.</p>
        capo_kafka.errors.not_found_exception.NotFoundException: <p>Returns information about an error.</p>
        capo_kafka.errors.service_unavailable_exception.ServiceUnavailableException: <p>Returns information about an error.</p>
        capo_kafka.errors.unauthorized_exception.UnauthorizedException: <p>Returns information about an error.</p>
        capo_kafka.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_kafka.types.update_connectivity_request.UpdateConnectivityRequest]",
    ) -> OperationResponse[
        "capo_kafka.types.update_connectivity_response.UpdateConnectivityResponse"
    ]:
        import capo_kafka._operations.kafka.update_connectivity

        output, http_response = (
            capo_kafka._operations.kafka.update_connectivity.update_connectivity(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("UpdateConnectivity")
    )
    input_: capo_kafka.types.update_connectivity_request.UpdateConnectivityRequest = {
        "cluster_arn": cluster_arn
    }
    if connectivity_info is not None:
        input_["connectivity_info"] = connectivity_info
    if current_version is not None:
        input_["current_version"] = current_version
    if zookeeper_access is not None:
        input_["zookeeper_access"] = zookeeper_access

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output