Update es_client_authentication description (elastic#982)

tobio · web-flow · commit 08b9042ec6d0 · 2025-01-14T17:32:43.000+11:00
* Update es_client_auth description

* docs-generate
diff --git a/docs/data-sources/elasticsearch_index_template.md b/docs/data-sources/elasticsearch_index_template.md
@@ -60,7 +60,7 @@ Optional:
 - `cert_data` (String) PEM encoded certificate for client auth
 - `cert_file` (String) Path to a file containing the PEM encoded certificate for client auth
 - `endpoints` (List of String, Sensitive) A list of endpoints where the terraform provider will point to, this must include the http(s) schema and port number.
-- `es_client_authentication` (String, Sensitive) ES Client Authentication field to be used with the bearer token
+- `es_client_authentication` (String, Sensitive) ES Client Authentication field to be used with the JWT token
 - `insecure` (Boolean) Disable TLS certificate validation
 - `key_data` (String, Sensitive) PEM encoded private key for client auth
 - `key_file` (String) Path to a file containing the PEM encoded private key for client auth
diff --git a/docs/data-sources/elasticsearch_security_role.md b/docs/data-sources/elasticsearch_security_role.md
@@ -61,7 +61,7 @@ Optional:
 - `cert_data` (String) PEM encoded certificate for client auth
 - `cert_file` (String) Path to a file containing the PEM encoded certificate for client auth
 - `endpoints` (List of String, Sensitive) A list of endpoints where the terraform provider will point to, this must include the http(s) schema and port number.
-- `es_client_authentication` (String, Sensitive) ES Client Authentication field to be used with the bearer token
+- `es_client_authentication` (String, Sensitive) ES Client Authentication field to be used with the JWT token
 - `insecure` (Boolean) Disable TLS certificate validation
 - `key_data` (String, Sensitive) PEM encoded private key for client auth
 - `key_file` (String) Path to a file containing the PEM encoded private key for client auth
diff --git a/docs/data-sources/elasticsearch_security_role_mapping.md b/docs/data-sources/elasticsearch_security_role_mapping.md
@@ -58,7 +58,7 @@ Optional:
 - `cert_data` (String) PEM encoded certificate for client auth
 - `cert_file` (String) Path to a file containing the PEM encoded certificate for client auth
 - `endpoints` (List of String, Sensitive) A list of endpoints where the terraform provider will point to, this must include the http(s) schema and port number.
-- `es_client_authentication` (String, Sensitive) ES Client Authentication field to be used with the bearer token
+- `es_client_authentication` (String, Sensitive) ES Client Authentication field to be used with the JWT token
 - `insecure` (Boolean) Disable TLS certificate validation
 - `key_data` (String, Sensitive) PEM encoded private key for client auth
 - `key_file` (String) Path to a file containing the PEM encoded private key for client auth
diff --git a/docs/data-sources/elasticsearch_security_user.md b/docs/data-sources/elasticsearch_security_user.md
@@ -58,7 +58,7 @@ Optional:
 - `cert_data` (String) PEM encoded certificate for client auth
 - `cert_file` (String) Path to a file containing the PEM encoded certificate for client auth
 - `endpoints` (List of String, Sensitive) A list of endpoints where the terraform provider will point to, this must include the http(s) schema and port number.
-- `es_client_authentication` (String, Sensitive) ES Client Authentication field to be used with the bearer token
+- `es_client_authentication` (String, Sensitive) ES Client Authentication field to be used with the JWT token
 - `insecure` (Boolean) Disable TLS certificate validation
 - `key_data` (String, Sensitive) PEM encoded private key for client auth
 - `key_file` (String) Path to a file containing the PEM encoded private key for client auth
diff --git a/docs/data-sources/elasticsearch_snapshot_repository.md b/docs/data-sources/elasticsearch_snapshot_repository.md
@@ -86,7 +86,7 @@ Optional:
 - `cert_data` (String) PEM encoded certificate for client auth
 - `cert_file` (String) Path to a file containing the PEM encoded certificate for client auth
 - `endpoints` (List of String, Sensitive) A list of endpoints where the terraform provider will point to, this must include the http(s) schema and port number.
-- `es_client_authentication` (String, Sensitive) ES Client Authentication field to be used with the bearer token
+- `es_client_authentication` (String, Sensitive) ES Client Authentication field to be used with the JWT token
 - `insecure` (Boolean) Disable TLS certificate validation
 - `key_data` (String, Sensitive) PEM encoded private key for client auth
 - `key_file` (String) Path to a file containing the PEM encoded private key for client auth
diff --git a/docs/index.md b/docs/index.md
@@ -158,7 +158,7 @@ Optional:
 - `cert_data` (String) PEM encoded certificate for client auth
 - `cert_file` (String) Path to a file containing the PEM encoded certificate for client auth
 - `endpoints` (List of String, Sensitive) A list of endpoints where the terraform provider will point to, this must include the http(s) schema and port number.
-- `es_client_authentication` (String, Sensitive) ES Client Authentication field to be used with the bearer token
+- `es_client_authentication` (String, Sensitive) ES Client Authentication field to be used with the JWT token
 - `insecure` (Boolean) Disable TLS certificate validation
 - `key_data` (String, Sensitive) PEM encoded private key for client auth
 - `key_file` (String) Path to a file containing the PEM encoded private key for client auth
diff --git a/docs/resources/elasticsearch_cluster_settings.md b/docs/resources/elasticsearch_cluster_settings.md
@@ -71,7 +71,7 @@ Optional:
 - `cert_data` (String) PEM encoded certificate for client auth
 - `cert_file` (String) Path to a file containing the PEM encoded certificate for client auth
 - `endpoints` (List of String, Sensitive) A list of endpoints where the terraform provider will point to, this must include the http(s) schema and port number.
-- `es_client_authentication` (String, Sensitive) ES Client Authentication field to be used with the bearer token
+- `es_client_authentication` (String, Sensitive) ES Client Authentication field to be used with the JWT token
 - `insecure` (Boolean) Disable TLS certificate validation
 - `key_data` (String, Sensitive) PEM encoded private key for client auth
 - `key_file` (String) Path to a file containing the PEM encoded private key for client auth
diff --git a/docs/resources/elasticsearch_component_template.md b/docs/resources/elasticsearch_component_template.md
@@ -96,7 +96,7 @@ Optional:
 - `cert_data` (String) PEM encoded certificate for client auth
 - `cert_file` (String) Path to a file containing the PEM encoded certificate for client auth
 - `endpoints` (List of String, Sensitive) A list of endpoints where the terraform provider will point to, this must include the http(s) schema and port number.
-- `es_client_authentication` (String, Sensitive) ES Client Authentication field to be used with the bearer token
+- `es_client_authentication` (String, Sensitive) ES Client Authentication field to be used with the JWT token
 - `insecure` (Boolean) Disable TLS certificate validation
 - `key_data` (String, Sensitive) PEM encoded private key for client auth
 - `key_file` (String) Path to a file containing the PEM encoded private key for client auth
diff --git a/docs/resources/elasticsearch_data_stream.md b/docs/resources/elasticsearch_data_stream.md
@@ -102,7 +102,7 @@ Optional:
 - `cert_data` (String) PEM encoded certificate for client auth
 - `cert_file` (String) Path to a file containing the PEM encoded certificate for client auth
 - `endpoints` (List of String, Sensitive) A list of endpoints where the terraform provider will point to, this must include the http(s) schema and port number.
-- `es_client_authentication` (String, Sensitive) ES Client Authentication field to be used with the bearer token
+- `es_client_authentication` (String, Sensitive) ES Client Authentication field to be used with the JWT token
 - `insecure` (Boolean) Disable TLS certificate validation
 - `key_data` (String, Sensitive) PEM encoded private key for client auth
 - `key_file` (String) Path to a file containing the PEM encoded private key for client auth
diff --git a/docs/resources/elasticsearch_data_stream_lifecycle.md b/docs/resources/elasticsearch_data_stream_lifecycle.md
@@ -93,7 +93,7 @@ Optional:
 - `cert_data` (String) PEM encoded certificate for client auth
 - `cert_file` (String) Path to a file containing the PEM encoded certificate for client auth
 - `endpoints` (List of String, Sensitive) A list of endpoints where the terraform provider will point to, this must include the http(s) schema and port number.
-- `es_client_authentication` (String, Sensitive) ES Client Authentication field to be used with the bearer token
+- `es_client_authentication` (String, Sensitive) ES Client Authentication field to be used with the JWT token
 - `insecure` (Boolean) Disable TLS certificate validation
 - `key_data` (String, Sensitive) PEM encoded private key for client auth
 - `key_file` (String) Path to a file containing the PEM encoded private key for client auth
diff --git a/docs/resources/elasticsearch_enrich_policy.md b/docs/resources/elasticsearch_enrich_policy.md
@@ -78,7 +78,7 @@ Optional:
 - `cert_data` (String) PEM encoded certificate for client auth
 - `cert_file` (String) Path to a file containing the PEM encoded certificate for client auth
 - `endpoints` (List of String, Sensitive) A list of endpoints where the terraform provider will point to, this must include the http(s) schema and port number.
-- `es_client_authentication` (String, Sensitive) ES Client Authentication field to be used with the bearer token
+- `es_client_authentication` (String, Sensitive) ES Client Authentication field to be used with the JWT token
 - `insecure` (Boolean) Disable TLS certificate validation
 - `key_data` (String, Sensitive) PEM encoded private key for client auth
 - `key_file` (String) Path to a file containing the PEM encoded private key for client auth
diff --git a/docs/resources/elasticsearch_index.md b/docs/resources/elasticsearch_index.md
@@ -164,7 +164,7 @@ Optional:
 - `cert_data` (String) PEM encoded certificate for client auth
 - `cert_file` (String) Path to a file containing the PEM encoded certificate for client auth
 - `endpoints` (List of String, Sensitive) A list of endpoints where the terraform provider will point to, this must include the http(s) schema and port number.
-- `es_client_authentication` (String, Sensitive) ES Client Authentication field to be used with the bearer token
+- `es_client_authentication` (String, Sensitive) ES Client Authentication field to be used with the JWT token
 - `insecure` (Boolean) Disable TLS certificate validation
 - `key_data` (String, Sensitive) PEM encoded private key for client auth
 - `key_file` (String) Path to a file containing the PEM encoded private key for client auth
diff --git a/docs/resources/elasticsearch_index_lifecycle.md b/docs/resources/elasticsearch_index_lifecycle.md
@@ -205,7 +205,7 @@ Optional:
 - `cert_data` (String) PEM encoded certificate for client auth
 - `cert_file` (String) Path to a file containing the PEM encoded certificate for client auth
 - `endpoints` (List of String, Sensitive) A list of endpoints where the terraform provider will point to, this must include the http(s) schema and port number.
-- `es_client_authentication` (String, Sensitive) ES Client Authentication field to be used with the bearer token
+- `es_client_authentication` (String, Sensitive) ES Client Authentication field to be used with the JWT token
 - `insecure` (Boolean) Disable TLS certificate validation
 - `key_data` (String, Sensitive) PEM encoded private key for client auth
 - `key_file` (String) Path to a file containing the PEM encoded private key for client auth
diff --git a/docs/resources/elasticsearch_index_template.md b/docs/resources/elasticsearch_index_template.md
@@ -88,7 +88,7 @@ Optional:
 - `cert_data` (String) PEM encoded certificate for client auth
 - `cert_file` (String) Path to a file containing the PEM encoded certificate for client auth
 - `endpoints` (List of String, Sensitive) A list of endpoints where the terraform provider will point to, this must include the http(s) schema and port number.
-- `es_client_authentication` (String, Sensitive) ES Client Authentication field to be used with the bearer token
+- `es_client_authentication` (String, Sensitive) ES Client Authentication field to be used with the JWT token
 - `insecure` (Boolean) Disable TLS certificate validation
 - `key_data` (String, Sensitive) PEM encoded private key for client auth
 - `key_file` (String) Path to a file containing the PEM encoded private key for client auth
diff --git a/docs/resources/elasticsearch_ingest_pipeline.md b/docs/resources/elasticsearch_ingest_pipeline.md
@@ -101,7 +101,7 @@ Optional:
 - `cert_data` (String) PEM encoded certificate for client auth
 - `cert_file` (String) Path to a file containing the PEM encoded certificate for client auth
 - `endpoints` (List of String, Sensitive) A list of endpoints where the terraform provider will point to, this must include the http(s) schema and port number.
-- `es_client_authentication` (String, Sensitive) ES Client Authentication field to be used with the bearer token
+- `es_client_authentication` (String, Sensitive) ES Client Authentication field to be used with the JWT token
 - `insecure` (Boolean) Disable TLS certificate validation
 - `key_data` (String, Sensitive) PEM encoded private key for client auth
 - `key_file` (String) Path to a file containing the PEM encoded private key for client auth
diff --git a/docs/resources/elasticsearch_logstash_pipeline.md b/docs/resources/elasticsearch_logstash_pipeline.md
@@ -100,7 +100,7 @@ Optional:
 - `cert_data` (String) PEM encoded certificate for client auth
 - `cert_file` (String) Path to a file containing the PEM encoded certificate for client auth
 - `endpoints` (List of String, Sensitive) A list of endpoints where the terraform provider will point to, this must include the http(s) schema and port number.
-- `es_client_authentication` (String, Sensitive) ES Client Authentication field to be used with the bearer token
+- `es_client_authentication` (String, Sensitive) ES Client Authentication field to be used with the JWT token
 - `insecure` (Boolean) Disable TLS certificate validation
 - `key_data` (String, Sensitive) PEM encoded private key for client auth
 - `key_file` (String) Path to a file containing the PEM encoded private key for client auth
diff --git a/docs/resources/elasticsearch_script.md b/docs/resources/elasticsearch_script.md
@@ -73,7 +73,7 @@ Optional:
 - `cert_data` (String) PEM encoded certificate for client auth
 - `cert_file` (String) Path to a file containing the PEM encoded certificate for client auth
 - `endpoints` (List of String, Sensitive) A list of endpoints where the terraform provider will point to, this must include the http(s) schema and port number.
-- `es_client_authentication` (String, Sensitive) ES Client Authentication field to be used with the bearer token
+- `es_client_authentication` (String, Sensitive) ES Client Authentication field to be used with the JWT token
 - `insecure` (Boolean) Disable TLS certificate validation
 - `key_data` (String, Sensitive) PEM encoded private key for client auth
 - `key_file` (String) Path to a file containing the PEM encoded private key for client auth
diff --git a/docs/resources/elasticsearch_security_api_key.md b/docs/resources/elasticsearch_security_api_key.md
@@ -112,7 +112,7 @@ Optional:
 - `cert_data` (String) PEM encoded certificate for client auth
 - `cert_file` (String) Path to a file containing the PEM encoded certificate for client auth
 - `endpoints` (List of String, Sensitive) A list of endpoints where the terraform provider will point to, this must include the http(s) schema and port number.
-- `es_client_authentication` (String, Sensitive) ES Client Authentication field to be used with the bearer token
+- `es_client_authentication` (String, Sensitive) ES Client Authentication field to be used with the JWT token
 - `insecure` (Boolean) Disable TLS certificate validation
 - `key_data` (String, Sensitive) PEM encoded private key for client auth
 - `key_file` (String) Path to a file containing the PEM encoded private key for client auth
diff --git a/docs/resources/elasticsearch_security_role.md b/docs/resources/elasticsearch_security_role.md
@@ -90,7 +90,7 @@ Optional:
 - `cert_data` (String) PEM encoded certificate for client auth
 - `cert_file` (String) Path to a file containing the PEM encoded certificate for client auth
 - `endpoints` (List of String, Sensitive) A list of endpoints where the terraform provider will point to, this must include the http(s) schema and port number.
-- `es_client_authentication` (String, Sensitive) ES Client Authentication field to be used with the bearer token
+- `es_client_authentication` (String, Sensitive) ES Client Authentication field to be used with the JWT token
 - `insecure` (Boolean) Disable TLS certificate validation
 - `key_data` (String, Sensitive) PEM encoded private key for client auth
 - `key_file` (String) Path to a file containing the PEM encoded private key for client auth
diff --git a/docs/resources/elasticsearch_security_role_mapping.md b/docs/resources/elasticsearch_security_role_mapping.md
@@ -68,7 +68,7 @@ Optional:
 - `cert_data` (String) PEM encoded certificate for client auth
 - `cert_file` (String) Path to a file containing the PEM encoded certificate for client auth
 - `endpoints` (List of String, Sensitive) A list of endpoints where the terraform provider will point to, this must include the http(s) schema and port number.
-- `es_client_authentication` (String, Sensitive) ES Client Authentication field to be used with the bearer token
+- `es_client_authentication` (String, Sensitive) ES Client Authentication field to be used with the JWT token
 - `insecure` (Boolean) Disable TLS certificate validation
 - `key_data` (String, Sensitive) PEM encoded private key for client auth
 - `key_file` (String) Path to a file containing the PEM encoded private key for client auth
diff --git a/docs/resources/elasticsearch_security_system_user.md b/docs/resources/elasticsearch_security_system_user.md
@@ -62,7 +62,7 @@ Optional:
 - `cert_data` (String) PEM encoded certificate for client auth
 - `cert_file` (String) Path to a file containing the PEM encoded certificate for client auth
 - `endpoints` (List of String, Sensitive) A list of endpoints where the terraform provider will point to, this must include the http(s) schema and port number.
-- `es_client_authentication` (String, Sensitive) ES Client Authentication field to be used with the bearer token
+- `es_client_authentication` (String, Sensitive) ES Client Authentication field to be used with the JWT token
 - `insecure` (Boolean) Disable TLS certificate validation
 - `key_data` (String, Sensitive) PEM encoded private key for client auth
 - `key_file` (String) Path to a file containing the PEM encoded private key for client auth
diff --git a/docs/resources/elasticsearch_security_user.md b/docs/resources/elasticsearch_security_user.md
@@ -87,7 +87,7 @@ Optional:
 - `cert_data` (String) PEM encoded certificate for client auth
 - `cert_file` (String) Path to a file containing the PEM encoded certificate for client auth
 - `endpoints` (List of String, Sensitive) A list of endpoints where the terraform provider will point to, this must include the http(s) schema and port number.
-- `es_client_authentication` (String, Sensitive) ES Client Authentication field to be used with the bearer token
+- `es_client_authentication` (String, Sensitive) ES Client Authentication field to be used with the JWT token
 - `insecure` (Boolean) Disable TLS certificate validation
 - `key_data` (String, Sensitive) PEM encoded private key for client auth
 - `key_file` (String) Path to a file containing the PEM encoded private key for client auth
diff --git a/docs/resources/elasticsearch_snapshot_lifecycle.md b/docs/resources/elasticsearch_snapshot_lifecycle.md
@@ -86,7 +86,7 @@ Optional:
 - `cert_data` (String) PEM encoded certificate for client auth
 - `cert_file` (String) Path to a file containing the PEM encoded certificate for client auth
 - `endpoints` (List of String, Sensitive) A list of endpoints where the terraform provider will point to, this must include the http(s) schema and port number.
-- `es_client_authentication` (String, Sensitive) ES Client Authentication field to be used with the bearer token
+- `es_client_authentication` (String, Sensitive) ES Client Authentication field to be used with the JWT token
 - `insecure` (Boolean) Disable TLS certificate validation
 - `key_data` (String, Sensitive) PEM encoded private key for client auth
 - `key_file` (String) Path to a file containing the PEM encoded private key for client auth
diff --git a/docs/resources/elasticsearch_snapshot_repository.md b/docs/resources/elasticsearch_snapshot_repository.md
@@ -89,7 +89,7 @@ Optional:
 - `cert_data` (String) PEM encoded certificate for client auth
 - `cert_file` (String) Path to a file containing the PEM encoded certificate for client auth
 - `endpoints` (List of String, Sensitive) A list of endpoints where the terraform provider will point to, this must include the http(s) schema and port number.
-- `es_client_authentication` (String, Sensitive) ES Client Authentication field to be used with the bearer token
+- `es_client_authentication` (String, Sensitive) ES Client Authentication field to be used with the JWT token
 - `insecure` (Boolean) Disable TLS certificate validation
 - `key_data` (String, Sensitive) PEM encoded private key for client auth
 - `key_file` (String) Path to a file containing the PEM encoded private key for client auth
diff --git a/internal/schema/connection.go b/internal/schema/connection.go
@@ -58,7 +58,7 @@ func GetEsFWConnectionBlock(keyName string, isProviderConfiguration bool) fwsche
 					},
 				},
 				"es_client_authentication": fwschema.StringAttribute{
-					MarkdownDescription: "ES Client Authentication field to be used with the bearer token",
+					MarkdownDescription: "ES Client Authentication field to be used with the JWT token",
 					Optional:            true,
 					Sensitive:           true,
 					Validators: []validator.String{
@@ -296,7 +296,7 @@ func GetEsConnectionSchema(keyName string, isProviderConfiguration bool) *schema
 					ConflictsWith: []string{usernamePath, passwordPath, apiKeyPath},
 				},
 				"es_client_authentication": {
-					Description: "ES Client Authentication field to be used with the bearer token",
+					Description: "ES Client Authentication field to be used with the JWT token",
 					Type:        schema.TypeString,
 					Optional:    true,
 					Sensitive:   true,
