AWS::ServiceDiscovery::Service DnsConfig
A complex type that contains information about the Amazon Route 53 DNS records that you want AWS Cloud Map to create when you register an instance.
Important
The record types of a service can only be changed by deleting the service and recreating it with a new
Dnsconfig
.
Syntax
To declare this entity in your AWS CloudFormation template, use the following syntax:
JSON
{ "DnsRecords" :
[ DnsRecord, ... ]
, "NamespaceId" :String
, "RoutingPolicy" :String
}
YAML
DnsRecords:
- DnsRecord
NamespaceId:String
RoutingPolicy:String
Properties
DnsRecords
-
An array that contains one
DnsRecord
object for each Route 53 DNS record that you want AWS Cloud Map to create when you register an instance.Important
The record type of a service can't be updated directly and can only be changed by deleting the service and recreating it with a new
DnsConfig
.Required: Yes
Type: Array of DnsRecord
Update requires: No interruption
NamespaceId
-
The ID of the namespace to use for DNS configuration.
Important
You must specify a value for
NamespaceId
either forDnsConfig
or for the service properties. Don't specify a value in both places.Required: No
Type: String
Maximum:
64
Update requires: Replacement
RoutingPolicy
-
The routing policy that you want to apply to all Route 53 DNS records that AWS Cloud Map creates when you register an instance and specify this service.
Note
If you want to use this service to register instances that create alias records, specify
WEIGHTED
for the routing policy.You can specify the following values:
- MULTIVALUE
-
If you define a health check for the service and the health check is healthy, Route 53 returns the applicable value for up to eight instances.
For example, suppose that the service includes configurations for one
A
record and a health check. You use the service to register 10 instances. Route 53 responds to DNS queries with IP addresses for up to eight healthy instances. If fewer than eight instances are healthy, Route 53 responds to every DNS query with the IP addresses for all of the healthy instances.If you don't define a health check for the service, Route 53 assumes that all instances are healthy and returns the values for up to eight instances.
For more information about the multivalue routing policy, see Multivalue Answer Routing in the Route 53 Developer Guide.
- WEIGHTED
-
Route 53 returns the applicable value from one randomly selected instance from among the instances that you registered using the same service. Currently, all records have the same weight, so you can't route more or less traffic to any instances.
For example, suppose that the service includes configurations for one
A
record and a health check. You use the service to register 10 instances. Route 53 responds to DNS queries with the IP address for one randomly selected instance from among the healthy instances. If no instances are healthy, Route 53 responds to DNS queries as if all of the instances were healthy.If you don't define a health check for the service, Route 53 assumes that all instances are healthy and returns the applicable value for one randomly selected instance.
For more information about the weighted routing policy, see Weighted Routing in the Route 53 Developer Guide.
Required: No
Type: String
Allowed values:
MULTIVALUE | WEIGHTED
Update requires: Updates are not supported.
See also
-
Return values in the topic AWS::ServiceDiscovery::Service
-
DnsConfig in the AWS Cloud Map API Reference