Values That You Specify When You Register or Update Instances - Amazon Cloud Map
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

Values That You Specify When You Register or Update Instances

When you register a service instance, you specify the following values.

Values

Instance type

Each of the following instance types is available for selected configurations only.

IP address

Choose this option when the resource that's associated with the service instance is accessible using an IP address.

You can choose this option for all three types of namespaces: HTTP, public DNS, and private DNS.

EC2 Instance

Choose this option when the resource that's associated with the service instance is accessible through an EC2 instance.

You can choose this option for HTTP.

Identifying information for another resource

Choose this option when the resource that's associated with the service instance is accessible using values other than an IP address or an EC2 instance. Specify the other values in Custom attributes.

You can choose this option for all three types of namespaces: HTTP, public DNS, and private DNS.

Service instance ID

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

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

  • If the service that's specified by Service instance ID includes settings for an SRV record, the value of Service instance ID is automatically included as part of the value for the SRV record. For more information, see Record type in the section Values That You Specify When You Create Services.

  • You can update an existing instance programmatically. Call RegisterInstance, specify the value of Service instance ID and Service ID, and specify the new settings for the service instance. If Amazon Cloud Map created a health check when you registered the instance originally, Amazon 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 an Amazon Route 53 ListHealthChecks request, for example.

IPv4 address

The IPv4 IP address, if any, where your applications can access the resource that's associated with this service instance.

IPv6 address

The IPv6 IP address, if any, where your applications can access the resource that's associated with this service instance.

Note

Amazon Cloud Map API endpoints are now available in IPv6-only networks.

Port

The port, if any, that your applications must include to access the resource that's associated with this service instance. Port is required when the service includes an SRV record or an Amazon Route 53 health check.

EC2 instance ID

The instance Id in EC2 instance Id format for the resource.

Custom attributes

Specify key-value pairs that you want to associate with the resource, if any.

You can add up to 30 custom attributes. Note the following:

  • You must specify both Key and Value.

  • Key can be up to 255 characters long and can include the characters a-z, A-Z, 0-9 and other printable ASCII characters between 33 and 126 (Decimal). Spaces, tabs, and other whitespace characters are not allowed.

  • Value can be up to 1,024 characters long and can include the characters a-z, A-Z, 0-9, other printable ASCII characters between 33 and 126 (Decimal), space, and tab.