AWS::ServiceDiscovery::Instance
A complex type that contains information about an instance that AWS Cloud Map creates when you submit a
RegisterInstance
request.
Syntax
To declare this entity in your AWS CloudFormation template, use the following syntax:
JSON
{ "Type" : "AWS::ServiceDiscovery::Instance", "Properties" : { "InstanceAttributes" :
Json
, "InstanceId" :String
, "ServiceId" :String
} }
YAML
Type: AWS::ServiceDiscovery::Instance Properties: InstanceAttributes:
Json
InstanceId:String
ServiceId:String
Properties
InstanceAttributes
-
A string map that contains the following information for the service that you specify in
ServiceId
:-
The attributes that apply to the records that are defined in the service.
-
For each attribute, the applicable value.
Supported attribute keys include the following:
- AWS_ALIAS_DNS_NAME
-
If you want AWS Cloud Map to create a Route 53 alias record that routes traffic to an Elastic Load Balancing load balancer, specify the DNS name that is associated with the load balancer. For information about how to get the DNS name, see AliasTarget->DNSName in the Route 53 API Reference.
Note the following:
-
The configuration for the service that is specified by
ServiceId
must include settings for anA
record, anAAAA
record, or both. -
In the service that is specified by
ServiceId
, the value ofRoutingPolicy
must beWEIGHTED
. -
If the service that is specified by
ServiceId
includesHealthCheckConfig
settings, AWS Cloud Map will create the health check, but it won't associate the health check with the alias record. -
Auto naming currently doesn't support creating alias records that route traffic to AWS resources other than ELB load balancers.
-
If you specify a value for
AWS_ALIAS_DNS_NAME
, don't specify values for any of theAWS_INSTANCE
attributes.
-
- AWS_EC2_INSTANCE_ID
-
HTTP namespaces only. The Amazon EC2 instance ID for the instance. The
AWS_INSTANCE_IPV4
attribute contains the primary private IPv4 address. When creating resources with a type of AWS::ServiceDiscovery::Instance, if theAWS_EC2_INSTANCE_ID
attribute is specified, the only other attribute that can be specified isAWS_INIT_HEALTH_STATUS
. After the resource has been created, theAWS_INSTANCE_IPV4
attribute contains the primary private IPv4 address. - AWS_INIT_HEALTH_STATUS
-
If the service configuration includes
HealthCheckCustomConfig
, when creating resources with a type of AWS::ServiceDiscovery::Instance you can optionally useAWS_INIT_HEALTH_STATUS
to specify the initial status of the custom health check,HEALTHY
orUNHEALTHY
. If you don't specify a value forAWS_INIT_HEALTH_STATUS
, the initial status isHEALTHY
. This attribute can only be used when creating resources and will not be seen on existing resources. - AWS_INSTANCE_CNAME
-
If the service configuration includes a
CNAME
record, the domain name that you want Route 53 to return in response to DNS queries, for example,example.com
.This value is required if the service specified by
ServiceId
includes settings for anCNAME
record. - AWS_INSTANCE_IPV4
-
If the service configuration includes an
A
record, the IPv4 address that you want Route 53 to return in response to DNS queries, for example,192.0.2.44
.This value is required if the service specified by
ServiceId
includes settings for anA
record. If the service includes settings for anSRV
record, you must specify a value forAWS_INSTANCE_IPV4
,AWS_INSTANCE_IPV6
, or both. - AWS_INSTANCE_IPV6
-
If the service configuration includes an
AAAA
record, the IPv6 address that you want Route 53 to return in response to DNS queries, for example,2001:0db8:85a3:0000:0000:abcd:0001:2345
.This value is required if the service specified by
ServiceId
includes settings for anAAAA
record. If the service includes settings for anSRV
record, you must specify a value forAWS_INSTANCE_IPV4
,AWS_INSTANCE_IPV6
, or both. - AWS_INSTANCE_PORT
-
If the service includes an
SRV
record, the value that you want Route 53 to return for the port.If the service includes
HealthCheckConfig
, the port on the endpoint that you want Route 53 to send requests to.This value is required if you specified settings for an
SRV
record or a Route 53 health check when you created the service.
Required: Yes
Type: Json
Update requires: No interruption
-
InstanceId
-
An identifier that you want to associate with the instance. Note the following:
-
If the service that's specified by
ServiceId
includes settings for anSRV
record, the value ofInstanceId
is automatically included as part of the value for theSRV
record. For more information, see DnsRecord > Type. -
You can use this value to update an existing instance.
-
To register a new instance, you must specify a value that's unique among instances that you register by using the same service.
-
If you specify an existing
InstanceId
andServiceId
, AWS Cloud Map updates the existing DNS records, if any. If there's also an existing health check, AWS Cloud Map deletes the old health check and creates a new one.Note
The health check isn't deleted immediately, so it will still appear for a while if you submit a
ListHealthChecks
request, for example.
Note
Do not include sensitive information in
InstanceId
if the namespace is discoverable by public DNS queries and anyType
member ofDnsRecord
for the service containsSRV
because theInstanceId
is discoverable by public DNS queries.Required: No
Type: String
Pattern:
^[0-9a-zA-Z_/:.@-]+$
Maximum:
64
Update requires: Replacement
-
ServiceId
-
The ID of the service that you want to use for settings for the instance.
Required: Yes
Type: String
Maximum:
64
Update requires: Replacement
Return values
Ref
When you pass the logical ID of this resource to the intrinsic Ref
function, Ref
returns the value of Id
for the instance, such as
i-abcd1234
.
For more information about using the Ref
function, see Ref
.
Fn::GetAtt
InstanceId
-
The ID of an instance that matches the values that you specified in the request.
Examples
Provide IP addresses for an instance
The following example provides IPv4 and IPV6 IP addresses for the instance that has an ID of
i-abcd1234
. The instance was registered using the service that has an ID of
srv-e4anhexample0004
.
JSON
{ "Resources": { "Instance": { "Type": "AWS::ServiceDiscovery::Instance", "Properties": { "InstanceAttributes": { "AWS_INSTANCE_IPV4": "192.0.2.44", "AWS_INSTANCE_IPV6": "2001:0db8:85a3:0000:0000:abcd:0001:2345" }, "InstanceId": "i-abcd1234", "ServiceId": "srv-e4anhexample0004" } } } }
YAML
Resources: Instance: Type: AWS::ServiceDiscovery::Instance Properties: InstanceAttributes: AWS_INSTANCE_IPV4: 192.0.2.44 AWS_INSTANCE_IPV6: 2001:0db8:85a3:0000:0000:abcd:0001:2345 InstanceId: i-abcd1234 ServiceId: srv-e4anhexample0004
See also
-
RegisterInstance in the AWS Cloud Map API Reference