ServiceSummary
A complex type that contains information about a 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.
Type: Timestamp
Required: No
- CreatedByAccount
-
The ID of the AWS account that created the service. If this isn't your account ID, it is the account ID of the namespace owner or 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
- 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 AWS 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, AWS 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
HealthCheckConfigbecause 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
HealthCheckCustomConfigorHealthCheckConfigbut 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
- ResourceOwner
-
The ID of the AWS account that created the namespace with which the service is associated. If this isn't your account ID, it is the ID of the account that shared the namespace with your account. 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
- 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
DiscoverInstancesAPI operation. - HTTP
-
The service instances can only be discovered using the
DiscoverInstancesAPI operation. - DNS
-
Reserved.
Type: String
Valid Values:
HTTP | DNS_HTTP | DNSRequired: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
