openapi: 3.0.0 info: version: 2018-11-14 x-release: v4 title: Managed Streaming for Kafka Clusters API description: "\n

The operations for managing an Amazon MSK cluster.

" x-logo: url: https://api.apis.guru/v2/cache/logo/https_twitter.com_awscloud_profile_image.png backgroundColor: '#FFFFFF' termsOfService: https://aws.amazon.com/service-terms/ contact: name: Mike Ralphson email: mike.ralphson@gmail.com url: https://github.com/mermade/aws2openapi x-twitter: PermittedSoc license: name: Apache 2.0 License url: http://www.apache.org/licenses/ x-providerName: amazonaws.com x-serviceName: kafka x-aws-signingName: kafka x-origin: - contentType: application/json url: https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/kafka-2018-11-14.normal.json converter: url: https://github.com/mermade/aws2openapi version: 1.0.0 x-apisguru-driver: external x-apiClientRegistration: url: https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct x-apisguru-categories: - cloud x-preferred: true servers: - url: http://kafka.{region}.amazonaws.com variables: region: description: The AWS region enum: - us-east-1 - us-east-2 - us-west-1 - us-west-2 - us-gov-west-1 - us-gov-east-1 - ca-central-1 - eu-north-1 - eu-west-1 - eu-west-2 - eu-west-3 - eu-central-1 - eu-south-1 - af-south-1 - ap-northeast-1 - ap-northeast-2 - ap-northeast-3 - ap-southeast-1 - ap-southeast-2 - ap-east-1 - ap-south-1 - sa-east-1 - me-south-1 default: us-east-1 description: The Kafka multi-region endpoint - url: https://kafka.{region}.amazonaws.com variables: region: description: The AWS region enum: - us-east-1 - us-east-2 - us-west-1 - us-west-2 - us-gov-west-1 - us-gov-east-1 - ca-central-1 - eu-north-1 - eu-west-1 - eu-west-2 - eu-west-3 - eu-central-1 - eu-south-1 - af-south-1 - ap-northeast-1 - ap-northeast-2 - ap-northeast-3 - ap-southeast-1 - ap-southeast-2 - ap-east-1 - ap-south-1 - sa-east-1 - me-south-1 default: us-east-1 description: The Kafka multi-region endpoint - url: http://kafka.{region}.amazonaws.com.cn variables: region: description: The AWS region enum: - cn-north-1 - cn-northwest-1 default: cn-north-1 description: The Kafka endpoint for China (Beijing) and China (Ningxia) - url: https://kafka.{region}.amazonaws.com.cn variables: region: description: The AWS region enum: - cn-north-1 - cn-northwest-1 default: cn-north-1 description: The Kafka endpoint for China (Beijing) and China (Ningxia) security: - hmac: [] tags: - name: Clusters paths: /v1/clusters/{clusterArn}/scram-secrets: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: operationId: BatchAssociateScramSecret description: "\n

Associates one or more Scram Secrets with an Amazon MSK cluster.

" responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/BatchAssociateScramSecretResponse' examples: BatchAssociateScramSecret200Example: summary: Default BatchAssociateScramSecret 200 response x-microcks-default: true value: ClusterArn: arn:aws:service:us-east-1:123456789012:resource/example UnprocessedScramSecrets: example-value '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' examples: BatchAssociateScramSecret480Example: summary: Default BatchAssociateScramSecret 480 response x-microcks-default: true value: {} '481': description: UnauthorizedException content: application/json: schema: $ref: '#/components/schemas/UnauthorizedException' examples: BatchAssociateScramSecret481Example: summary: Default BatchAssociateScramSecret 481 response x-microcks-default: true value: {} '482': description: InternalServerErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorException' examples: BatchAssociateScramSecret482Example: summary: Default BatchAssociateScramSecret 482 response x-microcks-default: true value: {} '483': description: ForbiddenException content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' examples: BatchAssociateScramSecret483Example: summary: Default BatchAssociateScramSecret 483 response x-microcks-default: true value: {} '484': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' examples: BatchAssociateScramSecret484Example: summary: Default BatchAssociateScramSecret 484 response x-microcks-default: true value: {} '485': description: ServiceUnavailableException content: application/json: schema: $ref: '#/components/schemas/ServiceUnavailableException' examples: BatchAssociateScramSecret485Example: summary: Default BatchAssociateScramSecret 485 response x-microcks-default: true value: {} '486': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' examples: BatchAssociateScramSecret486Example: summary: Default BatchAssociateScramSecret 486 response x-microcks-default: true value: {} parameters: - name: clusterArn in: path required: true description: "\n

The Amazon Resource Name (ARN) of the cluster to be updated.

" schema: type: string requestBody: required: true content: application/json: schema: type: object required: - secretArnList properties: secretArnList: description: "\n

List of AWS Secrets Manager secret ARNs.

" type: array items: $ref: '#/components/schemas/__string' summary: Amazon MSK Batch Associate Scram Secret x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Clusters patch: operationId: BatchDisassociateScramSecret description: "\n

Disassociates one or more Scram Secrets from an Amazon MSK cluster.

" responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/BatchDisassociateScramSecretResponse' examples: BatchDisassociateScramSecret200Example: summary: Default BatchDisassociateScramSecret 200 response x-microcks-default: true value: ClusterArn: arn:aws:service:us-east-1:123456789012:resource/example UnprocessedScramSecrets: example-value '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' examples: BatchDisassociateScramSecret480Example: summary: Default BatchDisassociateScramSecret 480 response x-microcks-default: true value: {} '481': description: UnauthorizedException content: application/json: schema: $ref: '#/components/schemas/UnauthorizedException' examples: BatchDisassociateScramSecret481Example: summary: Default BatchDisassociateScramSecret 481 response x-microcks-default: true value: {} '482': description: InternalServerErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorException' examples: BatchDisassociateScramSecret482Example: summary: Default BatchDisassociateScramSecret 482 response x-microcks-default: true value: {} '483': description: ForbiddenException content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' examples: BatchDisassociateScramSecret483Example: summary: Default BatchDisassociateScramSecret 483 response x-microcks-default: true value: {} '484': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' examples: BatchDisassociateScramSecret484Example: summary: Default BatchDisassociateScramSecret 484 response x-microcks-default: true value: {} '485': description: ServiceUnavailableException content: application/json: schema: $ref: '#/components/schemas/ServiceUnavailableException' examples: BatchDisassociateScramSecret485Example: summary: Default BatchDisassociateScramSecret 485 response x-microcks-default: true value: {} '486': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' examples: BatchDisassociateScramSecret486Example: summary: Default BatchDisassociateScramSecret 486 response x-microcks-default: true value: {} parameters: - name: clusterArn in: path required: true description: "\n

The Amazon Resource Name (ARN) of the cluster to be updated.

" schema: type: string requestBody: required: true content: application/json: schema: type: object required: - secretArnList properties: secretArnList: description: "\n

List of AWS Secrets Manager secret ARNs.

" type: array items: $ref: '#/components/schemas/__string' summary: Amazon MSK Batch Disassociate Scram Secret x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Clusters get: operationId: ListScramSecrets description: "\n

Returns a list of the Scram Secrets associated with an Amazon MSK cluster.

" responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ListScramSecretsResponse' examples: ListScramSecrets200Example: summary: Default ListScramSecrets 200 response x-microcks-default: true value: NextToken: example-value SecretArnList: arn:aws:service:us-east-1:123456789012:resource/example '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' examples: ListScramSecrets480Example: summary: Default ListScramSecrets 480 response x-microcks-default: true value: {} '481': description: UnauthorizedException content: application/json: schema: $ref: '#/components/schemas/UnauthorizedException' examples: ListScramSecrets481Example: summary: Default ListScramSecrets 481 response x-microcks-default: true value: {} '482': description: InternalServerErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorException' examples: ListScramSecrets482Example: summary: Default ListScramSecrets 482 response x-microcks-default: true value: {} '483': description: ForbiddenException content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' examples: ListScramSecrets483Example: summary: Default ListScramSecrets 483 response x-microcks-default: true value: {} '484': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' examples: ListScramSecrets484Example: summary: Default ListScramSecrets 484 response x-microcks-default: true value: {} '485': description: ServiceUnavailableException content: application/json: schema: $ref: '#/components/schemas/ServiceUnavailableException' examples: ListScramSecrets485Example: summary: Default ListScramSecrets 485 response x-microcks-default: true value: {} '486': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' examples: ListScramSecrets486Example: summary: Default ListScramSecrets 486 response x-microcks-default: true value: {} parameters: - name: clusterArn in: path required: true description: "\n

The arn of the cluster.

" schema: type: string - name: maxResults in: query required: false description: "\n

The maxResults of the query.

" schema: type: integer minimum: 1 maximum: 100 - name: nextToken in: query required: false description: "\n

The nextToken of the query.

" schema: type: string - name: MaxResults in: query schema: type: string description: Pagination limit required: false - name: NextToken in: query schema: type: string description: Pagination token required: false summary: Amazon MSK List Scram Secrets x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Clusters /v1/clusters: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: operationId: CreateCluster description: "\n

Creates a new MSK cluster.

" responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/CreateClusterResponse' examples: CreateCluster200Example: summary: Default CreateCluster 200 response x-microcks-default: true value: ClusterArn: arn:aws:service:us-east-1:123456789012:resource/example ClusterName: example-resource State: example-value '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' examples: CreateCluster480Example: summary: Default CreateCluster 480 response x-microcks-default: true value: {} '481': description: InternalServerErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorException' examples: CreateCluster481Example: summary: Default CreateCluster 481 response x-microcks-default: true value: {} '482': description: UnauthorizedException content: application/json: schema: $ref: '#/components/schemas/UnauthorizedException' examples: CreateCluster482Example: summary: Default CreateCluster 482 response x-microcks-default: true value: {} '483': description: ForbiddenException content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' examples: CreateCluster483Example: summary: Default CreateCluster 483 response x-microcks-default: true value: {} '484': description: ServiceUnavailableException content: application/json: schema: $ref: '#/components/schemas/ServiceUnavailableException' examples: CreateCluster484Example: summary: Default CreateCluster 484 response x-microcks-default: true value: {} '485': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' examples: CreateCluster485Example: summary: Default CreateCluster 485 response x-microcks-default: true value: {} '486': description: ConflictException content: application/json: schema: $ref: '#/components/schemas/ConflictException' examples: CreateCluster486Example: summary: Default CreateCluster 486 response x-microcks-default: true value: {} parameters: [] requestBody: required: true content: application/json: schema: type: object required: - brokerNodeGroupInfo - clusterName - kafkaVersion - numberOfBrokerNodes properties: brokerNodeGroupInfo: description: "\n

Describes the setup to be used for Apache Kafka broker nodes in the cluster.

" type: object properties: BrokerAZDistribution: allOf: - $ref: '#/components/schemas/BrokerAZDistribution' - xml: name: brokerAZDistribution description: "\n

The distribution of broker nodes across Availability Zones. This is an optional parameter. If you don't specify it, Amazon MSK gives it the value DEFAULT. You can also explicitly set this parameter to the value DEFAULT. No other values are currently allowed.

\n

Amazon MSK distributes the broker nodes evenly across the Availability Zones that correspond to the subnets you provide when you create the cluster.

" ClientSubnets: allOf: - $ref: '#/components/schemas/__listOf__string' - xml: name: clientSubnets description: "\n

The list of subnets to connect to in the client virtual private cloud (VPC). AWS creates elastic network interfaces inside these subnets. Client applications use elastic network interfaces to produce and consume data. Client subnets can't occupy the Availability Zone with ID use use1-az3.

" InstanceType: allOf: - $ref: '#/components/schemas/__stringMin5Max32' - xml: name: instanceType description: "\n

The type of Amazon EC2 instances to use for Apache Kafka brokers. The following instance types are allowed: kafka.m5.large, kafka.m5.xlarge, kafka.m5.2xlarge,\nkafka.m5.4xlarge, kafka.m5.12xlarge, and kafka.m5.24xlarge.

" SecurityGroups: allOf: - $ref: '#/components/schemas/__listOf__string' - xml: name: securityGroups description: "\n

The AWS security groups to associate with the elastic network interfaces in order to specify who can connect to and communicate with the Amazon MSK cluster. If you don't specify a security group, Amazon MSK uses the default security group associated with the VPC.

" StorageInfo: allOf: - $ref: '#/components/schemas/StorageInfo' - xml: name: storageInfo description: "\n

Contains information about storage volumes attached to MSK broker nodes.

" ConnectivityInfo: allOf: - $ref: '#/components/schemas/ConnectivityInfo' - xml: name: connectivityInfo description: "\n

Information about the broker access configuration.

" clientAuthentication: description: "\n

Includes all client authentication information.

" type: object properties: Sasl: allOf: - $ref: '#/components/schemas/Sasl' - xml: name: sasl description: "\n

Details for ClientAuthentication using SASL.

" Tls: allOf: - $ref: '#/components/schemas/Tls' - xml: name: tls description: "\n

Details for ClientAuthentication using TLS.

" Unauthenticated: allOf: - $ref: '#/components/schemas/Unauthenticated' - xml: name: unauthenticated description: "\n

Contains information about unauthenticated traffic to the cluster.

" clusterName: description: "\n

The name of the cluster.

" type: string minLength: 1 maxLength: 64 configurationInfo: description: "\n

Specifies the configuration to use for the brokers.

" type: object properties: Arn: allOf: - $ref: '#/components/schemas/__string' - xml: name: arn description: "\n

ARN of the configuration to use.

" Revision: allOf: - $ref: '#/components/schemas/__long' - xml: name: revision description: "\n

The revision of the configuration to use.

" encryptionInfo: description: "\n

Includes encryption-related information, such as the AWS KMS key used for encrypting data at rest and whether you want MSK to encrypt your data in transit.

" type: object properties: EncryptionAtRest: allOf: - $ref: '#/components/schemas/EncryptionAtRest' - xml: name: encryptionAtRest description: "\n

The data-volume encryption details.

" EncryptionInTransit: allOf: - $ref: '#/components/schemas/EncryptionInTransit' - xml: name: encryptionInTransit description: "\n

The details for encryption in transit.

" enhancedMonitoring: description: "\n

Specifies which metrics are gathered for the MSK cluster. This property has the following possible values: DEFAULT, PER_BROKER, PER_TOPIC_PER_BROKER, and PER_TOPIC_PER_PARTITION. For a list of the metrics associated with each of these levels of monitoring, see Monitoring.

" type: string enum: - DEFAULT - PER_BROKER - PER_TOPIC_PER_BROKER - PER_TOPIC_PER_PARTITION openMonitoring: description: "\n

JMX and Node monitoring for the MSK cluster.

" type: object properties: Prometheus: allOf: - $ref: '#/components/schemas/PrometheusInfo' - xml: name: prometheus description: "\n

Prometheus settings.

" kafkaVersion: description: "\n

The version of Apache Kafka.

" type: string minLength: 1 maxLength: 128 loggingInfo: description: '' type: object properties: BrokerLogs: allOf: - $ref: '#/components/schemas/BrokerLogs' - xml: name: brokerLogs numberOfBrokerNodes: description: "\n

The number of broker nodes in the cluster.

" type: integer minimum: 1 maximum: 15 tags: description: "\n

Create tags when creating the cluster.

" type: object additionalProperties: $ref: '#/components/schemas/__string' storageMode: description: Controls storage mode for various supported storage tiers. type: string enum: - LOCAL - TIERED summary: Amazon MSK Create Cluster x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Clusters get: operationId: ListClusters description: "\n

Returns a list of all the MSK clusters in the current Region.

" responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ListClustersResponse' examples: ListClusters200Example: summary: Default ListClusters 200 response x-microcks-default: true value: ClusterInfoList: example-value NextToken: example-value '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' examples: ListClusters480Example: summary: Default ListClusters 480 response x-microcks-default: true value: {} '481': description: InternalServerErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorException' examples: ListClusters481Example: summary: Default ListClusters 481 response x-microcks-default: true value: {} '482': description: UnauthorizedException content: application/json: schema: $ref: '#/components/schemas/UnauthorizedException' examples: ListClusters482Example: summary: Default ListClusters 482 response x-microcks-default: true value: {} '483': description: ForbiddenException content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' examples: ListClusters483Example: summary: Default ListClusters 483 response x-microcks-default: true value: {} parameters: - name: clusterNameFilter in: query required: false description: "\n

Specify a prefix of the name of the clusters that you want to list. The service lists all the clusters whose names start with this prefix.

" schema: type: string - name: maxResults in: query required: false description: "\n

The maximum number of results to return in the response. If there are more results, the response includes a NextToken parameter.

" schema: type: integer minimum: 1 maximum: 100 - name: nextToken in: query required: false description: "\n

The paginated results marker. When the result of the operation is truncated, the call returns NextToken in the response. \n To get the next batch, provide this token in your next request.

" schema: type: string - name: MaxResults in: query schema: type: string description: Pagination limit required: false - name: NextToken in: query schema: type: string description: Pagination token required: false summary: Amazon MSK List Clusters x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Clusters /api/v2/clusters: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: operationId: CreateClusterV2 description: "\n

Creates a new MSK cluster.

" responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/CreateClusterV2Response' examples: CreateClusterV2200Example: summary: Default CreateClusterV2 200 response x-microcks-default: true value: ClusterArn: arn:aws:service:us-east-1:123456789012:resource/example ClusterName: example-resource State: example-value ClusterType: STANDARD '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' examples: CreateClusterV2480Example: summary: Default CreateClusterV2 480 response x-microcks-default: true value: {} '481': description: InternalServerErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorException' examples: CreateClusterV2481Example: summary: Default CreateClusterV2 481 response x-microcks-default: true value: {} '482': description: UnauthorizedException content: application/json: schema: $ref: '#/components/schemas/UnauthorizedException' examples: CreateClusterV2482Example: summary: Default CreateClusterV2 482 response x-microcks-default: true value: {} '483': description: ForbiddenException content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' examples: CreateClusterV2483Example: summary: Default CreateClusterV2 483 response x-microcks-default: true value: {} '484': description: ServiceUnavailableException content: application/json: schema: $ref: '#/components/schemas/ServiceUnavailableException' examples: CreateClusterV2484Example: summary: Default CreateClusterV2 484 response x-microcks-default: true value: {} '485': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' examples: CreateClusterV2485Example: summary: Default CreateClusterV2 485 response x-microcks-default: true value: {} '486': description: ConflictException content: application/json: schema: $ref: '#/components/schemas/ConflictException' examples: CreateClusterV2486Example: summary: Default CreateClusterV2 486 response x-microcks-default: true value: {} parameters: [] requestBody: required: true content: application/json: schema: type: object required: - clusterName properties: clusterName: description: "\n

The name of the cluster.

" type: string minLength: 1 maxLength: 64 tags: description: "\n

A map of tags that you want the cluster to have.

" type: object additionalProperties: $ref: '#/components/schemas/__string' provisioned: description: "\n

Provisioned cluster request.

" type: object properties: BrokerNodeGroupInfo: allOf: - $ref: '#/components/schemas/BrokerNodeGroupInfo' - xml: name: brokerNodeGroupInfo description: "\n

Information about the brokers.

" ClientAuthentication: allOf: - $ref: '#/components/schemas/ClientAuthentication' - xml: name: clientAuthentication description: "\n

Includes all client authentication information.

" ConfigurationInfo: allOf: - $ref: '#/components/schemas/ConfigurationInfo' - xml: name: configurationInfo description: "\n

Represents the configuration that you want Amazon MSK to use for the brokers in a cluster.

" EncryptionInfo: allOf: - $ref: '#/components/schemas/EncryptionInfo' - xml: name: encryptionInfo description: "\n

Includes all encryption-related information.

" EnhancedMonitoring: allOf: - $ref: '#/components/schemas/EnhancedMonitoring' - xml: name: enhancedMonitoring description: "\n

Specifies the level of monitoring for the MSK cluster. The possible values are DEFAULT, PER_BROKER, PER_TOPIC_PER_BROKER, and PER_TOPIC_PER_PARTITION.

" OpenMonitoring: allOf: - $ref: '#/components/schemas/OpenMonitoringInfo' - xml: name: openMonitoring description: "\n

The settings for open monitoring.

" KafkaVersion: allOf: - $ref: '#/components/schemas/__stringMin1Max128' - xml: name: kafkaVersion description: "\n

The Apache Kafka version that you want for the cluster.

" LoggingInfo: allOf: - $ref: '#/components/schemas/LoggingInfo' - xml: name: loggingInfo description: "\n

Log delivery information for the cluster.

" NumberOfBrokerNodes: allOf: - $ref: '#/components/schemas/__integerMin1Max15' - xml: name: numberOfBrokerNodes description: "\n

The number of broker nodes in the cluster.

" StorageMode: allOf: - $ref: '#/components/schemas/StorageMode' - xml: name: storageMode description: "\n

This controls storage mode for supported storage tiers.

" serverless: description: "\n

Serverless cluster request.

" type: object properties: VpcConfigs: allOf: - $ref: '#/components/schemas/__listOfVpcConfig' - xml: name: vpcConfigs description: "\n

The configuration of the Amazon VPCs for the cluster.

" ClientAuthentication: allOf: - $ref: '#/components/schemas/ServerlessClientAuthentication' - xml: name: clientAuthentication description: "\n

Includes all client authentication information.

" summary: Amazon MSK Create Cluster V2 x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Clusters get: operationId: ListClustersV2 description: "\n

Returns a list of all the MSK clusters in the current Region.

" responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ListClustersV2Response' examples: ListClustersV2200Example: summary: Default ListClustersV2 200 response x-microcks-default: true value: ClusterInfoList: example-value NextToken: example-value '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' examples: ListClustersV2480Example: summary: Default ListClustersV2 480 response x-microcks-default: true value: {} '481': description: InternalServerErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorException' examples: ListClustersV2481Example: summary: Default ListClustersV2 481 response x-microcks-default: true value: {} '482': description: UnauthorizedException content: application/json: schema: $ref: '#/components/schemas/UnauthorizedException' examples: ListClustersV2482Example: summary: Default ListClustersV2 482 response x-microcks-default: true value: {} '483': description: ForbiddenException content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' examples: ListClustersV2483Example: summary: Default ListClustersV2 483 response x-microcks-default: true value: {} parameters: - name: clusterNameFilter in: query required: false description: "\n

Specify a prefix of the names of the clusters that you want to list. The service lists all the clusters whose names start with this prefix.

" schema: type: string - name: clusterTypeFilter in: query required: false description: "\n

Specify either PROVISIONED or SERVERLESS.

" schema: type: string - name: maxResults in: query required: false description: "\n

The maximum number of results to return in the response. If there are more results, the response includes a NextToken parameter.

" schema: type: integer minimum: 1 maximum: 100 - name: nextToken in: query required: false description: "\n

The paginated results marker. When the result of the operation is truncated, the call returns NextToken in the response. \n To get the next batch, provide this token in your next request.

" schema: type: string - name: MaxResults in: query schema: type: string description: Pagination limit required: false - name: NextToken in: query schema: type: string description: Pagination token required: false summary: Amazon MSK List Clusters V2 x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Clusters /v1/clusters/{clusterArn}: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' delete: operationId: DeleteCluster description: "\n

Deletes the MSK cluster specified by the Amazon Resource Name (ARN) in the request.

" responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DeleteClusterResponse' examples: DeleteCluster200Example: summary: Default DeleteCluster 200 response x-microcks-default: true value: ClusterArn: arn:aws:service:us-east-1:123456789012:resource/example State: example-value '480': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' examples: DeleteCluster480Example: summary: Default DeleteCluster 480 response x-microcks-default: true value: {} '481': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' examples: DeleteCluster481Example: summary: Default DeleteCluster 481 response x-microcks-default: true value: {} '482': description: InternalServerErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorException' examples: DeleteCluster482Example: summary: Default DeleteCluster 482 response x-microcks-default: true value: {} '483': description: ForbiddenException content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' examples: DeleteCluster483Example: summary: Default DeleteCluster 483 response x-microcks-default: true value: {} parameters: - name: clusterArn in: path required: true description: "\n

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

" schema: type: string - name: currentVersion in: query required: false description: "\n

The current version of the MSK cluster.

" schema: type: string summary: Amazon MSK Delete Cluster x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Clusters get: operationId: DescribeCluster description: "\n

Returns a description of the MSK cluster whose Amazon Resource Name (ARN) is specified in the request.

" responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DescribeClusterResponse' examples: DescribeCluster200Example: summary: Default DescribeCluster 200 response x-microcks-default: true value: ClusterInfo: example-value '480': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' examples: DescribeCluster480Example: summary: Default DescribeCluster 480 response x-microcks-default: true value: {} '481': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' examples: DescribeCluster481Example: summary: Default DescribeCluster 481 response x-microcks-default: true value: {} '482': description: UnauthorizedException content: application/json: schema: $ref: '#/components/schemas/UnauthorizedException' examples: DescribeCluster482Example: summary: Default DescribeCluster 482 response x-microcks-default: true value: {} '483': description: InternalServerErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorException' examples: DescribeCluster483Example: summary: Default DescribeCluster 483 response x-microcks-default: true value: {} '484': description: ForbiddenException content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' examples: DescribeCluster484Example: summary: Default DescribeCluster 484 response x-microcks-default: true value: {} parameters: - name: clusterArn in: path required: true description: "\n

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

" schema: type: string summary: Amazon MSK Describe Cluster x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Clusters /api/v2/clusters/{clusterArn}: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' get: operationId: DescribeClusterV2 description: "\n

Returns a description of the MSK cluster whose Amazon Resource Name (ARN) is specified in the request.

" responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DescribeClusterV2Response' examples: DescribeClusterV2200Example: summary: Default DescribeClusterV2 200 response x-microcks-default: true value: ClusterInfo: example-value '480': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' examples: DescribeClusterV2480Example: summary: Default DescribeClusterV2 480 response x-microcks-default: true value: {} '481': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' examples: DescribeClusterV2481Example: summary: Default DescribeClusterV2 481 response x-microcks-default: true value: {} '482': description: UnauthorizedException content: application/json: schema: $ref: '#/components/schemas/UnauthorizedException' examples: DescribeClusterV2482Example: summary: Default DescribeClusterV2 482 response x-microcks-default: true value: {} '483': description: InternalServerErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorException' examples: DescribeClusterV2483Example: summary: Default DescribeClusterV2 483 response x-microcks-default: true value: {} '484': description: ForbiddenException content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' examples: DescribeClusterV2484Example: summary: Default DescribeClusterV2 484 response x-microcks-default: true value: {} parameters: - name: clusterArn in: path required: true description: "\n

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

" schema: type: string summary: Amazon MSK Describe Cluster V2 x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Clusters /v1/clusters/{clusterArn}/bootstrap-brokers: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' get: operationId: GetBootstrapBrokers description: "\n

A list of brokers that a client application can use to bootstrap.

" responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/GetBootstrapBrokersResponse' examples: GetBootstrapBrokers200Example: summary: Default GetBootstrapBrokers 200 response x-microcks-default: true value: BootstrapBrokerString: example-value BootstrapBrokerStringTls: example-value BootstrapBrokerStringSaslScram: example-value BootstrapBrokerStringSaslIam: example-value BootstrapBrokerStringPublicTls: example-value '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' examples: GetBootstrapBrokers480Example: summary: Default GetBootstrapBrokers 480 response x-microcks-default: true value: {} '481': description: UnauthorizedException content: application/json: schema: $ref: '#/components/schemas/UnauthorizedException' examples: GetBootstrapBrokers481Example: summary: Default GetBootstrapBrokers 481 response x-microcks-default: true value: {} '482': description: InternalServerErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorException' examples: GetBootstrapBrokers482Example: summary: Default GetBootstrapBrokers 482 response x-microcks-default: true value: {} '483': description: ConflictException content: application/json: schema: $ref: '#/components/schemas/ConflictException' examples: GetBootstrapBrokers483Example: summary: Default GetBootstrapBrokers 483 response x-microcks-default: true value: {} '484': description: ForbiddenException content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' examples: GetBootstrapBrokers484Example: summary: Default GetBootstrapBrokers 484 response x-microcks-default: true value: {} parameters: - name: clusterArn in: path required: true description: "\n

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

" schema: type: string summary: Amazon MSK Get Bootstrap Brokers x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Clusters /v1/clusters/{clusterArn}/operations: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' get: operationId: ListClusterOperations description: "\n

Returns a list of all the operations that have been performed on the specified MSK cluster.

" responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ListClusterOperationsResponse' examples: ListClusterOperations200Example: summary: Default ListClusterOperations 200 response x-microcks-default: true value: ClusterOperationInfoList: example-value NextToken: example-value '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' examples: ListClusterOperations480Example: summary: Default ListClusterOperations 480 response x-microcks-default: true value: {} '481': description: InternalServerErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorException' examples: ListClusterOperations481Example: summary: Default ListClusterOperations 481 response x-microcks-default: true value: {} '482': description: UnauthorizedException content: application/json: schema: $ref: '#/components/schemas/UnauthorizedException' examples: ListClusterOperations482Example: summary: Default ListClusterOperations 482 response x-microcks-default: true value: {} '483': description: ForbiddenException content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' examples: ListClusterOperations483Example: summary: Default ListClusterOperations 483 response x-microcks-default: true value: {} parameters: - name: clusterArn in: path required: true description: "\n

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

" schema: type: string - name: maxResults in: query required: false description: "\n

The maximum number of results to return in the response. If there are more results, the response includes a NextToken parameter.

" schema: type: integer minimum: 1 maximum: 100 - name: nextToken in: query required: false description: "\n

The paginated results marker. When the result of the operation is truncated, the call returns NextToken in the response. \n To get the next batch, provide this token in your next request.

" schema: type: string - name: MaxResults in: query schema: type: string description: Pagination limit required: false - name: NextToken in: query schema: type: string description: Pagination token required: false summary: Amazon MSK List Cluster Operations x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Clusters /v1/clusters/{clusterArn}/nodes: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' get: operationId: ListNodes description: "\n

Returns a list of the broker nodes in the cluster.

" responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ListNodesResponse' examples: ListNodes200Example: summary: Default ListNodes 200 response x-microcks-default: true value: NextToken: example-value NodeInfoList: example-value '480': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' examples: ListNodes480Example: summary: Default ListNodes 480 response x-microcks-default: true value: {} '481': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' examples: ListNodes481Example: summary: Default ListNodes 481 response x-microcks-default: true value: {} '482': description: InternalServerErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorException' examples: ListNodes482Example: summary: Default ListNodes 482 response x-microcks-default: true value: {} '483': description: ForbiddenException content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' examples: ListNodes483Example: summary: Default ListNodes 483 response x-microcks-default: true value: {} parameters: - name: clusterArn in: path required: true description: "\n

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

" schema: type: string - name: maxResults in: query required: false description: "\n

The maximum number of results to return in the response. If there are more results, the response includes a NextToken parameter.

" schema: type: integer minimum: 1 maximum: 100 - name: nextToken in: query required: false description: "\n

The paginated results marker. When the result of the operation is truncated, the call returns NextToken in the response. \n To get the next batch, provide this token in your next request.

" schema: type: string - name: MaxResults in: query schema: type: string description: Pagination limit required: false - name: NextToken in: query schema: type: string description: Pagination token required: false summary: Amazon MSK List Nodes x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Clusters /v1/clusters/{clusterArn}/reboot-broker: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' put: operationId: RebootBroker description: Reboots brokers. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/RebootBrokerResponse' examples: RebootBroker200Example: summary: Default RebootBroker 200 response x-microcks-default: true value: ClusterArn: arn:aws:service:us-east-1:123456789012:resource/example ClusterOperationArn: arn:aws:service:us-east-1:123456789012:resource/example '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' examples: RebootBroker480Example: summary: Default RebootBroker 480 response x-microcks-default: true value: {} '481': description: UnauthorizedException content: application/json: schema: $ref: '#/components/schemas/UnauthorizedException' examples: RebootBroker481Example: summary: Default RebootBroker 481 response x-microcks-default: true value: {} '482': description: InternalServerErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorException' examples: RebootBroker482Example: summary: Default RebootBroker 482 response x-microcks-default: true value: {} '483': description: ForbiddenException content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' examples: RebootBroker483Example: summary: Default RebootBroker 483 response x-microcks-default: true value: {} '484': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' examples: RebootBroker484Example: summary: Default RebootBroker 484 response x-microcks-default: true value: {} '485': description: ServiceUnavailableException content: application/json: schema: $ref: '#/components/schemas/ServiceUnavailableException' examples: RebootBroker485Example: summary: Default RebootBroker 485 response x-microcks-default: true value: {} '486': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' examples: RebootBroker486Example: summary: Default RebootBroker 486 response x-microcks-default: true value: {} parameters: - name: clusterArn in: path required: true description: "\n

The Amazon Resource Name (ARN) of the cluster to be updated.

" schema: type: string requestBody: required: true content: application/json: schema: type: object required: - brokerIds properties: brokerIds: description: "\n

The list of broker IDs to be rebooted. The reboot-broker operation supports rebooting one broker at a time.

" type: array items: $ref: '#/components/schemas/__string' summary: Amazon MSK Reboot Broker x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Clusters /v1/clusters/{clusterArn}/nodes/count: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' put: operationId: UpdateBrokerCount description: "\n

Updates the number of broker nodes in the cluster.

" responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/UpdateBrokerCountResponse' examples: UpdateBrokerCount200Example: summary: Default UpdateBrokerCount 200 response x-microcks-default: true value: ClusterArn: arn:aws:service:us-east-1:123456789012:resource/example ClusterOperationArn: arn:aws:service:us-east-1:123456789012:resource/example '480': description: ServiceUnavailableException content: application/json: schema: $ref: '#/components/schemas/ServiceUnavailableException' examples: UpdateBrokerCount480Example: summary: Default UpdateBrokerCount 480 response x-microcks-default: true value: {} '481': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' examples: UpdateBrokerCount481Example: summary: Default UpdateBrokerCount 481 response x-microcks-default: true value: {} '482': description: UnauthorizedException content: application/json: schema: $ref: '#/components/schemas/UnauthorizedException' examples: UpdateBrokerCount482Example: summary: Default UpdateBrokerCount 482 response x-microcks-default: true value: {} '483': description: InternalServerErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorException' examples: UpdateBrokerCount483Example: summary: Default UpdateBrokerCount 483 response x-microcks-default: true value: {} '484': description: ForbiddenException content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' examples: UpdateBrokerCount484Example: summary: Default UpdateBrokerCount 484 response x-microcks-default: true value: {} parameters: - name: clusterArn in: path required: true description: "\n

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

" schema: type: string requestBody: required: true content: application/json: schema: type: object required: - currentVersion - targetNumberOfBrokerNodes properties: currentVersion: description: "\n

The version of cluster to update from. A successful operation will then generate a new version.

" type: string targetNumberOfBrokerNodes: description: "\n

The number of broker nodes that you want the cluster to have after this operation completes successfully.

" type: integer minimum: 1 maximum: 15 summary: Amazon MSK Update Broker Count x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Clusters /v1/clusters/{clusterArn}/nodes/type: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' put: operationId: UpdateBrokerType description: "\n

Updates EC2 instance type.

" responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/UpdateBrokerTypeResponse' examples: UpdateBrokerType200Example: summary: Default UpdateBrokerType 200 response x-microcks-default: true value: ClusterArn: arn:aws:service:us-east-1:123456789012:resource/example ClusterOperationArn: arn:aws:service:us-east-1:123456789012:resource/example '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' examples: UpdateBrokerType480Example: summary: Default UpdateBrokerType 480 response x-microcks-default: true value: {} '481': description: UnauthorizedException content: application/json: schema: $ref: '#/components/schemas/UnauthorizedException' examples: UpdateBrokerType481Example: summary: Default UpdateBrokerType 481 response x-microcks-default: true value: {} '482': description: InternalServerErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorException' examples: UpdateBrokerType482Example: summary: Default UpdateBrokerType 482 response x-microcks-default: true value: {} '483': description: ForbiddenException content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' examples: UpdateBrokerType483Example: summary: Default UpdateBrokerType 483 response x-microcks-default: true value: {} '484': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' examples: UpdateBrokerType484Example: summary: Default UpdateBrokerType 484 response x-microcks-default: true value: {} '485': description: ServiceUnavailableException content: application/json: schema: $ref: '#/components/schemas/ServiceUnavailableException' examples: UpdateBrokerType485Example: summary: Default UpdateBrokerType 485 response x-microcks-default: true value: {} '486': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' examples: UpdateBrokerType486Example: summary: Default UpdateBrokerType 486 response x-microcks-default: true value: {} parameters: - name: clusterArn in: path required: true description: "\n

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

" schema: type: string requestBody: required: true content: application/json: schema: type: object required: - currentVersion - targetInstanceType properties: currentVersion: description: "\n

The cluster version that you want to change. After this operation completes successfully, the cluster will have a new version.

" type: string targetInstanceType: description: "\n

The Amazon MSK broker type that you want all of the brokers in this cluster to be.

" type: string summary: Amazon MSK Update Broker Type x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Clusters /v1/clusters/{clusterArn}/nodes/storage: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' put: operationId: UpdateBrokerStorage description: "\n

Updates the EBS storage associated with MSK brokers.

" responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/UpdateBrokerStorageResponse' examples: UpdateBrokerStorage200Example: summary: Default UpdateBrokerStorage 200 response x-microcks-default: true value: ClusterArn: arn:aws:service:us-east-1:123456789012:resource/example ClusterOperationArn: arn:aws:service:us-east-1:123456789012:resource/example '480': description: ServiceUnavailableException content: application/json: schema: $ref: '#/components/schemas/ServiceUnavailableException' examples: UpdateBrokerStorage480Example: summary: Default UpdateBrokerStorage 480 response x-microcks-default: true value: {} '481': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' examples: UpdateBrokerStorage481Example: summary: Default UpdateBrokerStorage 481 response x-microcks-default: true value: {} '482': description: UnauthorizedException content: application/json: schema: $ref: '#/components/schemas/UnauthorizedException' examples: UpdateBrokerStorage482Example: summary: Default UpdateBrokerStorage 482 response x-microcks-default: true value: {} '483': description: InternalServerErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorException' examples: UpdateBrokerStorage483Example: summary: Default UpdateBrokerStorage 483 response x-microcks-default: true value: {} '484': description: ForbiddenException content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' examples: UpdateBrokerStorage484Example: summary: Default UpdateBrokerStorage 484 response x-microcks-default: true value: {} parameters: - name: clusterArn in: path required: true description: "\n

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

" schema: type: string requestBody: required: true content: application/json: schema: type: object required: - currentVersion - targetBrokerEBSVolumeInfo properties: currentVersion: description: "\n

The version of cluster to update from. A successful operation will then generate a new version.

" type: string targetBrokerEBSVolumeInfo: description: "\n

Describes the target volume size and the ID of the broker to apply the update to.

" type: array items: $ref: '#/components/schemas/BrokerEBSVolumeInfo' summary: Amazon MSK Update Broker Storage x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Clusters /v1/clusters/{clusterArn}/connectivity: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' put: operationId: UpdateConnectivity description: "\n

Updates the cluster's connectivity configuration.

" responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/UpdateConnectivityResponse' examples: UpdateConnectivity200Example: summary: Default UpdateConnectivity 200 response x-microcks-default: true value: ClusterArn: arn:aws:service:us-east-1:123456789012:resource/example ClusterOperationArn: arn:aws:service:us-east-1:123456789012:resource/example '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' examples: UpdateConnectivity480Example: summary: Default UpdateConnectivity 480 response x-microcks-default: true value: {} '481': description: UnauthorizedException content: application/json: schema: $ref: '#/components/schemas/UnauthorizedException' examples: UpdateConnectivity481Example: summary: Default UpdateConnectivity 481 response x-microcks-default: true value: {} '482': description: InternalServerErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorException' examples: UpdateConnectivity482Example: summary: Default UpdateConnectivity 482 response x-microcks-default: true value: {} '483': description: ForbiddenException content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' examples: UpdateConnectivity483Example: summary: Default UpdateConnectivity 483 response x-microcks-default: true value: {} '484': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' examples: UpdateConnectivity484Example: summary: Default UpdateConnectivity 484 response x-microcks-default: true value: {} '485': description: ServiceUnavailableException content: application/json: schema: $ref: '#/components/schemas/ServiceUnavailableException' examples: UpdateConnectivity485Example: summary: Default UpdateConnectivity 485 response x-microcks-default: true value: {} parameters: - name: clusterArn in: path required: true description: "\n

The Amazon Resource Name (ARN) of the configuration.

" schema: type: string requestBody: required: true content: application/json: schema: type: object required: - connectivityInfo - currentVersion properties: connectivityInfo: description: "\n

Information about the broker access configuration.

" type: object properties: PublicAccess: allOf: - $ref: '#/components/schemas/PublicAccess' - xml: name: publicAccess description: "\n

Public access control for brokers.

" currentVersion: description: "\n

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.

" type: string summary: Amazon MSK Update Connectivity x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Clusters /v1/clusters/{clusterArn}/configuration: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' put: operationId: UpdateClusterConfiguration description: "\n

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

" responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/UpdateClusterConfigurationResponse' examples: UpdateClusterConfiguration200Example: summary: Default UpdateClusterConfiguration 200 response x-microcks-default: true value: ClusterArn: arn:aws:service:us-east-1:123456789012:resource/example ClusterOperationArn: arn:aws:service:us-east-1:123456789012:resource/example '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' examples: UpdateClusterConfiguration480Example: summary: Default UpdateClusterConfiguration 480 response x-microcks-default: true value: {} '481': description: UnauthorizedException content: application/json: schema: $ref: '#/components/schemas/UnauthorizedException' examples: UpdateClusterConfiguration481Example: summary: Default UpdateClusterConfiguration 481 response x-microcks-default: true value: {} '482': description: InternalServerErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorException' examples: UpdateClusterConfiguration482Example: summary: Default UpdateClusterConfiguration 482 response x-microcks-default: true value: {} '483': description: ForbiddenException content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' examples: UpdateClusterConfiguration483Example: summary: Default UpdateClusterConfiguration 483 response x-microcks-default: true value: {} '484': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' examples: UpdateClusterConfiguration484Example: summary: Default UpdateClusterConfiguration 484 response x-microcks-default: true value: {} '485': description: ServiceUnavailableException content: application/json: schema: $ref: '#/components/schemas/ServiceUnavailableException' examples: UpdateClusterConfiguration485Example: summary: Default UpdateClusterConfiguration 485 response x-microcks-default: true value: {} parameters: - name: clusterArn in: path required: true description: "\n

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

" schema: type: string requestBody: required: true content: application/json: schema: type: object required: - configurationInfo - currentVersion properties: configurationInfo: description: "\n

Specifies the configuration to use for the brokers.

" type: object properties: Arn: allOf: - $ref: '#/components/schemas/__string' - xml: name: arn description: "\n

ARN of the configuration to use.

" Revision: allOf: - $ref: '#/components/schemas/__long' - xml: name: revision description: "\n

The revision of the configuration to use.

" currentVersion: description: "\n

The version of the cluster that needs to be updated.

" type: string summary: Amazon MSK Update Cluster Configuration x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Clusters /v1/clusters/{clusterArn}/version: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' put: operationId: UpdateClusterKafkaVersion description: "\n

Updates the Apache Kafka version for the cluster.

" responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/UpdateClusterKafkaVersionResponse' examples: UpdateClusterKafkaVersion200Example: summary: Default UpdateClusterKafkaVersion 200 response x-microcks-default: true value: ClusterArn: arn:aws:service:us-east-1:123456789012:resource/example ClusterOperationArn: arn:aws:service:us-east-1:123456789012:resource/example '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' examples: UpdateClusterKafkaVersion480Example: summary: Default UpdateClusterKafkaVersion 480 response x-microcks-default: true value: {} '481': description: UnauthorizedException content: application/json: schema: $ref: '#/components/schemas/UnauthorizedException' examples: UpdateClusterKafkaVersion481Example: summary: Default UpdateClusterKafkaVersion 481 response x-microcks-default: true value: {} '482': description: InternalServerErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorException' examples: UpdateClusterKafkaVersion482Example: summary: Default UpdateClusterKafkaVersion 482 response x-microcks-default: true value: {} '483': description: ForbiddenException content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' examples: UpdateClusterKafkaVersion483Example: summary: Default UpdateClusterKafkaVersion 483 response x-microcks-default: true value: {} '484': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' examples: UpdateClusterKafkaVersion484Example: summary: Default UpdateClusterKafkaVersion 484 response x-microcks-default: true value: {} '485': description: ServiceUnavailableException content: application/json: schema: $ref: '#/components/schemas/ServiceUnavailableException' examples: UpdateClusterKafkaVersion485Example: summary: Default UpdateClusterKafkaVersion 485 response x-microcks-default: true value: {} '486': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' examples: UpdateClusterKafkaVersion486Example: summary: Default UpdateClusterKafkaVersion 486 response x-microcks-default: true value: {} parameters: - name: clusterArn in: path required: true description: "\n

The Amazon Resource Name (ARN) of the cluster to be updated.

" schema: type: string requestBody: required: true content: application/json: schema: type: object required: - currentVersion - targetKafkaVersion properties: configurationInfo: description: "\n

Specifies the configuration to use for the brokers.

" type: object properties: Arn: allOf: - $ref: '#/components/schemas/__string' - xml: name: arn description: "\n

ARN of the configuration to use.

" Revision: allOf: - $ref: '#/components/schemas/__long' - xml: name: revision description: "\n

The revision of the configuration to use.

" currentVersion: description: "\n

Current cluster version.

" type: string targetKafkaVersion: description: "\n

Target Kafka version.

" type: string summary: Amazon MSK Update Cluster Kafka Version x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Clusters /v1/clusters/{clusterArn}/monitoring: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' put: operationId: UpdateMonitoring description: "\n

Updates the monitoring settings for the cluster. You can use this operation to specify which Apache Kafka metrics you want Amazon MSK to send to Amazon CloudWatch. You can also specify settings for open monitoring with Prometheus.

" responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/UpdateMonitoringResponse' examples: UpdateMonitoring200Example: summary: Default UpdateMonitoring 200 response x-microcks-default: true value: ClusterArn: arn:aws:service:us-east-1:123456789012:resource/example ClusterOperationArn: arn:aws:service:us-east-1:123456789012:resource/example '480': description: ServiceUnavailableException content: application/json: schema: $ref: '#/components/schemas/ServiceUnavailableException' examples: UpdateMonitoring480Example: summary: Default UpdateMonitoring 480 response x-microcks-default: true value: {} '481': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' examples: UpdateMonitoring481Example: summary: Default UpdateMonitoring 481 response x-microcks-default: true value: {} '482': description: UnauthorizedException content: application/json: schema: $ref: '#/components/schemas/UnauthorizedException' examples: UpdateMonitoring482Example: summary: Default UpdateMonitoring 482 response x-microcks-default: true value: {} '483': description: InternalServerErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorException' examples: UpdateMonitoring483Example: summary: Default UpdateMonitoring 483 response x-microcks-default: true value: {} '484': description: ForbiddenException content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' examples: UpdateMonitoring484Example: summary: Default UpdateMonitoring 484 response x-microcks-default: true value: {} parameters: - name: clusterArn in: path required: true description: "\n

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

" schema: type: string requestBody: required: true content: application/json: schema: type: object required: - currentVersion properties: currentVersion: description: "\n

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.

" type: string enhancedMonitoring: description: "\n

Specifies which metrics are gathered for the MSK cluster. This property has the following possible values: DEFAULT, PER_BROKER, PER_TOPIC_PER_BROKER, and PER_TOPIC_PER_PARTITION. For a list of the metrics associated with each of these levels of monitoring, see Monitoring.

" type: string enum: - DEFAULT - PER_BROKER - PER_TOPIC_PER_BROKER - PER_TOPIC_PER_PARTITION openMonitoring: description: "\n

JMX and Node monitoring for the MSK cluster.

" type: object properties: Prometheus: allOf: - $ref: '#/components/schemas/PrometheusInfo' - xml: name: prometheus description: "\n

Prometheus settings.

" loggingInfo: description: '' type: object properties: BrokerLogs: allOf: - $ref: '#/components/schemas/BrokerLogs' - xml: name: brokerLogs summary: Amazon MSK Update Monitoring x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Clusters /v1/clusters/{clusterArn}/security: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' patch: operationId: UpdateSecurity description: "\n

Updates the security settings for the cluster. You can use this operation to specify encryption and authentication on existing clusters.

" responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/UpdateSecurityResponse' examples: UpdateSecurity200Example: summary: Default UpdateSecurity 200 response x-microcks-default: true value: ClusterArn: arn:aws:service:us-east-1:123456789012:resource/example ClusterOperationArn: arn:aws:service:us-east-1:123456789012:resource/example '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' examples: UpdateSecurity480Example: summary: Default UpdateSecurity 480 response x-microcks-default: true value: {} '481': description: UnauthorizedException content: application/json: schema: $ref: '#/components/schemas/UnauthorizedException' examples: UpdateSecurity481Example: summary: Default UpdateSecurity 481 response x-microcks-default: true value: {} '482': description: InternalServerErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorException' examples: UpdateSecurity482Example: summary: Default UpdateSecurity 482 response x-microcks-default: true value: {} '483': description: ForbiddenException content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' examples: UpdateSecurity483Example: summary: Default UpdateSecurity 483 response x-microcks-default: true value: {} '484': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' examples: UpdateSecurity484Example: summary: Default UpdateSecurity 484 response x-microcks-default: true value: {} '485': description: ServiceUnavailableException content: application/json: schema: $ref: '#/components/schemas/ServiceUnavailableException' examples: UpdateSecurity485Example: summary: Default UpdateSecurity 485 response x-microcks-default: true value: {} '486': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' examples: UpdateSecurity486Example: summary: Default UpdateSecurity 486 response x-microcks-default: true value: {} parameters: - name: clusterArn in: path required: true description: "\n

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

" schema: type: string requestBody: required: true content: application/json: schema: type: object required: - currentVersion properties: clientAuthentication: description: "\n

Includes all client authentication information.

" type: object properties: Sasl: allOf: - $ref: '#/components/schemas/Sasl' - xml: name: sasl description: "\n

Details for ClientAuthentication using SASL.

" Tls: allOf: - $ref: '#/components/schemas/Tls' - xml: name: tls description: "\n

Details for ClientAuthentication using TLS.

" Unauthenticated: allOf: - $ref: '#/components/schemas/Unauthenticated' - xml: name: unauthenticated description: "\n

Contains information about unauthenticated traffic to the cluster.

" currentVersion: description: "\n

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.

" type: string encryptionInfo: description: "\n

Includes encryption-related information, such as the AWS KMS key used for encrypting data at rest and whether you want MSK to encrypt your data in transit.

" type: object properties: EncryptionAtRest: allOf: - $ref: '#/components/schemas/EncryptionAtRest' - xml: name: encryptionAtRest description: "\n

The data-volume encryption details.

" EncryptionInTransit: allOf: - $ref: '#/components/schemas/EncryptionInTransit' - xml: name: encryptionInTransit description: "\n

The details for encryption in transit.

" summary: Amazon MSK Update Security x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Clusters /v1/clusters/{clusterArn}/storage: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' put: operationId: UpdateStorage description: Updates cluster broker volume size (or) sets cluster storage mode to TIERED. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/UpdateStorageResponse' examples: UpdateStorage200Example: summary: Default UpdateStorage 200 response x-microcks-default: true value: ClusterArn: arn:aws:service:us-east-1:123456789012:resource/example ClusterOperationArn: arn:aws:service:us-east-1:123456789012:resource/example '480': description: BadRequestException content: application/json: schema: $ref: '#/components/schemas/BadRequestException' examples: UpdateStorage480Example: summary: Default UpdateStorage 480 response x-microcks-default: true value: {} '481': description: UnauthorizedException content: application/json: schema: $ref: '#/components/schemas/UnauthorizedException' examples: UpdateStorage481Example: summary: Default UpdateStorage 481 response x-microcks-default: true value: {} '482': description: InternalServerErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorException' examples: UpdateStorage482Example: summary: Default UpdateStorage 482 response x-microcks-default: true value: {} '483': description: ForbiddenException content: application/json: schema: $ref: '#/components/schemas/ForbiddenException' examples: UpdateStorage483Example: summary: Default UpdateStorage 483 response x-microcks-default: true value: {} '484': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' examples: UpdateStorage484Example: summary: Default UpdateStorage 484 response x-microcks-default: true value: {} '485': description: ServiceUnavailableException content: application/json: schema: $ref: '#/components/schemas/ServiceUnavailableException' examples: UpdateStorage485Example: summary: Default UpdateStorage 485 response x-microcks-default: true value: {} '486': description: TooManyRequestsException content: application/json: schema: $ref: '#/components/schemas/TooManyRequestsException' examples: UpdateStorage486Example: summary: Default UpdateStorage 486 response x-microcks-default: true value: {} parameters: - name: clusterArn in: path required: true description: "\n

The Amazon Resource Name (ARN) of the cluster to be updated.

" schema: type: string requestBody: required: true content: application/json: schema: type: object required: - currentVersion properties: currentVersion: description: "\n

The version of cluster to update from. A successful operation will then generate a new version.

" type: string provisionedThroughput: description: "\n

Contains information about provisioned throughput for EBS storage volumes attached to kafka broker nodes.

" type: object properties: Enabled: allOf: - $ref: '#/components/schemas/__boolean' - xml: name: enabled description: "\n

Provisioned throughput is enabled or not.

" VolumeThroughput: allOf: - $ref: '#/components/schemas/__integer' - xml: name: volumeThroughput description: "\n

Throughput value of the EBS volumes for the data drive on each kafka broker node in MiB per second.

" storageMode: description: Controls storage mode for various supported storage tiers. type: string enum: - LOCAL - TIERED volumeSizeGB: description: "\n

size of the EBS volume to update.

" type: integer summary: Amazon MSK Update Storage x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Clusters components: schemas: ConfigurationInfo: type: object required: - Revision - Arn properties: Arn: allOf: - $ref: '#/components/schemas/__string' - xml: name: arn description: "\n

ARN of the configuration to use.

" Revision: allOf: - $ref: '#/components/schemas/__long' - xml: name: revision description: "\n

The revision of the configuration to use.

" description: "\n

Specifies the configuration to use for the brokers.

" BrokerNodeGroupInfo: type: object required: - ClientSubnets - InstanceType properties: BrokerAZDistribution: allOf: - $ref: '#/components/schemas/BrokerAZDistribution' - xml: name: brokerAZDistribution description: "\n

The distribution of broker nodes across Availability Zones. This is an optional parameter. If you don't specify it, Amazon MSK gives it the value DEFAULT. You can also explicitly set this parameter to the value DEFAULT. No other values are currently allowed.

\n

Amazon MSK distributes the broker nodes evenly across the Availability Zones that correspond to the subnets you provide when you create the cluster.

" ClientSubnets: allOf: - $ref: '#/components/schemas/__listOf__string' - xml: name: clientSubnets description: "\n

The list of subnets to connect to in the client virtual private cloud (VPC). AWS creates elastic network interfaces inside these subnets. Client applications use elastic network interfaces to produce and consume data. Client subnets can't occupy the Availability Zone with ID use use1-az3.

" InstanceType: allOf: - $ref: '#/components/schemas/__stringMin5Max32' - xml: name: instanceType description: "\n

The type of Amazon EC2 instances to use for Apache Kafka brokers. The following instance types are allowed: kafka.m5.large, kafka.m5.xlarge, kafka.m5.2xlarge,\nkafka.m5.4xlarge, kafka.m5.12xlarge, and kafka.m5.24xlarge.

" SecurityGroups: allOf: - $ref: '#/components/schemas/__listOf__string' - xml: name: securityGroups description: "\n

The AWS security groups to associate with the elastic network interfaces in order to specify who can connect to and communicate with the Amazon MSK cluster. If you don't specify a security group, Amazon MSK uses the default security group associated with the VPC.

" StorageInfo: allOf: - $ref: '#/components/schemas/StorageInfo' - xml: name: storageInfo description: "\n

Contains information about storage volumes attached to MSK broker nodes.

" ConnectivityInfo: allOf: - $ref: '#/components/schemas/ConnectivityInfo' - xml: name: connectivityInfo description: "\n

Information about the broker access configuration.

" description: "\n

Describes the setup to be used for Apache Kafka broker nodes in the cluster.

" JmxExporterInfo: type: object required: - EnabledInBroker properties: EnabledInBroker: allOf: - $ref: '#/components/schemas/__boolean' - xml: name: enabledInBroker description: "\n

Indicates whether you want to turn on or turn off the JMX Exporter.

" description: "\n

Indicates whether you want to turn on or turn off the JMX Exporter.

" Tls: type: object properties: CertificateAuthorityArnList: allOf: - $ref: '#/components/schemas/__listOf__string' - xml: name: certificateAuthorityArnList description: "\n

List of ACM Certificate Authority ARNs.

" Enabled: allOf: - $ref: '#/components/schemas/__boolean' - xml: name: enabled description: "\n

Specifies whether you want to turn on or turn off TLS authentication.

" description: "\n

Details for client authentication using TLS.

" __listOfClusterInfo: type: array items: $ref: '#/components/schemas/ClusterInfo' Serverless: type: object required: - VpcConfigs properties: VpcConfigs: allOf: - $ref: '#/components/schemas/__listOfVpcConfig' - xml: name: vpcConfigs description: "\n

The configuration of the Amazon VPCs for the cluster.

" ClientAuthentication: allOf: - $ref: '#/components/schemas/ServerlessClientAuthentication' - xml: name: clientAuthentication description: "\n

Includes all client authentication information.

" description: "\n

Serverless cluster.

" BatchDisassociateScramSecretResponse: type: object properties: ClusterArn: allOf: - $ref: '#/components/schemas/__string' - xml: name: clusterArn description: "\n

The Amazon Resource Name (ARN) of the cluster.

" UnprocessedScramSecrets: allOf: - $ref: '#/components/schemas/__listOfUnprocessedScramSecret' - xml: name: unprocessedScramSecrets description: "\n

List of errors when disassociating secrets to cluster.

" CloudWatchLogs: type: object required: - Enabled properties: Enabled: allOf: - $ref: '#/components/schemas/__boolean' - xml: name: enabled LogGroup: allOf: - $ref: '#/components/schemas/__string' - xml: name: logGroup StorageInfo: type: object properties: EbsStorageInfo: allOf: - $ref: '#/components/schemas/EBSStorageInfo' - xml: name: ebsStorageInfo description: "\n

EBS volume information.

" description: "\n

Contains information about storage volumes attached to MSK broker nodes.

" InternalServerErrorException: {} ServerlessClientAuthentication: type: object properties: Sasl: allOf: - $ref: '#/components/schemas/ServerlessSasl' - xml: name: sasl description: "\n

Details for ClientAuthentication using SASL.

" description: "\n

Includes all client authentication information.

" ProvisionedThroughput: type: object properties: Enabled: allOf: - $ref: '#/components/schemas/__boolean' - xml: name: enabled description: "\n

Provisioned throughput is enabled or not.

" VolumeThroughput: allOf: - $ref: '#/components/schemas/__integer' - xml: name: volumeThroughput description: "\n

Throughput value of the EBS volumes for the data drive on each kafka broker node in MiB per second.

" description: "\n

Contains information about provisioned throughput for EBS storage volumes attached to kafka broker nodes.

" CreateClusterV2Response: type: object properties: ClusterArn: allOf: - $ref: '#/components/schemas/__string' - xml: name: clusterArn description: "\n

The Amazon Resource Name (ARN) of the cluster.

" ClusterName: allOf: - $ref: '#/components/schemas/__string' - xml: name: clusterName description: "\n

The name of the MSK cluster.

" State: allOf: - $ref: '#/components/schemas/ClusterState' - xml: name: state description: "\n

The state of the cluster. The possible states are ACTIVE, CREATING, DELETING, FAILED, HEALING, MAINTENANCE, REBOOTING_BROKER, and UPDATING.

" ClusterType: allOf: - $ref: '#/components/schemas/ClusterType' - xml: name: clusterType description: "\n

The type of the cluster. The possible states are PROVISIONED or SERVERLESS.

" PrometheusInfo: type: object properties: JmxExporter: allOf: - $ref: '#/components/schemas/JmxExporterInfo' - xml: name: jmxExporter description: "\n

Indicates whether you want to turn on or turn off the JMX Exporter.

" NodeExporter: allOf: - $ref: '#/components/schemas/NodeExporterInfo' - xml: name: nodeExporter description: "\n

Indicates whether you want to turn on or turn off the Node Exporter.

" description: "\n

Prometheus settings.

" __integerMin1Max15: type: integer minimum: 1 maximum: 15 JmxExporter: type: object required: - EnabledInBroker properties: EnabledInBroker: allOf: - $ref: '#/components/schemas/__boolean' - xml: name: enabledInBroker description: "\n

Indicates whether you want to turn on or turn off the JMX Exporter.

" description: "\n

Indicates whether you want to turn on or turn off the JMX Exporter.

" CreateClusterResponse: type: object properties: ClusterArn: allOf: - $ref: '#/components/schemas/__string' - xml: name: clusterArn description: "\n

The Amazon Resource Name (ARN) of the cluster.

" ClusterName: allOf: - $ref: '#/components/schemas/__string' - xml: name: clusterName description: "\n

The name of the MSK cluster.

" State: allOf: - $ref: '#/components/schemas/ClusterState' - xml: name: state description: "\n

The state of the cluster. The possible states are ACTIVE, CREATING, DELETING, FAILED, HEALING, MAINTENANCE, REBOOTING_BROKER, and UPDATING.

" ConflictException: {} UnauthorizedException: {} __integerMin1Max16384: type: integer minimum: 1 maximum: 16384 BadRequestException: {} __timestampIso8601: type: string format: date-time __listOfVpcConfig: type: array items: $ref: '#/components/schemas/VpcConfig' ClusterType: type: string enum: - PROVISIONED - SERVERLESS description: "\n

The type of cluster.

" VpcConfig: type: object required: - SubnetIds properties: SubnetIds: allOf: - $ref: '#/components/schemas/__listOf__string' - xml: name: subnetIds description: "\n

The IDs of the subnets associated with the cluster.

" SecurityGroupIds: allOf: - $ref: '#/components/schemas/__listOf__string' - xml: name: securityGroupIds description: "\n

The IDs of the security groups associated with the cluster.

" description: "\n

The configuration of the Amazon VPCs for the cluster.

" NodeExporterInfo: type: object required: - EnabledInBroker properties: EnabledInBroker: allOf: - $ref: '#/components/schemas/__boolean' - xml: name: enabledInBroker description: "\n

Indicates whether you want to turn on or turn off the Node Exporter.

" description: "\n

Indicates whether you want to turn on or turn off the Node Exporter.

" ClusterOperationStep: type: object properties: StepInfo: allOf: - $ref: '#/components/schemas/ClusterOperationStepInfo' - xml: name: stepInfo description: "\n

Information about the step and its status.

" StepName: allOf: - $ref: '#/components/schemas/__string' - xml: name: stepName description: "\n

The name of the step.

" description: "\n

Step taken during a cluster operation.

" Firehose: type: object required: - Enabled properties: DeliveryStream: allOf: - $ref: '#/components/schemas/__string' - xml: name: deliveryStream Enabled: allOf: - $ref: '#/components/schemas/__boolean' - xml: name: enabled BrokerAZDistribution: type: string enum: - DEFAULT description: "\n

The distribution of broker nodes across Availability Zones. This is an optional parameter. If you don't specify it, Amazon MSK gives it the value DEFAULT. You can also explicitly set this parameter to the value DEFAULT. No other values are currently allowed.

\n

Amazon MSK distributes the broker nodes evenly across the Availability Zones that correspond to the subnets you provide when you create the cluster.

" RebootBrokerResponse: type: object properties: ClusterArn: allOf: - $ref: '#/components/schemas/__string' - xml: name: clusterArn description: "\n

The Amazon Resource Name (ARN) of the cluster.

" ClusterOperationArn: allOf: - $ref: '#/components/schemas/__string' - xml: name: clusterOperationArn description: "\n

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

" Iam: type: object properties: Enabled: allOf: - $ref: '#/components/schemas/__boolean' - xml: name: enabled description: "\n

Indicates whether IAM access control is enabled.

" description: "\n

Details for IAM access control.

" __stringMin5Max32: type: string minLength: 5 maxLength: 32 ListClusterOperationsResponse: type: object properties: ClusterOperationInfoList: allOf: - $ref: '#/components/schemas/__listOfClusterOperationInfo' - xml: name: clusterOperationInfoList description: "\n

An array of cluster operation information objects.

" NextToken: allOf: - $ref: '#/components/schemas/__string' - xml: name: nextToken description: "\n

If the response of ListClusterOperations is truncated, it returns a NextToken in the response. This Nexttoken should be sent in the subsequent request to ListClusterOperations.

" UnprocessedScramSecret: type: object properties: ErrorCode: allOf: - $ref: '#/components/schemas/__string' - xml: name: errorCode description: "\n

Error code for associate/disassociate failure.

" ErrorMessage: allOf: - $ref: '#/components/schemas/__string' - xml: name: errorMessage description: "\n

Error message for associate/disassociate failure.

" SecretArn: allOf: - $ref: '#/components/schemas/__string' - xml: name: secretArn description: "\n

AWS Secrets Manager secret ARN.

" description: "\n

Error info for scram secret associate/disassociate failure.

" __listOfUnprocessedScramSecret: type: array items: $ref: '#/components/schemas/UnprocessedScramSecret' ListNodesResponse: type: object properties: NextToken: allOf: - $ref: '#/components/schemas/__string' - xml: name: nextToken description: "\n

The paginated results marker. When the result of a ListNodes operation is truncated, the call returns NextToken in the response. \n To get another batch of nodes, provide this token in your next request.

" NodeInfoList: allOf: - $ref: '#/components/schemas/__listOfNodeInfo' - xml: name: nodeInfoList description: "\n

List containing a NodeInfo object.

" ErrorInfo: type: object properties: ErrorCode: allOf: - $ref: '#/components/schemas/__string' - xml: name: errorCode description: "\n

A number describing the error programmatically.

" ErrorString: allOf: - $ref: '#/components/schemas/__string' - xml: name: errorString description: "\n

An optional field to provide more details about the error.

" description: "\n

Returns information about an error state of the cluster.

" EncryptionAtRest: type: object required: - DataVolumeKMSKeyId properties: DataVolumeKMSKeyId: allOf: - $ref: '#/components/schemas/__string' - xml: name: dataVolumeKMSKeyId description: "\n

The ARN of the AWS KMS key for encrypting data at rest. If you don't specify a KMS key, MSK creates one for you and uses it.

" description: "\n

The data-volume encryption details.

" S3: type: object required: - Enabled properties: Bucket: allOf: - $ref: '#/components/schemas/__string' - xml: name: bucket Enabled: allOf: - $ref: '#/components/schemas/__boolean' - xml: name: enabled Prefix: allOf: - $ref: '#/components/schemas/__string' - xml: name: prefix ClusterInfo: type: object properties: ActiveOperationArn: allOf: - $ref: '#/components/schemas/__string' - xml: name: activeOperationArn description: "\n

Arn of active cluster operation.

" BrokerNodeGroupInfo: allOf: - $ref: '#/components/schemas/BrokerNodeGroupInfo' - xml: name: brokerNodeGroupInfo description: "\n

Information about the broker nodes.

" ClientAuthentication: allOf: - $ref: '#/components/schemas/ClientAuthentication' - xml: name: clientAuthentication description: "\n

Includes all client authentication information.

" ClusterArn: allOf: - $ref: '#/components/schemas/__string' - xml: name: clusterArn description: "\n

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

" ClusterName: allOf: - $ref: '#/components/schemas/__string' - xml: name: clusterName description: "\n

The name of the cluster.

" CreationTime: allOf: - $ref: '#/components/schemas/__timestampIso8601' - xml: name: creationTime description: "\n

The time when the cluster was created.

" CurrentBrokerSoftwareInfo: allOf: - $ref: '#/components/schemas/BrokerSoftwareInfo' - xml: name: currentBrokerSoftwareInfo description: "\n

Information about the version of software currently deployed on the Apache Kafka brokers in the cluster.

" CurrentVersion: allOf: - $ref: '#/components/schemas/__string' - xml: name: currentVersion description: "\n

The current version of the MSK cluster.

" EncryptionInfo: allOf: - $ref: '#/components/schemas/EncryptionInfo' - xml: name: encryptionInfo description: "\n

Includes all encryption-related information.

" EnhancedMonitoring: allOf: - $ref: '#/components/schemas/EnhancedMonitoring' - xml: name: enhancedMonitoring description: "\n

Specifies which metrics are gathered for the MSK cluster. This property has the following possible values: DEFAULT, PER_BROKER, PER_TOPIC_PER_BROKER, and PER_TOPIC_PER_PARTITION. For a list of the metrics associated with each of these levels of monitoring, see Monitoring.

" OpenMonitoring: allOf: - $ref: '#/components/schemas/OpenMonitoring' - xml: name: openMonitoring description: "\n

Settings for open monitoring using Prometheus.

" LoggingInfo: allOf: - $ref: '#/components/schemas/LoggingInfo' - xml: name: loggingInfo NumberOfBrokerNodes: allOf: - $ref: '#/components/schemas/__integer' - xml: name: numberOfBrokerNodes description: "\n

The number of broker nodes in the cluster.

" State: allOf: - $ref: '#/components/schemas/ClusterState' - xml: name: state description: "\n

The state of the cluster. The possible states are ACTIVE, CREATING, DELETING, FAILED, HEALING, MAINTENANCE, REBOOTING_BROKER, and UPDATING.

" StateInfo: allOf: - $ref: '#/components/schemas/StateInfo' - xml: name: stateInfo Tags: allOf: - $ref: '#/components/schemas/__mapOf__string' - xml: name: tags description: "\n

Tags attached to the cluster.

" ZookeeperConnectString: allOf: - $ref: '#/components/schemas/__string' - xml: name: zookeeperConnectString description: "\n

The connection string to use to connect to the Apache ZooKeeper cluster.

" ZookeeperConnectStringTls: allOf: - $ref: '#/components/schemas/__string' - xml: name: zookeeperConnectStringTls description: "\n

The connection string to use to connect to zookeeper cluster on Tls port.

" StorageMode: allOf: - $ref: '#/components/schemas/StorageMode' - xml: name: storageMode description: "\n

This controls storage mode for supported storage tiers.

" description: "\n

Returns information about a cluster.

" __long: type: integer UpdateClusterKafkaVersionResponse: type: object properties: ClusterArn: allOf: - $ref: '#/components/schemas/__string' - xml: name: clusterArn description: "\n

The Amazon Resource Name (ARN) of the cluster.

" ClusterOperationArn: allOf: - $ref: '#/components/schemas/__string' - xml: name: clusterOperationArn description: "\n

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

" Unauthenticated: type: object properties: Enabled: allOf: - $ref: '#/components/schemas/__boolean' - xml: name: enabled description: "\n

Specifies whether you want to turn on or turn off unauthenticated traffic to your cluster.

" DescribeClusterResponse: type: object properties: ClusterInfo: allOf: - $ref: '#/components/schemas/ClusterInfo' - xml: name: clusterInfo description: "\n

The cluster information.

" BrokerLogs: type: object properties: CloudWatchLogs: allOf: - $ref: '#/components/schemas/CloudWatchLogs' - xml: name: cloudWatchLogs Firehose: allOf: - $ref: '#/components/schemas/Firehose' - xml: name: firehose S3: allOf: - $ref: '#/components/schemas/S3' - xml: name: s3 UpdateBrokerStorageResponse: type: object properties: ClusterArn: allOf: - $ref: '#/components/schemas/__string' - xml: name: clusterArn description: "\n

The Amazon Resource Name (ARN) of the cluster.

" ClusterOperationArn: allOf: - $ref: '#/components/schemas/__string' - xml: name: clusterOperationArn description: "\n

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

" ClusterOperationStepInfo: type: object properties: StepStatus: allOf: - $ref: '#/components/schemas/__string' - xml: name: stepStatus description: "\n

The steps current status.

" description: "\n

State information about the operation step.

" UpdateBrokerCountResponse: type: object properties: ClusterArn: allOf: - $ref: '#/components/schemas/__string' - xml: name: clusterArn description: "\n

The Amazon Resource Name (ARN) of the cluster.

" ClusterOperationArn: allOf: - $ref: '#/components/schemas/__string' - xml: name: clusterOperationArn description: "\n

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

" StorageMode: type: string enum: - LOCAL - TIERED description: Controls storage mode for various supported storage tiers. ClusterOperationInfo: type: object properties: ClientRequestId: allOf: - $ref: '#/components/schemas/__string' - xml: name: clientRequestId description: "\n

The ID of the API request that triggered this operation.

" ClusterArn: allOf: - $ref: '#/components/schemas/__string' - xml: name: clusterArn description: "\n

ARN of the cluster.

" CreationTime: allOf: - $ref: '#/components/schemas/__timestampIso8601' - xml: name: creationTime description: "\n

The time that the operation was created.

" EndTime: allOf: - $ref: '#/components/schemas/__timestampIso8601' - xml: name: endTime description: "\n

The time at which the operation finished.

" ErrorInfo: allOf: - $ref: '#/components/schemas/ErrorInfo' - xml: name: errorInfo description: "\n

Describes the error if the operation fails.

" OperationArn: allOf: - $ref: '#/components/schemas/__string' - xml: name: operationArn description: "\n

ARN of the cluster operation.

" OperationState: allOf: - $ref: '#/components/schemas/__string' - xml: name: operationState description: "\n

State of the cluster operation.

" OperationSteps: allOf: - $ref: '#/components/schemas/__listOfClusterOperationStep' - xml: name: operationSteps description: "\n

Steps completed during the operation.

" OperationType: allOf: - $ref: '#/components/schemas/__string' - xml: name: operationType description: "\n

Type of the cluster operation.

" SourceClusterInfo: allOf: - $ref: '#/components/schemas/MutableClusterInfo' - xml: name: sourceClusterInfo description: "\n

Information about cluster attributes before a cluster is updated.

" TargetClusterInfo: allOf: - $ref: '#/components/schemas/MutableClusterInfo' - xml: name: targetClusterInfo description: "\n

Information about cluster attributes after a cluster is updated.

" description: "\n

Returns information about a cluster operation.

" ForbiddenException: {} MutableClusterInfo: type: object properties: BrokerEBSVolumeInfo: allOf: - $ref: '#/components/schemas/__listOfBrokerEBSVolumeInfo' - xml: name: brokerEBSVolumeInfo description: "\n

Specifies the size of the EBS volume and the ID of the associated broker.

" ConfigurationInfo: allOf: - $ref: '#/components/schemas/ConfigurationInfo' - xml: name: configurationInfo description: "\n

Information about the changes in the configuration of the brokers.

" NumberOfBrokerNodes: allOf: - $ref: '#/components/schemas/__integer' - xml: name: numberOfBrokerNodes description: "\n

The number of broker nodes in the cluster.

" EnhancedMonitoring: allOf: - $ref: '#/components/schemas/EnhancedMonitoring' - xml: name: enhancedMonitoring description: "\n

Specifies which Apache Kafka metrics Amazon MSK gathers and sends to Amazon CloudWatch for this cluster.

" OpenMonitoring: allOf: - $ref: '#/components/schemas/OpenMonitoring' - xml: name: openMonitoring description: "\n

The settings for open monitoring.

" KafkaVersion: allOf: - $ref: '#/components/schemas/__string' - xml: name: kafkaVersion description: "\n

The Apache Kafka version.

" LoggingInfo: allOf: - $ref: '#/components/schemas/LoggingInfo' - xml: name: loggingInfo description: "\n

You can configure your MSK cluster to send broker logs to different destination types. This is a container for the configuration details related to broker logs.

" InstanceType: allOf: - $ref: '#/components/schemas/__stringMin5Max32' - xml: name: instanceType description: "\n

Information about the Amazon MSK broker type.

" ClientAuthentication: allOf: - $ref: '#/components/schemas/ClientAuthentication' - xml: name: clientAuthentication description: "\n

Includes all client authentication information.

" EncryptionInfo: allOf: - $ref: '#/components/schemas/EncryptionInfo' - xml: name: encryptionInfo description: "\n

Includes all encryption-related information.

" ConnectivityInfo: allOf: - $ref: '#/components/schemas/ConnectivityInfo' - xml: name: connectivityInfo description: "\n

Information about the broker access configuration.

" StorageMode: allOf: - $ref: '#/components/schemas/StorageMode' - xml: name: storageMode description: "\n

This controls storage mode for supported storage tiers.

" description: "\n

Information about cluster attributes that can be updated via update APIs.

" ClientAuthentication: type: object properties: Sasl: allOf: - $ref: '#/components/schemas/Sasl' - xml: name: sasl description: "\n

Details for ClientAuthentication using SASL.

" Tls: allOf: - $ref: '#/components/schemas/Tls' - xml: name: tls description: "\n

Details for ClientAuthentication using TLS.

" Unauthenticated: allOf: - $ref: '#/components/schemas/Unauthenticated' - xml: name: unauthenticated description: "\n

Contains information about unauthenticated traffic to the cluster.

" description: "\n

Includes all client authentication information.

" GetBootstrapBrokersResponse: type: object properties: BootstrapBrokerString: allOf: - $ref: '#/components/schemas/__string' - xml: name: bootstrapBrokerString description: "\n

A string containing one or more hostname:port pairs.

" BootstrapBrokerStringTls: allOf: - $ref: '#/components/schemas/__string' - xml: name: bootstrapBrokerStringTls description: "\n

A string containing one or more DNS names (or IP) and TLS port pairs.

" BootstrapBrokerStringSaslScram: allOf: - $ref: '#/components/schemas/__string' - xml: name: bootstrapBrokerStringSaslScram description: "\n

A string containing one or more DNS names (or IP) and Sasl Scram port pairs.

" BootstrapBrokerStringSaslIam: allOf: - $ref: '#/components/schemas/__string' - xml: name: bootstrapBrokerStringSaslIam description: "\n

A string that contains one or more DNS names (or IP addresses) and SASL IAM port pairs.

" BootstrapBrokerStringPublicTls: allOf: - $ref: '#/components/schemas/__string' - xml: name: bootstrapBrokerStringPublicTls description: "\n

A string containing one or more DNS names (or IP) and TLS port pairs.

" BootstrapBrokerStringPublicSaslScram: allOf: - $ref: '#/components/schemas/__string' - xml: name: bootstrapBrokerStringPublicSaslScram description: "\n

A string containing one or more DNS names (or IP) and Sasl Scram port pairs.

" BootstrapBrokerStringPublicSaslIam: allOf: - $ref: '#/components/schemas/__string' - xml: name: bootstrapBrokerStringPublicSaslIam description: "\n

A string that contains one or more DNS names (or IP addresses) and SASL IAM port pairs.

" __string: type: string BrokerEBSVolumeInfo: type: object required: - KafkaBrokerNodeId properties: KafkaBrokerNodeId: allOf: - $ref: '#/components/schemas/__string' - xml: name: kafkaBrokerNodeId description: "\n

The ID of the broker to update.

" ProvisionedThroughput: allOf: - $ref: '#/components/schemas/ProvisionedThroughput' - xml: name: provisionedThroughput description: "\n

EBS volume provisioned throughput information.

" VolumeSizeGB: allOf: - $ref: '#/components/schemas/__integer' - xml: name: volumeSizeGB description: "\n

Size of the EBS volume to update.

" description: "\n

Specifies the EBS volume upgrade information. The broker identifier must be set to the keyword ALL. This means the changes apply to all the brokers in the cluster.

" __double: type: number format: double Prometheus: type: object properties: JmxExporter: allOf: - $ref: '#/components/schemas/JmxExporter' - xml: name: jmxExporter description: "\n

Indicates whether you want to turn on or turn off the JMX Exporter.

" NodeExporter: allOf: - $ref: '#/components/schemas/NodeExporter' - xml: name: nodeExporter description: "\n

Indicates whether you want to turn on or turn off the Node Exporter.

" description: "\n

Prometheus settings.

" UpdateStorageResponse: type: object properties: ClusterArn: allOf: - $ref: '#/components/schemas/__string' - xml: name: clusterArn description: "\n

The Amazon Resource Name (ARN) of the cluster.

" ClusterOperationArn: allOf: - $ref: '#/components/schemas/__string' - xml: name: clusterOperationArn description: "\n

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

" __integer: type: integer OpenMonitoring: type: object required: - Prometheus properties: Prometheus: allOf: - $ref: '#/components/schemas/Prometheus' - xml: name: prometheus description: "\n

Prometheus settings.

" description: "\n

JMX and Node monitoring for the MSK cluster.

" ClientBroker: type: string enum: - TLS - TLS_PLAINTEXT - PLAINTEXT description: "\n

Client-broker encryption in transit setting.

" NodeExporter: type: object required: - EnabledInBroker properties: EnabledInBroker: allOf: - $ref: '#/components/schemas/__boolean' - xml: name: enabledInBroker description: "\n

Indicates whether you want to turn on or turn off the Node Exporter.

" description: "\n

Indicates whether you want to turn on or turn off the Node Exporter.

" Sasl: type: object properties: Scram: allOf: - $ref: '#/components/schemas/Scram' - xml: name: scram description: "\n

Details for SASL/SCRAM client authentication.

" Iam: allOf: - $ref: '#/components/schemas/Iam' - xml: name: iam description: "\n

Indicates whether IAM access control is enabled.

" description: "\n

Details for client authentication using SASL.

" Cluster: type: object properties: ActiveOperationArn: allOf: - $ref: '#/components/schemas/__string' - xml: name: activeOperationArn description: "\n

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

" ClusterType: allOf: - $ref: '#/components/schemas/ClusterType' - xml: name: clusterType description: "\n

Cluster Type.

" ClusterArn: allOf: - $ref: '#/components/schemas/__string' - xml: name: clusterArn description: "\n

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

" ClusterName: allOf: - $ref: '#/components/schemas/__string' - xml: name: clusterName description: "\n

The name of the cluster.

" CreationTime: allOf: - $ref: '#/components/schemas/__timestampIso8601' - xml: name: creationTime description: "\n

The time when the cluster was created.

" CurrentVersion: allOf: - $ref: '#/components/schemas/__string' - xml: name: currentVersion description: "\n

The current version of the MSK cluster.

" State: allOf: - $ref: '#/components/schemas/ClusterState' - xml: name: state description: "\n

The state of the cluster. The possible states are ACTIVE, CREATING, DELETING, FAILED, HEALING, MAINTENANCE, REBOOTING_BROKER, and UPDATING.

" StateInfo: allOf: - $ref: '#/components/schemas/StateInfo' - xml: name: stateInfo description: "\n

State Info for the Amazon MSK cluster.

" Tags: allOf: - $ref: '#/components/schemas/__mapOf__string' - xml: name: tags description: "\n

Tags attached to the cluster.

" Provisioned: allOf: - $ref: '#/components/schemas/Provisioned' - xml: name: provisioned description: "\n

Information about the provisioned cluster.

" Serverless: allOf: - $ref: '#/components/schemas/Serverless' - xml: name: serverless description: "\n

Information about the serverless cluster.

" description: "\n

Returns information about a cluster.

" NodeInfo: type: object properties: AddedToClusterTime: allOf: - $ref: '#/components/schemas/__string' - xml: name: addedToClusterTime description: "\n

The start time.

" BrokerNodeInfo: allOf: - $ref: '#/components/schemas/BrokerNodeInfo' - xml: name: brokerNodeInfo description: "\n

The broker node info.

" InstanceType: allOf: - $ref: '#/components/schemas/__string' - xml: name: instanceType description: "\n

The instance type.

" NodeARN: allOf: - $ref: '#/components/schemas/__string' - xml: name: nodeARN description: "\n

The Amazon Resource Name (ARN) of the node.

" NodeType: allOf: - $ref: '#/components/schemas/NodeType' - xml: name: nodeType description: "\n

The node type.

" ZookeeperNodeInfo: allOf: - $ref: '#/components/schemas/ZookeeperNodeInfo' - xml: name: zookeeperNodeInfo description: "\n

The ZookeeperNodeInfo.

" description: "\n

The node information object.

" __listOfClusterOperationStep: type: array items: $ref: '#/components/schemas/ClusterOperationStep' UpdateClusterConfigurationResponse: type: object properties: ClusterArn: allOf: - $ref: '#/components/schemas/__string' - xml: name: clusterArn description: "\n

The Amazon Resource Name (ARN) of the cluster.

" ClusterOperationArn: allOf: - $ref: '#/components/schemas/__string' - xml: name: clusterOperationArn description: "\n

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

" ZookeeperNodeInfo: type: object properties: AttachedENIId: allOf: - $ref: '#/components/schemas/__string' - xml: name: attachedENIId description: "\n

The attached elastic network interface of the broker.

" ClientVpcIpAddress: allOf: - $ref: '#/components/schemas/__string' - xml: name: clientVpcIpAddress description: "\n

The virtual private cloud (VPC) IP address of the client.

" Endpoints: allOf: - $ref: '#/components/schemas/__listOf__string' - xml: name: endpoints description: "\n

Endpoints for accessing the ZooKeeper.

" ZookeeperId: allOf: - $ref: '#/components/schemas/__double' - xml: name: zookeeperId description: "\n

The role-specific ID for Zookeeper.

" ZookeeperVersion: allOf: - $ref: '#/components/schemas/__string' - xml: name: zookeeperVersion description: "\n

The version of Zookeeper.

" description: "\n

Zookeeper node information.

" EBSStorageInfo: type: object properties: ProvisionedThroughput: allOf: - $ref: '#/components/schemas/ProvisionedThroughput' - xml: name: provisionedThroughput description: "\n

EBS volume provisioned throughput information.

" VolumeSize: allOf: - $ref: '#/components/schemas/__integerMin1Max16384' - xml: name: volumeSize description: "\n

The size in GiB of the EBS volume for the data drive on each broker node.

" description: "\n

Contains information about the EBS storage volumes attached to Apache Kafka broker nodes.

" __listOfNodeInfo: type: array items: $ref: '#/components/schemas/NodeInfo' BrokerSoftwareInfo: type: object properties: ConfigurationArn: allOf: - $ref: '#/components/schemas/__string' - xml: name: configurationArn description: "\n

The Amazon Resource Name (ARN) of the configuration used for the cluster. This field isn't visible in this preview release.

" ConfigurationRevision: allOf: - $ref: '#/components/schemas/__long' - xml: name: configurationRevision description: "\n

The revision of the configuration to use. This field isn't visible in this preview release.

" KafkaVersion: allOf: - $ref: '#/components/schemas/__string' - xml: name: kafkaVersion description: "\n

The version of Apache Kafka.

" description: "\n

Information about the current software installed on the cluster.

" __listOfCluster: type: array items: $ref: '#/components/schemas/Cluster' ConnectivityInfo: type: object properties: PublicAccess: allOf: - $ref: '#/components/schemas/PublicAccess' - xml: name: publicAccess description: "\n

Public access control for brokers.

" description: "\n

Information about the broker access configuration.

" DeleteClusterResponse: type: object properties: ClusterArn: allOf: - $ref: '#/components/schemas/__string' - xml: name: clusterArn description: "\n

The Amazon Resource Name (ARN) of the cluster.

" State: allOf: - $ref: '#/components/schemas/ClusterState' - xml: name: state description: "\n

The state of the cluster. The possible states are ACTIVE, CREATING, DELETING, FAILED, HEALING, MAINTENANCE, REBOOTING_BROKER, and UPDATING.

" TooManyRequestsException: {} EnhancedMonitoring: type: string enum: - DEFAULT - PER_BROKER - PER_TOPIC_PER_BROKER - PER_TOPIC_PER_PARTITION description: "\n

Specifies which metrics are gathered for the MSK cluster. This property has the following possible values: DEFAULT, PER_BROKER, PER_TOPIC_PER_BROKER, and PER_TOPIC_PER_PARTITION. For a list of the metrics associated with each of these levels of monitoring, see Monitoring.

" __listOfBrokerEBSVolumeInfo: type: array items: $ref: '#/components/schemas/BrokerEBSVolumeInfo' ListClustersV2Response: type: object properties: ClusterInfoList: allOf: - $ref: '#/components/schemas/__listOfCluster' - xml: name: clusterInfoList description: "\n

Information on each of the MSK clusters in the response.

" NextToken: allOf: - $ref: '#/components/schemas/__string' - xml: name: nextToken description: "\n

The paginated results marker. When the result of a ListClusters operation is truncated, the call returns NextToken in the response. \n To get another batch of clusters, provide this token in your next request.

" ListClustersResponse: type: object properties: ClusterInfoList: allOf: - $ref: '#/components/schemas/__listOfClusterInfo' - xml: name: clusterInfoList description: "\n

Information on each of the MSK clusters in the response.

" NextToken: allOf: - $ref: '#/components/schemas/__string' - xml: name: nextToken description: "\n

The paginated results marker. When the result of a ListClusters operation is truncated, the call returns NextToken in the response. \n To get another batch of clusters, provide this token in your next request.

" ServerlessSasl: type: object properties: Iam: allOf: - $ref: '#/components/schemas/Iam' - xml: name: iam description: "\n

Indicates whether IAM access control is enabled.

" description: "\n

Details for client authentication using SASL.

" UpdateSecurityResponse: type: object properties: ClusterArn: allOf: - $ref: '#/components/schemas/__string' - xml: name: clusterArn description: "\n

The Amazon Resource Name (ARN) of the cluster.

" ClusterOperationArn: allOf: - $ref: '#/components/schemas/__string' - xml: name: clusterOperationArn description: "\n

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

" __listOf__string: type: array items: $ref: '#/components/schemas/__string' __mapOf__string: type: object additionalProperties: $ref: '#/components/schemas/__string' EncryptionInfo: type: object properties: EncryptionAtRest: allOf: - $ref: '#/components/schemas/EncryptionAtRest' - xml: name: encryptionAtRest description: "\n

The data-volume encryption details.

" EncryptionInTransit: allOf: - $ref: '#/components/schemas/EncryptionInTransit' - xml: name: encryptionInTransit description: "\n

The details for encryption in transit.

" description: "\n

Includes encryption-related information, such as the AWS KMS key used for encrypting data at rest and whether you want MSK to encrypt your data in transit.

" Provisioned: type: object required: - BrokerNodeGroupInfo - NumberOfBrokerNodes properties: BrokerNodeGroupInfo: allOf: - $ref: '#/components/schemas/BrokerNodeGroupInfo' - xml: name: brokerNodeGroupInfo description: "\n

Information about the brokers.

" CurrentBrokerSoftwareInfo: allOf: - $ref: '#/components/schemas/BrokerSoftwareInfo' - xml: name: currentBrokerSoftwareInfo description: "\n

Information about the Apache Kafka version deployed on the brokers.

" ClientAuthentication: allOf: - $ref: '#/components/schemas/ClientAuthentication' - xml: name: clientAuthentication description: "\n

Includes all client authentication information.

" EncryptionInfo: allOf: - $ref: '#/components/schemas/EncryptionInfo' - xml: name: encryptionInfo description: "\n

Includes all encryption-related information.

" EnhancedMonitoring: allOf: - $ref: '#/components/schemas/EnhancedMonitoring' - xml: name: enhancedMonitoring description: "\n

Specifies the level of monitoring for the MSK cluster. The possible values are DEFAULT, PER_BROKER, PER_TOPIC_PER_BROKER, and PER_TOPIC_PER_PARTITION.

" OpenMonitoring: allOf: - $ref: '#/components/schemas/OpenMonitoringInfo' - xml: name: openMonitoring description: "\n

The settings for open monitoring.

" LoggingInfo: allOf: - $ref: '#/components/schemas/LoggingInfo' - xml: name: loggingInfo description: "\n

Log delivery information for the cluster.

" NumberOfBrokerNodes: allOf: - $ref: '#/components/schemas/__integerMin1Max15' - xml: name: numberOfBrokerNodes description: "\n

The number of broker nodes in the cluster.

" ZookeeperConnectString: allOf: - $ref: '#/components/schemas/__string' - xml: name: zookeeperConnectString description: "\n

The connection string to use to connect to the Apache ZooKeeper cluster.

" ZookeeperConnectStringTls: allOf: - $ref: '#/components/schemas/__string' - xml: name: zookeeperConnectStringTls description: "\n

The connection string to use to connect to the Apache ZooKeeper cluster on a TLS port.

" StorageMode: allOf: - $ref: '#/components/schemas/StorageMode' - xml: name: storageMode description: "\n

This controls storage mode for supported storage tiers.

" description: "\n

Provisioned cluster.

" __stringMin1Max128: type: string minLength: 1 maxLength: 128 BatchAssociateScramSecretResponse: type: object properties: ClusterArn: allOf: - $ref: '#/components/schemas/__string' - xml: name: clusterArn description: "\n

The Amazon Resource Name (ARN) of the cluster.

" UnprocessedScramSecrets: allOf: - $ref: '#/components/schemas/__listOfUnprocessedScramSecret' - xml: name: unprocessedScramSecrets description: "\n

List of errors when associating secrets to cluster.

" UpdateBrokerTypeResponse: type: object properties: ClusterArn: allOf: - $ref: '#/components/schemas/__string' - xml: name: clusterArn description: "\n

The Amazon Resource Name (ARN) of the cluster.

" ClusterOperationArn: allOf: - $ref: '#/components/schemas/__string' - xml: name: clusterOperationArn description: "\n

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

" Scram: type: object properties: Enabled: allOf: - $ref: '#/components/schemas/__boolean' - xml: name: enabled description: "\n

SASL/SCRAM authentication is enabled or not.

" description: "\n

Details for SASL/SCRAM client authentication.

" StateInfo: type: object properties: Code: allOf: - $ref: '#/components/schemas/__string' - xml: name: code Message: allOf: - $ref: '#/components/schemas/__string' - xml: name: message OpenMonitoringInfo: type: object required: - Prometheus properties: Prometheus: allOf: - $ref: '#/components/schemas/PrometheusInfo' - xml: name: prometheus description: "\n

Prometheus settings.

" description: "\n

JMX and Node monitoring for the MSK cluster.

" __listOfClusterOperationInfo: type: array items: $ref: '#/components/schemas/ClusterOperationInfo' UpdateMonitoringResponse: type: object properties: ClusterArn: allOf: - $ref: '#/components/schemas/__string' - xml: name: clusterArn description: "\n

The Amazon Resource Name (ARN) of the cluster.

" ClusterOperationArn: allOf: - $ref: '#/components/schemas/__string' - xml: name: clusterOperationArn description: "\n

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

" ClusterState: type: string enum: - ACTIVE - CREATING - DELETING - FAILED - HEALING - MAINTENANCE - REBOOTING_BROKER - UPDATING description: "\n

The state of the Apache Kafka cluster.

" BrokerNodeInfo: type: object properties: AttachedENIId: allOf: - $ref: '#/components/schemas/__string' - xml: name: attachedENIId description: "\n

The attached elastic network interface of the broker.

" BrokerId: allOf: - $ref: '#/components/schemas/__double' - xml: name: brokerId description: "\n

The ID of the broker.

" ClientSubnet: allOf: - $ref: '#/components/schemas/__string' - xml: name: clientSubnet description: "\n

The client subnet to which this broker node belongs.

" ClientVpcIpAddress: allOf: - $ref: '#/components/schemas/__string' - xml: name: clientVpcIpAddress description: "\n

The virtual private cloud (VPC) of the client.

" CurrentBrokerSoftwareInfo: allOf: - $ref: '#/components/schemas/BrokerSoftwareInfo' - xml: name: currentBrokerSoftwareInfo description: "\n

Information about the version of software currently deployed on the Apache Kafka brokers in the cluster.

" Endpoints: allOf: - $ref: '#/components/schemas/__listOf__string' - xml: name: endpoints description: "\n

Endpoints for accessing the broker.

" description: "\n

BrokerNodeInfo

" EncryptionInTransit: type: object properties: ClientBroker: allOf: - $ref: '#/components/schemas/ClientBroker' - xml: name: clientBroker description: "\n

Indicates the encryption setting for data in transit between clients and brokers. The following are the possible values.

\n

\n TLS means that client-broker communication is enabled with TLS only.

\n

\n TLS_PLAINTEXT means that client-broker communication is enabled for both TLS-encrypted, as well as plaintext data.

\n

\n PLAINTEXT means that client-broker communication is enabled in plaintext only.

\n

The default value is TLS_PLAINTEXT.

" InCluster: allOf: - $ref: '#/components/schemas/__boolean' - xml: name: inCluster description: "\n

When set to true, it indicates that data communication among the broker nodes of the cluster is encrypted. When set to false, the communication happens in plaintext.

\n

The default value is true.

" description: "\n

The settings for encrypting data in transit.

" __boolean: type: boolean PublicAccess: type: object properties: Type: allOf: - $ref: '#/components/schemas/__string' - xml: name: type description: "\n

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

" description: Public access control for brokers. NotFoundException: {} DescribeClusterV2Response: type: object properties: ClusterInfo: allOf: - $ref: '#/components/schemas/Cluster' - xml: name: clusterInfo description: "\n

The cluster information.

" NodeType: type: string enum: - BROKER description: "\n

The broker or Zookeeper node.

" ServiceUnavailableException: {} LoggingInfo: type: object required: - BrokerLogs properties: BrokerLogs: allOf: - $ref: '#/components/schemas/BrokerLogs' - xml: name: brokerLogs UpdateConnectivityResponse: type: object properties: ClusterArn: allOf: - $ref: '#/components/schemas/__string' - xml: name: clusterArn description: "\n

The Amazon Resource Name (ARN) of the cluster.

" ClusterOperationArn: allOf: - $ref: '#/components/schemas/__string' - xml: name: clusterOperationArn description: "\n

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

" ListScramSecretsResponse: type: object properties: NextToken: allOf: - $ref: '#/components/schemas/__string' - xml: name: nextToken description: "\n

Paginated results marker.

" SecretArnList: allOf: - $ref: '#/components/schemas/__listOf__string' - xml: name: secretArnList description: "\n

The list of scram secrets associated with the cluster.

" parameters: X-Amz-SignedHeaders: name: X-Amz-SignedHeaders in: header schema: type: string required: false X-Amz-Signature: name: X-Amz-Signature in: header schema: type: string required: false X-Amz-Credential: name: X-Amz-Credential in: header schema: type: string required: false X-Amz-Security-Token: name: X-Amz-Security-Token in: header schema: type: string required: false X-Amz-Date: name: X-Amz-Date in: header schema: type: string required: false X-Amz-Content-Sha256: name: X-Amz-Content-Sha256 in: header schema: type: string required: false X-Amz-Algorithm: name: X-Amz-Algorithm in: header schema: type: string required: false securitySchemes: hmac: type: apiKey name: Authorization in: header description: Amazon Signature authorization v4 x-amazon-apigateway-authtype: awsSigv4 externalDocs: description: Amazon Web Services documentation url: https://docs.aws.amazon.com/kafka/ x-hasEquivalentPaths: true