# DBaaS Service Kafka

## Properties

| Property | Type | Required | Description |
| --- | --- | --- | --- |
| `name` | string | **yes** | Service name<br/><br/>Min length: `0`. Max length: `63`. |
| `plan` | string | **yes** | Subscription plan |
| `prometheus-uri` | [Prometheus URI](/reference/api/_schemas/dbaas-service-kafka/#prometheus-uri) | **yes** | Prometheus integration URI |
| `type` | string | **yes** | Service type code<br/><br/>Min length: `0`. Max length: `64`. |
| `authentication-methods` | [Authentication Methods](/reference/api/_schemas/dbaas-service-kafka/#authentication-methods) | no | Kafka authentication methods |
| `backups` | array of [List of backups for the service](/reference/api/_schemas/dbaas-service-backup/) | no | List of backups for the service |
| `components` | array of [Components](/reference/api/_schemas/dbaas-service-kafka/#components) | no | Service component information objects |
| `connection-info` | [Connection Info](/reference/api/_schemas/dbaas-service-kafka/#connection-info) | no | Kafka connection information properties |
| `created-at` | string | no | Service creation timestamp (ISO 8601)<br/><br/>ISO 8601 date-time. |
| `disk-size` | integer | no | TODO UNIT disk space for data storage<br/><br/>Min: `0`. |
| `integrations` | array of [DBaaS Integration](/reference/api/_schemas/dbaas-integration/) | no | Service integrations |
| `ip-filter` | array[string] | no | Allow incoming connections from CIDR address block, e.g. '10.20.0.0/16' |
| `kafka-connect-enabled` | boolean | no | Whether Kafka Connect is enabled |
| `kafka-connect-settings` | [Kafka Connect configuration values](/reference/api/_schemas/json-schema-kafka-connect/) | no | Kafka Connect configuration values |
| `kafka-rest-enabled` | boolean | no | Whether Kafka REST is enabled |
| `kafka-rest-settings` | [Kafka REST configuration](/reference/api/_schemas/json-schema-kafka-rest/) | no | Kafka REST configuration |
| `kafka-settings` | [Kafka broker configuration values](/reference/api/_schemas/json-schema-kafka/) | no | Kafka-specific settings |
| `maintenance` | [Automatic maintenance settings](/reference/api/_schemas/dbaas-service-maintenance/) | no | Automatic maintenance settings |
| `node-count` | integer | no | Number of service nodes in the active plan<br/><br/>Min: `0`. |
| `node-cpu-count` | integer | no | Number of CPUs for each node<br/><br/>Min: `0`. |
| `node-memory` | integer | no | TODO UNIT of memory for each node<br/><br/>Min: `0`. |
| `node-states` | array of [Automatic maintenance settings](/reference/api/_schemas/dbaas-node-state/) | no | State of individual service nodes |
| `notifications` | array of [Service notifications](/reference/api/_schemas/dbaas-service-notification/) | no | Service notifications |
| `schema-registry-enabled` | boolean | no | Whether Schema-Registry is enabled |
| `schema-registry-settings` | [Schema Registry configuration](/reference/api/_schemas/json-schema-schema-registry/) | no | Schema Registry configuration |
| `state` | string | no | State of the service<br/><br/>Allowed values: `running`, `rebuilding`, `rebalancing`, `poweroff`. |
| `termination-protection` | boolean | no | Service is protected against termination and powering off |
| `updated-at` | string | no | Service last update timestamp (ISO 8601)<br/><br/>ISO 8601 date-time. |
| `uri` | string | no | URI for connecting to the service (may be absent) |
| `uri-params` | object | no | service_uri parameterized into key-value pairs |
| `users` | array of [Users](/reference/api/_schemas/dbaas-service-kafka/#users) | no | List of service users |
| `version` | string | no | Kafka version |
| `zone` | string | no | The zone where the service is running |

### Authentication Methods {#authentication-methods}

Kafka authentication methods

| Property | Type | Required | Description |
| --- | --- | --- | --- |
| `certificate` | boolean | no | Whether certificate/SSL authentication is enabled |
| `sasl` | boolean | no | Whether SASL authentication is enabled |

### Connection Info {#connection-info}

Kafka connection information properties

| Property | Type | Required | Description |
| --- | --- | --- | --- |
| `access-cert` | string | no |  |
| `access-key` | string | no |  |
| `connect-uri` | string | no |  |
| `nodes` | array[string] | no |  |
| `registry-uri` | string | no |  |
| `rest-uri` | string | no |  |

### Prometheus URI {#prometheus-uri}

Prometheus integration URI

| Property | Type | Required | Description |
| --- | --- | --- | --- |
| `host` | string | no |  |
| `port` | integer | no | Min: `0`. Max: `65535`. |

### Components {#components}

| Property | Type | Required | Description |
| --- | --- | --- | --- |
| `component` | string | **yes** | Service component name |
| `host` | string | **yes** | DNS name for connecting to the service component |
| `port` | integer | **yes** | Port number for connecting to the service component<br/><br/>Min: `0`. Max: `65535`. |
| `route` | string | **yes** | Network access route<br/><br/>Allowed values: `dynamic`, `private`, `public`, `privatelink`. |
| `usage` | string | **yes** | DNS usage name<br/><br/>Allowed values: `primary`, `replica`. |
| `kafka-authentication-method` | string | no | Kafka authentication method. This is a value specific to the 'kafka' service component<br/><br/>Allowed values: `certificate`, `sasl`. |

### Users {#users}

| Property | Type | Required | Description |
| --- | --- | --- | --- |
| `access-cert` | string | no |  |
| `access-cert-expiry` | string | no | ISO 8601 date-time. |
| `access-key` | string | no |  |
| `password` | string | no |  |
| `type` | string | no |  |
| `username` | string | no |  |