ServiceSummary - Amazon Cloud Map
ContentsSee Also
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).

ServiceSummary

A complex type that contains information about a specified service.

Contents

Arn

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

Type: String

Length Constraints: Maximum length of 255.

Required: No

CreateDate

The date and time that the service was created.

Type: Timestamp

Required: No

Description

The description that you specify when you create the service.

Type: String

Length Constraints: Maximum length of 1024.

Required: No

DnsConfig

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

Type: DnsConfig object

Required: No

HealthCheckConfig

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

Type: HealthCheckConfig object

Required: No

HealthCheckCustomConfig

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.

Important

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

Type: HealthCheckCustomConfig object

Required: No

Id

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

Type: String

Length Constraints: Maximum length of 64.

Required: No

InstanceCount

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

Name

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

Type

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

DNS_HTTP

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

HTTP

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

DNS

Reserved.

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 Amazon SDKs, see the following: