Menu
AWS CloudFormation
User Guide (API Version 2010-05-15)

AWS::ServiceDiscovery::Instance

The AWS::ServiceDiscovery::Instance resource specifies information about an instance that Amazon Route 53 creates. For more information, see Instance in the Amazon Route 53 API Reference.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

Copy
{ "Type" : "AWS::ServiceDiscovery::Instance", "Properties" : { "InstanceAttributes" : JSON object, "InstanceId" : String, "ServiceId" : String } }

YAML

Copy
Type: "AWS::ServiceDiscovery::Instance" Properties: InstanceAttributes: JSON object InstanceId: String ServiceId: String

Properties

InstanceAttributes

A string map that contains attribute keys and values. Supported attribute keys include the following:

  • AWS_INSTANCE_PORT: The port on the endpoint that you want Amazon Route 53 to perform health checks on. This value is also used for the port value in an SRV record if the service that you specify includes an SRV record. You can also specify a default port that is applied to all instances in the Service configuration. For more information, see CreateService in the Amazon Route 53 API Reference.

  • AWS_INSTANCE_IPV4: If the service that you specify contains a resource record set template for an A record, the IPv4 address that you want Amazon Route 53 to use for the value of the A record.

  • AWS_INSTANCE_IPV6: If the service that you specify contains a resource record set template for an AAAA record, the IPv6 address that you want Amazon Route 53 to use for the value of the AAAA record.

Required: Yes

Type: JSON object

Update requires: No interruption

InstanceId

An identifier that you want to associate with the instance. Note the following:

  • You can use this value to update an existing instance.

  • To associate a new instance, you must specify a value that is unique among instances that you associate by using the same service.

Required: Yes

Type: String

Update requires: Replacement

ServiceId

The ID of the service that you want to use for settings for the resource record sets and health check that Amazon Route 53 will create.

Required: Yes

Type: String

Update requires: Replacement

Return Values

Ref

When you pass the logical ID of an AWS::ServiceDiscovery::Instance resource to the intrinsic Ref function, the function returns the value of Id for the instance.

For more information about using the Ref function, see Ref.

See Also