String name
The name that you want to assign to this namespace.
String creatorRequestId
A unique string that identifies the request and that allows failed CreateHttpNamespace requests to
be retried without the risk of executing the operation twice. CreatorRequestId can be any unique
string, for example, a date/time stamp.
String description
A description for the namespace.
List<E> tags
The tags to add to the namespace. Each tag consists of a key and an optional value, both of which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.
String operationId
A value that you can use to determine whether the request completed successfully. To get the status of the operation, see GetOperation.
String name
The name that you want to assign to this namespace. When you create a private DNS namespace, AWS Cloud Map automatically creates an Amazon Route 53 private hosted zone that has the same name as the namespace.
String creatorRequestId
A unique string that identifies the request and that allows failed CreatePrivateDnsNamespace
requests to be retried without the risk of executing the operation twice. CreatorRequestId can be
any unique string, for example, a date/time stamp.
String description
A description for the namespace.
String vpc
The ID of the Amazon VPC that you want to associate the namespace with.
List<E> tags
The tags to add to the namespace. Each tag consists of a key and an optional value, both of which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.
String operationId
A value that you can use to determine whether the request completed successfully. To get the status of the operation, see GetOperation.
String name
The name that you want to assign to this namespace.
String creatorRequestId
A unique string that identifies the request and that allows failed CreatePublicDnsNamespace requests
to be retried without the risk of executing the operation twice. CreatorRequestId can be any unique
string, for example, a date/time stamp.
String description
A description for the namespace.
List<E> tags
The tags to add to the namespace. Each tag consists of a key and an optional value, both of which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.
String operationId
A value that you can use to determine whether the request completed successfully. To get the status of the operation, see GetOperation.
String name
The name that you want to assign to the service.
If you want AWS Cloud Map to create an SRV record when you register an instance, and if you're using a system
that requires a specific SRV format, such as HAProxy, specify the following
for Name:
Start the name with an underscore (_), such as _exampleservice
End the name with ._protocol, such as ._tcp
When you register an instance, AWS Cloud Map creates an SRV record and assigns a name to the record by concatenating the service name and the namespace name, for example:
_exampleservice._tcp.example.com
String namespaceId
The ID of the namespace that you want to use to create the service.
String creatorRequestId
A unique string that identifies the request and that allows failed CreateService requests to be
retried without the risk of executing the operation twice. CreatorRequestId can be any unique
string, for example, a date/time stamp.
String description
A description for the service.
DnsConfig dnsConfig
A complex type that contains information about the Amazon Route 53 records that you want AWS Cloud Map to create when you register an instance.
HealthCheckConfig healthCheckConfig
Public DNS and HTTP namespaces only. A complex type that contains settings for an optional Route 53 health
check. If you specify settings for a health check, AWS Cloud Map associates the health check with all the Route
53 DNS records that you specify in DnsConfig.
If you specify a health check configuration, you can specify either HealthCheckCustomConfig or
HealthCheckConfig but not both.
For information about the charges for health checks, see AWS Cloud Map Pricing.
HealthCheckCustomConfig healthCheckCustomConfig
A complex type that contains information about an optional custom health check.
If you specify a health check configuration, you can specify either HealthCheckCustomConfig or
HealthCheckConfig but not both.
You can't add, update, or delete a HealthCheckCustomConfig configuration from an existing service.
List<E> tags
The tags to add to the service. Each tag consists of a key and an optional value, both of which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.
Service service
A complex type that contains information about the new service.
String id
The ID of the namespace that you want to delete.
String operationId
A value that you can use to determine whether the request completed successfully. To get the status of the operation, see GetOperation.
String id
The ID of the service that you want to delete.
String serviceId
The ID of the service that the instance is associated with.
String instanceId
The value that you specified for Id in the RegisterInstance request.
String operationId
A value that you can use to determine whether the request completed successfully. For more information, see GetOperation.
String namespaceName
The name of the namespace that you specified when you registered the instance.
String serviceName
The name of the service that you specified when you registered the instance.
Integer maxResults
The maximum number of instances that you want AWS Cloud Map to return in the response to a
DiscoverInstances request. If you don't specify a value for MaxResults, AWS Cloud Map
returns up to 100 instances.
Map<K,V> queryParameters
A string map that contains attributes with values that you can use to filter instances by any custom attribute that you specified when you registered the instance. Only instances that match all the specified key/value pairs will be returned.
String healthStatus
The health status of the instances that you want to discover.
String namespaceId
The ID of the namespace to use for DNS configuration.
String routingPolicy
The routing policy that you want to apply to all Route 53 DNS records that AWS Cloud Map creates when you register an instance and specify this service.
If you want to use this service to register instances that create alias records, specify WEIGHTED
for the routing policy.
You can specify the following values:
MULTIVALUE
If you define a health check for the service and the health check is healthy, Route 53 returns the applicable value for up to eight instances.
For example, suppose the service includes configurations for one A record and a health check, and you use the service to register 10 instances. Route 53 responds to DNS queries with IP addresses for up to eight healthy instances. If fewer than eight instances are healthy, Route 53 responds to every DNS query with the IP addresses for all of the healthy instances.
If you don't define a health check for the service, Route 53 assumes that all instances are healthy and returns the values for up to eight instances.
For more information about the multivalue routing policy, see Multivalue Answer Routing in the Route 53 Developer Guide.
WEIGHTED
Route 53 returns the applicable value from one randomly selected instance from among the instances that you registered using the same service. Currently, all records have the same weight, so you can't route more or less traffic to any instances.
For example, suppose the service includes configurations for one A record and a health check, and you use the service to register 10 instances. Route 53 responds to DNS queries with the IP address for one randomly selected instance from among the healthy instances. If no instances are healthy, Route 53 responds to DNS queries as if all of the instances were healthy.
If you don't define a health check for the service, Route 53 assumes that all instances are healthy and returns the applicable value for one randomly selected instance.
For more information about the weighted routing policy, see Weighted Routing in the Route 53 Developer Guide.
List<E> dnsRecords
An array that contains one DnsRecord object for each Route 53 DNS record that you want AWS Cloud Map
to create when you register an instance.
String hostedZoneId
The ID for the Route 53 hosted zone that AWS Cloud Map creates when you create a namespace.
String type
The type of the resource, which indicates the type of value that Route 53 returns in response to DNS queries. You
can specify values for Type in the following combinations:
A
AAAA
A and AAAA
SRV
CNAME
If you want AWS Cloud Map to create a Route 53 alias record when you register an instance, specify A
or AAAA for Type.
You specify other settings, such as the IP address for A and AAAA records, when you register an instance. For more information, see RegisterInstance.
The following values are supported:
A
Route 53 returns the IP address of the resource in IPv4 format, such as 192.0.2.44.
AAAA
Route 53 returns the IP address of the resource in IPv6 format, such as 2001:0db8:85a3:0000:0000:abcd:0001:2345.
CNAME
Route 53 returns the domain name of the resource, such as www.example.com. Note the following:
You specify the domain name that you want to route traffic to when you register an instance. For more information, see Attributes in the topic RegisterInstance.
You must specify WEIGHTED for the value of RoutingPolicy.
You can't specify both CNAME for Type and settings for HealthCheckConfig.
If you do, the request will fail with an InvalidInput error.
SRV
Route 53 returns the value for an SRV record. The value for an SRV record uses the following values:
priority weight port service-hostname
Note the following about the values:
The values of priority and weight are both set to 1 and can't be changed.
The value of port comes from the value that you specify for the AWS_INSTANCE_PORT
attribute when you submit a RegisterInstance request.
The value of service-hostname is a concatenation of the following values:
The value that you specify for InstanceId when you register an instance.
The name of the service.
The name of the namespace.
For example, if the value of InstanceId is test, the name of the service is
backend, and the name of the namespace is example.com, the value of
service-hostname is:
test.backend.example.com
If you specify settings for an SRV record, note the following:
If you specify values for AWS_INSTANCE_IPV4, AWS_INSTANCE_IPV6, or both in the
RegisterInstance request, AWS Cloud Map automatically creates A and/or
AAAA records that have the same name as the value of service-hostname in the SRV
record. You can ignore these records.
If you're using a system that requires a specific SRV format, such as HAProxy, see the Name element in the documentation about CreateService for information about how to specify the
correct name format.
Long tTL
The amount of time, in seconds, that you want DNS resolvers to cache the settings for this record.
Alias records don't include a TTL because Route 53 uses the TTL for the AWS resource that an alias record routes
traffic to. If you include the AWS_ALIAS_DNS_NAME attribute when you submit a RegisterInstance request,
the TTL value is ignored. Always specify a TTL for the service; you can use a service to register
instances that create either alias or non-alias records.
String duplicateOperationId
The ID of the operation that is already in progress.
Instance instance
A complex type that contains information about a specified instance.
String serviceId
The ID of the service that the instance is associated with.
List<E> instances
An array that contains the IDs of all the instances that you want to get the health status for.
If you omit Instances, AWS Cloud Map returns the health status for all the instances that are
associated with the specified service.
To get the IDs for the instances that you've registered by using a specified service, submit a ListInstances request.
Integer maxResults
The maximum number of instances that you want AWS Cloud Map to return in the response to a
GetInstancesHealthStatus request. If you don't specify a value for MaxResults, AWS
Cloud Map returns up to 100 instances.
String nextToken
For the first GetInstancesHealthStatus request, omit this value.
If more than MaxResults instances match the specified criteria, you can submit another
GetInstancesHealthStatus request to get the next group of results. Specify the value of
NextToken from the previous response in the next request.
Map<K,V> status
A complex type that contains the IDs and the health status of the instances that you specified in the
GetInstancesHealthStatus request.
String nextToken
If more than MaxResults instances match the specified criteria, you can submit another
GetInstancesHealthStatus request to get the next group of results. Specify the value of
NextToken from the previous response in the next request.
String id
The ID of the namespace that you want to get information about.
Namespace namespace
A complex type that contains information about the specified namespace.
String operationId
The ID of the operation that you want to get more information about.
Operation operation
A complex type that contains information about the operation.
String id
The ID of the service that you want to get settings for.
Service service
A complex type that contains information about the service.
String type
The type of health check that you want to create, which indicates how Route 53 determines whether an endpoint is healthy.
You can't change the value of Type after you create a health check.
You can create the following types of health checks:
HTTP: Route 53 tries to establish a TCP connection. If successful, Route 53 submits an HTTP request and waits for an HTTP status code of 200 or greater and less than 400.
HTTPS: Route 53 tries to establish a TCP connection. If successful, Route 53 submits an HTTPS request and waits for an HTTP status code of 200 or greater and less than 400.
If you specify HTTPS for the value of Type, the endpoint must support TLS v1.0 or later.
TCP: Route 53 tries to establish a TCP connection.
If you specify TCP for Type, don't specify a value for ResourcePath.
For more information, see How Route 53 Determines Whether an Endpoint Is Healthy in the Route 53 Developer Guide.
String resourcePath
The path that you want Route 53 to request when performing health checks. The path can be any value for which
your endpoint will return an HTTP status code of 2xx or 3xx when the endpoint is healthy, such as the file
/docs/route53-health-check.html. Route 53 automatically adds the DNS name for the service. If you
don't specify a value for ResourcePath, the default value is /.
If you specify TCP for Type, you must not specify a value for
ResourcePath.
Integer failureThreshold
The number of consecutive health checks that an endpoint must pass or fail for Route 53 to change the current status of the endpoint from unhealthy to healthy or vice versa. For more information, see How Route 53 Determines Whether an Endpoint Is Healthy in the Route 53 Developer Guide.
Integer failureThreshold
The number of 30-second intervals that you want AWS Cloud Map to wait after receiving an
UpdateInstanceCustomHealthStatus request before it changes the health status of a service instance.
For example, suppose you specify a value of 2 for FailureTheshold, and then your
application sends an UpdateInstanceCustomHealthStatus request. AWS Cloud Map waits for approximately
60 seconds (2 x 30) before changing the status of the service instance based on that request.
Sending a second or subsequent UpdateInstanceCustomHealthStatus request with the same value before
FailureThreshold x 30 seconds has passed doesn't accelerate the change. AWS Cloud Map still waits
FailureThreshold x 30 seconds after the first request to make the change.
String instanceId
The ID of an instance that matches the values that you specified in the request.
String namespaceName
The name of the namespace that you specified when you registered the instance.
String serviceName
The name of the service that you specified when you registered the instance.
String healthStatus
If you configured health checking in the service, the current health status of the service instance.
Map<K,V> attributes
If you included any attributes when you registered the instance, the values of those attributes.
String httpName
The name of an HTTP namespace.
String id
An identifier that you want to associate with the instance. Note the following:
If the service that is specified by ServiceId includes settings for an SRV record, the value of
InstanceId is automatically included as part of the value for the SRV record. For more information,
see
DnsRecord > Type.
You can use this value to update an existing instance.
To register a new instance, you must specify a value that is unique among instances that you register by using the same service.
If you specify an existing InstanceId and ServiceId, AWS Cloud Map updates the existing
DNS records. If there's also an existing health check, AWS Cloud Map deletes the old health check and creates a
new one.
The health check isn't deleted immediately, so it will still appear for a while if you submit a
ListHealthChecks request, for example.
String creatorRequestId
A unique string that identifies the request and that allows failed RegisterInstance requests to be
retried without the risk of executing the operation twice. You must use a unique CreatorRequestId
string every time you submit a RegisterInstance request if you're registering additional instances
for the same namespace and service. CreatorRequestId can be any unique string, for example, a
date/time stamp.
Map<K,V> attributes
A string map that contains the following information for the service that you specify in ServiceId:
The attributes that apply to the records that are defined in the service.
For each attribute, the applicable value.
Supported attribute keys include the following:
AWS_ALIAS_DNS_NAME
If you want AWS Cloud Map to create a Route 53 alias record that routes traffic to an Elastic Load Balancing load balancer, specify the DNS name that is associated with the load balancer. For information about how to get the DNS name, see "DNSName" in the topic AliasTarget.
Note the following:
The configuration for the service that is specified by ServiceId must include settings for an A
record, an AAAA record, or both.
In the service that is specified by ServiceId, the value of RoutingPolicy must be
WEIGHTED.
If the service that is specified by ServiceId includes HealthCheckConfig settings, AWS
Cloud Map will create the health check, but it won't associate the health check with the alias record.
Auto naming currently doesn't support creating alias records that route traffic to AWS resources other than ELB load balancers.
If you specify a value for AWS_ALIAS_DNS_NAME, don't specify values for any of the
AWS_INSTANCE attributes.
AWS_INSTANCE_CNAME
If the service configuration includes a CNAME record, the domain name that you want Route 53 to return in
response to DNS queries, for example, example.com.
This value is required if the service specified by ServiceId includes settings for an CNAME record.
AWS_INSTANCE_IPV4
If the service configuration includes an A record, the IPv4 address that you want Route 53 to return in response
to DNS queries, for example, 192.0.2.44.
This value is required if the service specified by ServiceId includes settings for an A record. If
the service includes settings for an SRV record, you must specify a value for AWS_INSTANCE_IPV4,
AWS_INSTANCE_IPV6, or both.
AWS_INSTANCE_IPV6
If the service configuration includes an AAAA record, the IPv6 address that you want Route 53 to return in
response to DNS queries, for example, 2001:0db8:85a3:0000:0000:abcd:0001:2345.
This value is required if the service specified by ServiceId includes settings for an AAAA record.
If the service includes settings for an SRV record, you must specify a value for AWS_INSTANCE_IPV4,
AWS_INSTANCE_IPV6, or both.
AWS_INSTANCE_PORT
If the service includes an SRV record, the value that you want Route 53 to return for the port.
If the service includes HealthCheckConfig, the port on the endpoint that you want Route 53 to send
requests to.
This value is required if you specified settings for an SRV record or a Route 53 health check when you created the service.
String id
The ID for an instance that you created by using a specified service.
Map<K,V> attributes
A string map that contains the following information:
The attributes that are associate 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 is associated with the load balancer.
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 includes HealthCheckConfig, the port on the endpoint that Route 53 sends requests to.
String serviceId
The ID of the service that you want to list instances for.
String nextToken
For the first ListInstances request, omit this value.
If more than MaxResults instances match the specified criteria, you can submit another
ListInstances request to get the next group of results. Specify the value of NextToken
from the previous response in the next request.
Integer maxResults
The maximum number of instances that you want AWS Cloud Map to return in the response to a
ListInstances request. If you don't specify a value for MaxResults, AWS Cloud Map
returns up to 100 instances.
List<E> instances
Summary information about the instances that are associated with the specified service.
String nextToken
If more than MaxResults instances match the specified criteria, you can submit another
ListInstances request to get the next group of results. Specify the value of NextToken
from the previous response in the next request.
String nextToken
For the first ListNamespaces request, omit this value.
If the response contains NextToken, submit another ListNamespaces request to get the
next group of results. Specify the value of NextToken from the previous response in the next
request.
AWS Cloud Map gets MaxResults namespaces and then filters them based on the specified criteria. It's
possible that no namespaces in the first MaxResults namespaces matched the specified criteria but
that subsequent groups of MaxResults namespaces do contain namespaces that match the criteria.
Integer maxResults
The maximum number of namespaces that you want AWS Cloud Map to return in the response to a
ListNamespaces request. If you don't specify a value for MaxResults, AWS Cloud Map
returns up to 100 namespaces.
List<E> filters
A complex type that contains specifications for the namespaces that you want to list.
If you specify more than one filter, a namespace must match all filters to be returned by
ListNamespaces.
List<E> namespaces
An array that contains one NamespaceSummary object for each namespace that matches the specified
filter criteria.
String nextToken
If the response contains NextToken, submit another ListNamespaces request to get the
next group of results. Specify the value of NextToken from the previous response in the next
request.
AWS Cloud Map gets MaxResults namespaces and then filters them based on the specified criteria. It's
possible that no namespaces in the first MaxResults namespaces matched the specified criteria but
that subsequent groups of MaxResults namespaces do contain namespaces that match the criteria.
String nextToken
For the first ListOperations request, omit this value.
If the response contains NextToken, submit another ListOperations request to get the
next group of results. Specify the value of NextToken from the previous response in the next
request.
AWS Cloud Map gets MaxResults operations and then filters them based on the specified criteria. It's
possible that no operations in the first MaxResults operations matched the specified criteria but
that subsequent groups of MaxResults operations do contain operations that match the criteria.
Integer maxResults
The maximum number of items that you want AWS Cloud Map to return in the response to a
ListOperations request. If you don't specify a value for MaxResults, AWS Cloud Map
returns up to 100 operations.
List<E> filters
A complex type that contains specifications for the operations that you want to list, for example, operations that you started between a specified start date and end date.
If you specify more than one filter, an operation must match all filters to be returned by
ListOperations.
List<E> operations
Summary information about the operations that match the specified criteria.
String nextToken
If the response contains NextToken, submit another ListOperations request to get the
next group of results. Specify the value of NextToken from the previous response in the next
request.
AWS Cloud Map gets MaxResults operations and then filters them based on the specified criteria. It's
possible that no operations in the first MaxResults operations matched the specified criteria but
that subsequent groups of MaxResults operations do contain operations that match the criteria.
String nextToken
For the first ListServices request, omit this value.
If the response contains NextToken, submit another ListServices request to get the next
group of results. Specify the value of NextToken from the previous response in the next request.
AWS Cloud Map gets MaxResults services and then filters them based on the specified criteria. It's
possible that no services in the first MaxResults services matched the specified criteria but that
subsequent groups of MaxResults services do contain services that match the criteria.
Integer maxResults
The maximum number of services that you want AWS Cloud Map to return in the response to a
ListServices request. If you don't specify a value for MaxResults, AWS Cloud Map
returns up to 100 services.
List<E> filters
A complex type that contains specifications for the namespaces that you want to list services for.
If you specify more than one filter, an operation must match all filters to be returned by
ListServices.
List<E> services
An array that contains one ServiceSummary object for each service that matches the specified filter
criteria.
String nextToken
If the response contains NextToken, submit another ListServices request to get the next
group of results. Specify the value of NextToken from the previous response in the next request.
AWS Cloud Map gets MaxResults services and then filters them based on the specified criteria. It's
possible that no services in the first MaxResults services matched the specified criteria but that
subsequent groups of MaxResults services do contain services that match the criteria.
String resourceARN
The Amazon Resource Name (ARN) of the resource that you want to retrieve tags for.
String id
The ID of a namespace.
String arn
The Amazon Resource Name (ARN) that AWS Cloud Map assigns to the namespace when you create it.
String name
The name of the namespace, such as example.com.
String type
The type of the namespace. The methods for discovering instances depends on the value that you specify:
HTTP: Instances can be discovered only programmatically, using the AWS Cloud Map
DiscoverInstances API.
DNS_PUBLIC: Instances can be discovered using public DNS queries and using the
DiscoverInstances API.
DNS_PRIVATE: Instances can be discovered using DNS queries in VPCs and using the
DiscoverInstances API.
String description
The description that you specify for the namespace when you create it.
Integer serviceCount
The number of services that are associated with the namespace.
NamespaceProperties properties
A complex type that contains information that's specific to the type of the namespace.
Date createDate
The date that the namespace was created, in Unix date/time 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.
String creatorRequestId
A unique string that identifies the request and that allows failed requests to be retried without the risk of executing an operation twice.
String name
Specify TYPE.
List<E> values
If you specify EQ for Condition, specify either DNS_PUBLIC or
DNS_PRIVATE.
If you specify IN for Condition, you can specify DNS_PUBLIC,
DNS_PRIVATE, or both.
String condition
The operator that you want to use to determine whether ListNamespaces returns a namespace. Valid
values for condition include:
EQ: When you specify EQ for the condition, you can choose to list only public
namespaces or private namespaces, but not both. EQ is the default condition and can be omitted.
IN: When you specify IN for the condition, you can choose to list public namespaces,
private namespaces, or both.
BETWEEN: Not applicable
DnsProperties dnsProperties
A complex type that contains the ID for the Route 53 hosted zone that AWS Cloud Map creates when you create a namespace.
HttpProperties httpProperties
A complex type that contains the name of an HTTP namespace.
String id
The ID of the namespace.
String arn
The Amazon Resource Name (ARN) that AWS Cloud Map assigns to the namespace when you create it.
String name
The name of the namespace. When you create a namespace, AWS Cloud Map automatically creates a Route 53 hosted zone that has the same name as the namespace.
String type
The type of the namespace, either public or private.
String description
A description for the namespace.
Integer serviceCount
The number of services that were created using the namespace.
NamespaceProperties properties
Date createDate
The date and time that the namespace was created.
String id
The ID of the operation that you want to get information about.
String type
The name of the operation that is associated with the specified ID.
String status
The status of the operation. Values include the following:
SUBMITTED: This is the initial state immediately after you submit a request.
PENDING: AWS Cloud Map is performing the operation.
SUCCESS: The operation succeeded.
FAIL: The operation failed. For the failure reason, see ErrorMessage.
String errorMessage
If the value of Status is FAIL, the reason that the operation failed.
String errorCode
The code associated with ErrorMessage. Values for ErrorCode include the following:
ACCESS_DENIED
CANNOT_CREATE_HOSTED_ZONE
EXPIRED_TOKEN
HOSTED_ZONE_NOT_FOUND
INTERNAL_FAILURE
INVALID_CHANGE_BATCH
THROTTLED_REQUEST
Date createDate
The date and time that the request was submitted, in Unix date/time 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.
Date updateDate
The date and time that the value of Status changed to the current value, in Unix date/time format
and Coordinated Universal Time (UTC). The value of UpdateDate is accurate to milliseconds. For
example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
Map<K,V> targets
The name of the target entity that is associated with the operation:
NAMESPACE: The namespace ID is returned in the ResourceId property.
SERVICE: The service ID is returned in the ResourceId property.
INSTANCE: The instance ID is returned in the ResourceId property.
String name
Specify the operations that you want to get:
NAMESPACE_ID: Gets operations related to specified namespaces.
SERVICE_ID: Gets operations related to specified services.
STATUS: Gets operations based on the status of the operations: SUBMITTED,
PENDING, SUCCEED, or FAIL.
TYPE: Gets specified types of operation.
UPDATE_DATE: Gets operations that changed status during a specified date/time range.
List<E> values
Specify values that are applicable to the value that you specify for Name:
NAMESPACE_ID: Specify one namespace ID.
SERVICE_ID: Specify one service ID.
STATUS: Specify one or more statuses: SUBMITTED, PENDING, SUCCEED,
or FAIL.
TYPE: Specify one or more of the following types: CREATE_NAMESPACE,
DELETE_NAMESPACE, UPDATE_SERVICE, REGISTER_INSTANCE, or
DEREGISTER_INSTANCE.
UPDATE_DATE: Specify a start date and an end date in Unix date/time format and Coordinated Universal Time (UTC). The start date must be the first value.
String condition
The operator that you want to use to determine whether an operation matches the specified value. Valid values for condition include:
EQ: When you specify EQ for the condition, you can specify only one value.
EQ is supported for NAMESPACE_ID, SERVICE_ID, STATUS, and
TYPE. EQ is the default condition and can be omitted.
IN: When you specify IN for the condition, you can specify a list of one or more
values. IN is supported for STATUS and TYPE. An operation must match one
of the specified values to be returned in the response.
BETWEEN: Specify a start date and an end date in Unix date/time format and Coordinated Universal
Time (UTC). The start date must be the first value. BETWEEN is supported for
UPDATE_DATE.
String id
The ID for an operation.
String status
The status of the operation. Values include the following:
SUBMITTED: This is the initial state immediately after you submit a request.
PENDING: AWS Cloud Map is performing the operation.
SUCCESS: The operation succeeded.
FAIL: The operation failed. For the failure reason, see ErrorMessage.
String serviceId
The ID of the service that you want to use for settings for the instance.
String instanceId
An identifier that you want to associate with the instance. Note the following:
If the service that is specified by ServiceId includes settings for an SRV record, the value of
InstanceId is automatically included as part of the value for the SRV record. For more information,
see
DnsRecord > Type.
You can use this value to update an existing instance.
To register a new instance, you must specify a value that is unique among instances that you register by using the same service.
If you specify an existing InstanceId and ServiceId, AWS Cloud Map updates the existing
DNS records, if any. If there's also an existing health check, AWS Cloud Map deletes the old health check and
creates a new one.
The health check isn't deleted immediately, so it will still appear for a while if you submit a
ListHealthChecks request, for example.
String creatorRequestId
A unique string that identifies the request and that allows failed RegisterInstance requests to be
retried without the risk of executing the operation twice. You must use a unique CreatorRequestId
string every time you submit a RegisterInstance request if you're registering additional instances
for the same namespace and service. CreatorRequestId can be any unique string, for example, a
date/time stamp.
Map<K,V> attributes
A string map that contains the following information for the service that you specify in ServiceId:
The attributes that apply to the records that are defined in the service.
For each attribute, the applicable value.
Supported attribute keys include the following:
AWS_ALIAS_DNS_NAME
If you want AWS Cloud Map to create an Amazon Route 53 alias record that routes traffic to an Elastic Load Balancing load balancer, specify the DNS name that is associated with the load balancer. For information about how to get the DNS name, see "DNSName" in the topic AliasTarget in the Route 53 API Reference.
Note the following:
The configuration for the service that is specified by ServiceId must include settings for an A
record, an AAAA record, or both.
In the service that is specified by ServiceId, the value of RoutingPolicy must be
WEIGHTED.
If the service that is specified by ServiceId includes HealthCheckConfig settings, AWS
Cloud Map will create the Route 53 health check, but it won't associate the health check with the alias record.
Auto naming currently doesn't support creating alias records that route traffic to AWS resources other than ELB load balancers.
If you specify a value for AWS_ALIAS_DNS_NAME, don't specify values for any of the
AWS_INSTANCE attributes.
AWS_INIT_HEALTH_STATUS
If the service configuration includes HealthCheckCustomConfig, you can optionally use
AWS_INIT_HEALTH_STATUS to specify the initial status of the custom health check,
HEALTHY or UNHEALTHY. If you don't specify a value for
AWS_INIT_HEALTH_STATUS, the initial status is HEALTHY.
AWS_INSTANCE_CNAME
If the service configuration includes a CNAME record, the domain name that you want Route 53 to return in
response to DNS queries, for example, example.com.
This value is required if the service specified by ServiceId includes settings for an CNAME record.
AWS_INSTANCE_IPV4
If the service configuration includes an A record, the IPv4 address that you want Route 53 to return in response
to DNS queries, for example, 192.0.2.44.
This value is required if the service specified by ServiceId includes settings for an A record. If
the service includes settings for an SRV record, you must specify a value for AWS_INSTANCE_IPV4,
AWS_INSTANCE_IPV6, or both.
AWS_INSTANCE_IPV6
If the service configuration includes an AAAA record, the IPv6 address that you want Route 53 to return in
response to DNS queries, for example, 2001:0db8:85a3:0000:0000:abcd:0001:2345.
This value is required if the service specified by ServiceId includes settings for an AAAA record.
If the service includes settings for an SRV record, you must specify a value for AWS_INSTANCE_IPV4,
AWS_INSTANCE_IPV6, or both.
AWS_INSTANCE_PORT
If the service includes an SRV record, the value that you want Route 53 to return for the port.
If the service includes HealthCheckConfig, the port on the endpoint that you want Route 53 to send
requests to.
This value is required if you specified settings for an SRV record or a Route 53 health check when you created the service.
Custom attributes
You can add up to 30 custom attributes. For each key-value pair, the maximum length of the attribute name is 255 characters, and the maximum length of the attribute value is 1,024 characters. Total size of all provided attributes (sum of all keys and values) must not exceed 5,000 characters.
String operationId
A value that you can use to determine whether the request completed successfully. To get the status of the operation, see GetOperation.
String id
The ID that AWS Cloud Map assigned to the service when you created it.
String arn
The Amazon Resource Name (ARN) that AWS Cloud Map assigns to the service when you create it.
String name
The name of the service.
String namespaceId
The ID of the namespace that was used to create the service.
String description
The description of the service.
Integer instanceCount
The number of instances that are currently associated with the service. Instances that were previously associated with the service but that have been deleted are not included in the count. The count might not reflect pending registrations and deregistrations.
DnsConfig 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.
HealthCheckConfig 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.
HealthCheckCustomConfig healthCheckCustomConfig
A complex type that contains information about an optional custom health check.
If you specify a health check configuration, you can specify either HealthCheckCustomConfig or
HealthCheckConfig but not both.
Date 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.
String creatorRequestId
A unique string that identifies the request and that allows failed requests to be retried without the risk of
executing the operation twice. CreatorRequestId can be any unique string, for example, a date/time
stamp.
String description
A description for the service.
DnsConfigChange 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.
HealthCheckConfig healthCheckConfig
String name
Specify NAMESPACE_ID.
List<E> values
The values that are applicable to the value that you specify for Condition to filter the list of
services.
String condition
The operator that you want to use to determine whether a service is returned by ListServices. Valid
values for Condition include the following:
EQ: When you specify EQ, specify one namespace ID for Values.
EQ is the default condition and can be omitted.
IN: When you specify IN, specify a list of the IDs for the namespaces that you want
ListServices to return a list of services for.
BETWEEN: Not applicable.
String id
The ID that AWS Cloud Map assigned to the service when you created it.
String arn
The Amazon Resource Name (ARN) that AWS Cloud Map assigns to the service when you create it.
String name
The name of the service.
String description
The description that you specify when you create the service.
Integer instanceCount
The number of instances that are currently associated with the service. Instances that were previously associated with the service but that have been deleted are not included in the count. The count might not reflect pending registrations and deregistrations.
DnsConfig dnsConfig
HealthCheckConfig healthCheckConfig
HealthCheckCustomConfig healthCheckCustomConfig
Date createDate
The date and time that the service was created.
String resourceARN
The Amazon Resource Name (ARN) of the resource that you want to retrieve tags for.
List<E> tags
The tags to add to the specified resource. Specifying the tag key is required. You can set the value of a tag to an empty string, but you can't set the value of a tag to null.
String resourceName
The name of the resource.
String serviceId
The ID of the service that includes the configuration for the custom health check that you want to change the status for.
String instanceId
The ID of the instance that you want to change the health status for.
String status
The new status of the instance, HEALTHY or UNHEALTHY.
String id
The ID of the service that you want to update.
ServiceChange service
A complex type that contains the new settings for the service.
String operationId
A value that you can use to determine whether the request completed successfully. To get the status of the operation, see GetOperation.
Copyright © 2020. All rights reserved.