Amazon Managed Streaming for Apache Kafka
Amazon MSK API Reference

Cluster Configuration

Represents the configuration of a specific cluster.

URI

/v1/clusters/clusterArn/configuration

HTTP Methods

PUT

Operation ID: UpdateClusterConfiguration

Updates the cluster with the configuration that is specified in the request body.

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 UpdateClusterConfigurationResponse

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.

500 Error

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

503 Error

503 response

Schemas

Request Bodies

Example PUT

{ "configurationInfo": { "arn": "string", "revision": integer }, "currentVersion": "string" }

Response Bodies

Example UpdateClusterConfigurationResponse

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

Example Error

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

Properties

ConfigurationInfo

Specifies the configuration to use for the brokers.

Property Type Required Description
arn

string

True

ARN of the configuration to use.

revision

integer

Format: int64

Minimum: 1

True

The revision of the configuration to use.

Error

Returns information about an error.

Property Type Required Description
message

string

False

The description of the error.

invalidParameter

string

False

The parameter that caused the error.

UpdateClusterConfigurationRequest

Request body for UpdateClusterConfiguration.

Property Type Required Description
configurationInfo

ConfigurationInfo

True

Represents the configuration that you want MSK to use for the cluster.

currentVersion

string

True

The version of the cluster that you want to update.

UpdateClusterConfigurationResponse

Response body for UpdateClusterConfiguration.

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:

UpdateClusterConfiguration