Skip to content

Commit 90c0a22

Browse files
committed
Docs: Clarify deprecations in aws_service_discovery_service
This change adapts the example usage to use the non-deprecated block `health_check_config` instead of `health_check_custom_config`. Additionally, a note regarding the deprecation of `health_check_custom_config` is added.
1 parent 27fd727 commit 90c0a22

File tree

1 file changed

+5
-3
lines changed

1 file changed

+5
-3
lines changed

website/docs/r/service_discovery_service.html.markdown

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ resource "aws_service_discovery_service" "example" {
3939
routing_policy = "MULTIVALUE"
4040
}
4141
42-
health_check_custom_config {
42+
health_check_config {
4343
failure_threshold = 1
4444
}
4545
}
@@ -79,9 +79,9 @@ This resource supports the following arguments:
7979
* `name` - (Required, Forces new resource) The name of the service.
8080
* `description` - (Optional) The description of the service.
8181
* `dns_config` - (Optional) A complex type that contains information about the resource record sets that you want Amazon Route 53 to create when you register an instance. See [`dns_config` Block](#dns_config-block) for details.
82-
* `health_check_config` - (Optional) A complex type that contains settings for an optional health check. Only for Public DNS namespaces. See [`health_check_config` Block](#health_check_config-block) for details.
8382
* `force_destroy` - (Optional) A boolean that indicates all instances should be deleted from the service so that the service can be destroyed without error. These instances are not recoverable. Defaults to `false`.
84-
* `health_check_custom_config` - (Optional, Forces new resource) A complex type that contains settings for ECS managed health checks. See [`health_check_custom_config` Block](#health_check_custom_config-block) for details.
83+
* `health_check_config` - (Optional) A complex type that contains settings for an optional health check. Only for Public DNS namespaces. See [`health_check_config` Block](#health_check_config-block) for details.
84+
* `health_check_custom_config` - (Optional, **Deprecated**, Forces new resource) Please use `health_check_config` instead. See [`health_check_custom_config` Block](#health_check_custom_config-block) for details.
8585
* `namespace_id` - (Optional) The ID of the namespace that you want to use to create the service.
8686
* `type` - (Optional) If present, specifies that the service instances are only discoverable using the `DiscoverInstances` API operation. No DNS records is registered for the service instances. The only valid value is `HTTP`.
8787
* `tags` - (Optional) A map of tags to assign to the service. If configured with a provider [`default_tags` configuration block](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#default_tags-configuration-block) present, tags with matching keys will overwrite those defined at the provider-level.
@@ -111,6 +111,8 @@ The `health_check_config` configuration block supports the following arguments:
111111

112112
### `health_check_custom_config` Block
113113

114+
~> The `health_check_custom_config` argument is deprecated. Use [`health_check_config`](#health_check_config-block) instead, which supports additional attributes.
115+
114116
The `health_check_custom_config` configuration block supports the following arguments:
115117

116118
* `failure_threshold` - (Optional, **Deprecated** Forces new resource) The number of 30-second intervals that you want service discovery to wait before it changes the health status of a service instance. Value is always set to 1.

0 commit comments

Comments
 (0)