URI HTTP methods Schemas Properties See also

Cluster Connectivity

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

URI

/v1/clusters/clusterArn/connectivity

HTTP methods

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

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

Schemas

Request bodies


{
  "connectivityInfo": {
    "publicAccess": {
      "type": "string"
    },
    "vpcConnectivity": {
      "clientAuthentication": {
        "sasl": {
          "iam": {
            "enabled": boolean
          },
          "scram": {
            "enabled": boolean
          }
        },
        "tls": {
          "enabled": boolean
        }
      }
    }
  },
  "currentVersion": "string"
}

Response bodies


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


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

Properties

ConnectivityInfo

Broker access controls.

Property	Type	Required	Description
`publicAccess`	PublicAccess	False	Access control settings for the cluster's brokers.
`vpcConnectivity`	VpcConnectivity	False	VPC connection control settings for 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.

VpcConnectivity

VPC connection control settings for brokers.

Property	Type	Required	Description
`clientAuthentication`	VpcConnectivityClientAuthentication	False	VPC connection control settings for brokers.

VpcConnectivityClientAuthentication

Includes all client authentication information for VpcConnectivity.

Property	Type	Required	Description
`sasl`	VpcConnectivitySasl	False	Details for VpcConnectivity ClientAuthentication using SASL.
`tls`	VpcConnectivityTls	False	Details for VpcConnectivity ClientAuthentication using TLS.

VpcConnectivityIAM

Details for SASL/IAM client authentication for VpcConnectivity.

Property	Type	Required	Description
`enabled`	boolean	False	SASL/IAM authentication is enabled or not.

VpcConnectivitySasl

Details for client authentication using SASL for VpcConnectivity.

Property	Type	Required	Description
`iam`	VpcConnectivityIAM	False	Details for ClientAuthentication using IAM for VpcConnectivity.
`scram`	VpcConnectivityScram	False	Details for SASL/SCRAM client authentication for VpcConnectivity.

VpcConnectivityScram

Details for SASL/SCRAM client authentication for vpcConnectivity.

Property	Type	Required	Description
`enabled`	boolean	False	SASL/SCRAM authentication is enabled or not.

VpcConnectivityTls

Details for client authentication using TLS for vpcConnectivity.

Property	Type	Required	Description
`enabled`	boolean	False	TLS authentication is enabled or not.