InstanceSummary
A complex type that contains information about the instances that you registered by using a specified service.
Contents
- Attributes
-
A string map that contains the following information:
-
The attributes that are associated with the instance.
-
For each attribute, the applicable value.
Supported attribute keys include the following:
- AWS_ALIAS_DNS_NAME
-
For an alias record that routes traffic to an Elastic Load Balancing load balancer, the DNS name that's associated with the load balancer.
- AWS_EC2_INSTANCE_ID (HTTP namespaces only)
-
The Amazon EC2 instance ID for the instance. When the
AWS_EC2_INSTANCE_ID
attribute is specified, then theAWS_INSTANCE_IPV4
attribute contains the primary private IPv4 address. - AWS_INIT_HEALTH_STATUS
-
If the service configuration includes
HealthCheckCustomConfig
, 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
. - AWS_INSTANCE_CNAME
-
For a
CNAME
record, the domain name that Route 53 returns in response to DNS queries (for example,example.com
). - AWS_INSTANCE_IPV4
-
For an
A
record, the IPv4 address that Route 53 returns in response to DNS queries (for example,192.0.2.44
). - AWS_INSTANCE_IPV6
-
For an
AAAA
record, the IPv6 address that Route 53 returns in response to DNS queries (for example,2001:0db8:85a3:0000:0000:abcd:0001:2345
). - AWS_INSTANCE_PORT
-
For an
SRV
record, the value that Route 53 returns for the port. In addition, if the service includesHealthCheckConfig
, the port on the endpoint that Route 53 sends requests to.
Type: String to string map
Key Length Constraints: Maximum length of 255.
Key Pattern:
^[a-zA-Z0-9!-~]+$
Value Length Constraints: Maximum length of 1024.
Value Pattern:
^([a-zA-Z0-9!-~][ \ta-zA-Z0-9!-~]*){0,1}[a-zA-Z0-9!-~]{0,1}$
Required: No
-
- CreatedByAccount
-
The ID of the AWS account that registered the instance. If this isn't your account ID, it's the ID of the account that shared the namespace with your account or the ID of another account with which the namespace has been shared. For more information about shared namespaces, see Cross-account AWS Cloud Map namespace sharing in the AWS Cloud Map Developer Guide.
Type: String
Length Constraints: Fixed length of 12.
Required: No
- Id
-
The ID for an instance that you created by using a specified service.
Type: String
Length Constraints: Maximum length of 64.
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: