{{#if category}}
// tag::category-{{category}}[]
{{/if}}
{{#if exclude_from_docs}}
// tag::exclude-from-docs[]
{{/if}}
{{#if is_deprecated}}
// tag::deprecated[]
{{/if}}
{{#if is_experimental_property}}
// tag::experimental[]
{{/if}}
{{#if cloud_supported}}
// tag::redpanda-cloud[]
{{/if}}
=== {{name}}
{{#if version}}

ifndef::env-cloud[]
*Introduced in {{version}}*
endif::[]
{{/if}}
{{#if description}}

{{{description}}}
{{else}}

No description available.

{{/if}}
{{#if is_enterprise}}

ifndef::env-cloud[]
.Enterprise license required
[NOTE]
====
{{#if enterprise_constructor}}
{{#if (eq enterprise_constructor "simple")}}
This property requires an Enterprise license to use.
{{else if (eq enterprise_constructor "restricted_only")}}
The following values require an Enterprise license: {{#each enterprise_restricted_value}}`{{this}}`{{#unless @last}}, {{/unless}}{{/each}}
{{else if (eq enterprise_constructor "restricted_with_sanctioned")}}
*License-based defaults:*

* *Community:* {{#each enterprise_sanctioned_value}}`{{this}}`{{#unless @last}}, {{/unless}}{{/each}} (if no Enterprise license is present)
* *Enterprise:* {{#each enterprise_restricted_value}}`{{this}}`{{#unless @last}}, {{/unless}}{{/each}} (if an Enterprise license is present)
{{/if}}
{{else}}
Enterprise license required: `{{enterprise_value}}`
{{/if}}

For license details, see xref:get-started:licensing/index.adoc[Redpanda Licensing].
====
endif::[]
{{/if}}
{{#if cloud_byoc_only}}

ifdef::env-cloud[]
NOTE: This property is available only in Redpanda Cloud BYOC deployments.
endif::[]

{{/if}}

[cols="1s,2a"]
|===
| Property | Value

| Type
| `{{type}}`{{#if (or enum items.enum)}} (enum){{/if}}

{{#if enum}}
| Accepted values
|
ifndef::env-cloud[]
{{#each enum}}`{{this}}`{{#if (isEnterpriseEnum this ../x-enum-metadata)}} (Enterprise){{else}}{{#if ../is_enterprise}}{{#if (includes ../enterprise_restricted_value this)}} (Enterprise){{/if}}{{/if}}{{/if}}{{#unless @last}}, {{/unless}}{{/each}}
endif::[]
ifdef::env-cloud[]
{{#each enum}}`{{this}}`{{#unless @last}}, {{/unless}}{{/each}}
endif::[]
{{else}}{{#if items.enum}}
| Accepted values
|
ifndef::env-cloud[]
{{#each items.enum}}`{{this}}`{{#if (isEnterpriseEnum this ../items.x-enum-metadata)}} (Enterprise){{/if}}{{#unless @last}}, {{/unless}}{{/each}}
endif::[]
ifdef::env-cloud[]
{{#each items.enum}}`{{this}}`{{#unless @last}}, {{/unless}}{{/each}}
endif::[]
{{/if}}{{/if}}
{{#if (and minimum maximum)}}

| Range
| [`{{minimum}}`, `{{maximum}}`]
{{else}}
{{#if minimum}}

| Minimum
| `{{minimum}}`
{{/if}}
{{#if maximum}}

| Maximum
| `{{maximum}}`
{{/if}}
{{/if}}

| Default
|
{{#if is_enterprise}}
ifdef::env-cloud[]
Available in the Redpanda Cloud Console{{#if cloud_readonly}} (read-only){{else if cloud_editable}} (editable){{/if}}
endif::[]
ifndef::env-cloud[]
`{{formatPropertyValue default type}}`{{#if default_human_readable}} ({{default_human_readable}}){{/if}}
endif::[]
{{else}}
ifdef::env-cloud[]
Available in the Redpanda Cloud Console{{#if cloud_readonly}} (read-only){{else if cloud_editable}} (editable){{/if}}
endif::[]
ifndef::env-cloud[]
`{{formatPropertyValue default type}}`{{#if default_human_readable}} ({{default_human_readable}}){{/if}}
endif::[]
{{/if}}

| Nullable
| {{#if nullable}}Yes{{else}}No{{/if}}
{{#if units}}

| Unit
| {{capitalize units}}
{{else}}
{{#if (formatUnits name)}}

| Unit
| {{capitalize (formatUnits name)}}
{{/if}}
{{/if}}
{{#if (ne defined_in "src/v/config/node_config.cc")}}
{{#if (ne needs_restart undefined)}}

| Requires restart
| {{#if needs_restart}}Yes{{else}}No{{/if}}
{{/if}}
{{/if}}

ifndef::env-cloud[]
| Restored on xref:manage:whole-cluster-restore.adoc[Whole Cluster Restore]
| {{#if (ne gets_restored false)}}Yes{{else}}No{{/if}}
endif::[]
{{#if visibility}}

ifndef::env-cloud[]
| Visibility
| {{capitalize visibility}}
endif::[]
{{/if}}
{{#if aliases}}

ifndef::env-cloud[]
| Aliases
| {{#each aliases}}`{{this}}`{{#unless @last}}, {{/unless}}{{/each}}
endif::[]
{{/if}}
{{#if example}}

| Example
|
{{{example}}}
{{/if}}
{{#if related_topics}}
{{#with (allTopicsConditional related_topics) as |sectionType|}}

{{#if (eq sectionType "cloud")}}
ifdef::env-cloud[]
| Related topics
|{{#if (gt (length ../related_topics) 1)}}{{#each ../related_topics}}
{{#with (parseRelatedTopic this)}}
* {{{value}}}
{{/with}}
{{/each}}
{{else}}
{{#each ../related_topics}}
{{#with (parseRelatedTopic this)}}
{{{value}}}
{{/with}}
{{/each}}
{{/if}}
endif::[]
{{else if (eq sectionType "self-managed")}}
ifndef::env-cloud[]
| Related topics
|{{#if (gt (length ../related_topics) 1)}}{{#each ../related_topics}}
{{#with (parseRelatedTopic this)}}
* {{{value}}}
{{/with}}
{{/each}}
{{else}}
{{#each ../related_topics}}
{{#with (parseRelatedTopic this)}}
{{{value}}}
{{/with}}
{{/each}}
{{/if}}
endif::[]
{{else}}
| Related topics
|{{#if (gt (length ../related_topics) 1)}}{{#each ../related_topics}}
{{#with (parseRelatedTopic this)}}
{{#if (eq type "cloud")}}
ifdef::env-cloud[]
* {{{value}}}
endif::[]
{{else if (eq type "self-managed")}}
ifndef::env-cloud[]
* {{{value}}}
endif::[]
{{else}}
* {{{value}}}
{{/if}}
{{/with}}
{{/each}}
{{else}}
{{#each ../related_topics}}
{{#with (parseRelatedTopic this)}}
{{#if (eq type "cloud")}}
ifdef::env-cloud[]
{{{value}}}
endif::[]
{{else if (eq type "self-managed")}}
ifndef::env-cloud[]
{{{value}}}
endif::[]
{{else}}
{{{value}}}
{{/if}}
{{/with}}
{{/each}}
{{/if}}
{{/if}}
{{/with}}
{{/if}}

|===

{{#if is_experimental_property}}
// end::experimental[]
{{/if}}
{{#if cloud_supported}}
// end::redpanda-cloud[]
{{/if}}
{{#if is_deprecated}}
// end::deprecated[]
{{/if}}
{{#if exclude_from_docs}}
// end::exclude-from-docs[]
{{/if}}
{{#if category}}
// end::category-{{category}}[]
{{/if}}