Cluster Connectivity - Amazon Managed Streaming for Apache Kafka

Cluster Connectivity

Use this resource to update the connectivity setting for an MSK cluster.

URI

/v1/clusters/clusterArn/connectivity

HTTP methods

PUT

Operation ID: UpdateConnectivity

Updates the connectivity setting for the cluster.

Path parameters
Name Type Required Description
clusterArn String True

The Amazon Resource Name (ARN) that uniquely identifies the cluster.

Responses
Status code Response model Description
200 UpdateConnectivityResponse

Successful response.

400 Error

The request isn't valid because the input is incorrect. Correct your input and then submit it again.

401 Error

The request is not authorized. The provided credentials couldn't be validated.

403 Error

Access forbidden. Check your credentials and then retry your request.

404 Error

The resource could not be found due to incorrect input. Correct the input, then retry the request.

429 Error

429 response

500 Error

There was an unexpected internal server error. Retrying your request might resolve the issue.

503 Error

503 response

OPTIONS

Enable CORS by returning the correct headers.

Path parameters
Name Type Required Description
clusterArn String True

The Amazon Resource Name (ARN) that uniquely identifies the cluster.

Responses
Status code Response model Description
200 None

Default response for CORS method

Schemas

Request bodies

{ "connectivityInfo": { "publicAccess": { "type": "string" } }, "currentVersion": "string" }

Response bodies

{ "clusterArn": "string", "clusterOperationArn": "string" }
{ "message": "string", "invalidParameter": "string" }

Properties

ConnectivityInfo

Broker access controls.

Property Type Required Description
publicAccess

PublicAccess

False

Access control settings for the cluster's brokers.

Error

Returns information about an error.

Property Type Required Description
invalidParameter

string

False

The parameter that caused the error.

message

string

False

The description of the error.

PublicAccess

Broker access controls

Property Type Required Description
type

string

False

DISABLED means that public access is turned off. SERVICE_PROVIDED_EIPS means that public access is turned on.

UpdateConnectivityRequest

Request body for UpdateConnectivity.

Property Type Required Description
connectivityInfo

ConnectivityInfo

True

The target connectivity setting for the cluster.

currentVersion

string

True

The current version of the cluster.

UpdateConnectivityResponse

Response body for UpdateConnectivity.

Property Type Required Description
clusterArn

string

False

The Amazon Resource Name (ARN) of the cluster.

clusterOperationArn

string

False

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

See also

For more information about using this API in one of the language-specific AWS SDKs and references, see the following:

UpdateConnectivity