ServiceSummary - AWS Cloud Map


A complex type that contains information about a specified service.



The Amazon Resource Name (ARN) that AWS Cloud Map assigns to the service when you create it.

Type: String

Length Constraints: Maximum length of 255.

Required: No


The date and time that the service was created.

Type: Timestamp

Required: No


The description that you specify when you create the service.

Type: String

Length Constraints: Maximum length of 1024.

Required: No


Information about the RouteĀ 53 DNS records that you want AWS Cloud Map to create when you register an instance.

Type: DnsConfig object

Required: No


Public DNS and HTTP namespaces only. Settings for an optional health check. If you specify settings for a health check, AWS Cloud Map associates the health check with the records that you specify in DnsConfig.

Type: HealthCheckConfig object

Required: No


Information about an optional custom health check. A custom health check, which requires that you use a third-party health checker to evaluate the health of your resources, is useful in the following circumstances:

  • You can't use a health check that's defined by HealthCheckConfig because the resource isn't available over the internet. For example, you can use a custom health check when the instance is in an Amazon VPC. (To check the health of resources in a VPC, the health checker must also be in the VPC.)

  • You want to use a third-party health checker regardless of where your resources are located.


If you specify a health check configuration, you can specify either HealthCheckCustomConfig or HealthCheckConfig but not both.

Type: HealthCheckCustomConfig object

Required: No


The ID that AWS Cloud Map assigned to the service when you created it.

Type: String

Length Constraints: Maximum length of 64.

Required: No


The number of instances that are currently associated with the service. Instances that were previously associated with the service but that are deleted aren't included in the count. The count might not reflect pending registrations and deregistrations.

Type: Integer

Required: No


The name of the service.

Type: String

Pattern: ((?=^.{1,127}$)^([a-zA-Z0-9_][a-zA-Z0-9-_]{0,61}[a-zA-Z0-9_]|[a-zA-Z0-9])(\.([a-zA-Z0-9_][a-zA-Z0-9-_]{0,61}[a-zA-Z0-9_]|[a-zA-Z0-9]))*$)|(^\.$)

Required: No


Describes the systems that can be used to discover the service instances.


The service instances can be discovered using either DNS queries or the DiscoverInstances API operation.


The service instances can only be discovered using the DiscoverInstances API operation.



Type: String

Valid Values: HTTP | DNS_HTTP | DNS

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: