Service - AWS Cloud Map
ContentsSee Also

Service

A complex type that contains information about the specified service.

Contents

Arn

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

CreateDate

The date and time that the service was created, in Unix format and Coordinated Universal Time (UTC). The value of CreateDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

Type: Timestamp

Required: No

CreatorRequestId

A unique string that identifies the request and that allows failed requests to be retried without the risk of running the operation twice. CreatorRequestId can be any unique string (for example, a date/timestamp).

Type: String

Length Constraints: Maximum length of 64.

Required: No

Description

The description of the service.

Type: String

Length Constraints: Maximum length of 1024.

Required: No

DnsConfig

A complex type that contains information about the Route 53 DNS records that you want AWS Cloud Map to create when you register an instance.

Important

The record types of a service can only be changed by deleting the service and recreating it with a new Dnsconfig.

Type: DnsConfig object

Required: No

HealthCheckConfig

Public DNS and HTTP namespaces only. A complex type that contains 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.

For information about the charges for health checks, see Amazon Route 53 Pricing.

Type: HealthCheckConfig object

Required: No

HealthCheckCustomConfig

A complex type that contains information about an optional custom health check.

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 AWS 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

NamespaceId

The ID of the namespace that was used to create the service.

Type: String

Length Constraints: Maximum length of 64.

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