update_connectivity

Kafka.Client.update_connectivity(**kwargs)

Updates the cluster's connectivity configuration.

See also: AWS API Documentation

Request Syntax

response = client.update_connectivity(
    ClusterArn='string',
    ConnectivityInfo={
        'PublicAccess': {
            'Type': 'string'
        }
    },
    CurrentVersion='string'
)

Parameters

• ClusterArn (string) --

  [REQUIRED]

  The Amazon Resource Name (ARN) of the configuration.

• ConnectivityInfo (dict) --

  [REQUIRED]

  Information about the broker access configuration.

  • PublicAccess (dict) --

    Public access control for brokers.

    • Type (string) --

      The value DISABLED indicates that public access is turned off. SERVICE_PROVIDED_EIPS indicates that public access is turned on.

• CurrentVersion (string) --

  [REQUIRED]

  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.

Return type

dict

Returns

Response Syntax

{
    'ClusterArn': 'string',
    'ClusterOperationArn': 'string'
}

Response Structure

• (dict) --

  Successful response.

  • ClusterArn (string) --

    The Amazon Resource Name (ARN) of the cluster.

  • ClusterOperationArn (string) --

    The Amazon Resource Name (ARN) of the cluster operation.

Exceptions

• Kafka.Client.exceptions.BadRequestException
• Kafka.Client.exceptions.UnauthorizedException
• Kafka.Client.exceptions.InternalServerErrorException
• Kafka.Client.exceptions.ForbiddenException
• Kafka.Client.exceptions.NotFoundException
• Kafka.Client.exceptions.ServiceUnavailableException