Module types 

Data structures used by operation inputs/outputs.

Modules

builders

Builders

error

Error types that AWS Cloud Map can respond with.

Structs

DnsConfig

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

DnsConfigChange

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

DnsProperties

A complex type that contains the ID for the Route 53 hosted zone that Cloud Map creates when you create a namespace.

DnsRecord

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

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, Cloud Map associates the health check with the records that you specify in DnsConfig.

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

Health checks are basic Route 53 health checks that monitor an Amazon Web Services endpoint. For information about pricing for health checks, see Amazon Route 53 Pricing.

Note the following about configuring health checks.

A and AAAA records

If DnsConfig includes configurations for both A and AAAA records, Cloud Map creates a health check that uses the IPv4 address to check the health of the resource. If the endpoint tthat's specified by the IPv4 address is unhealthy, Route 53 considers both the A and AAAA records to be unhealthy.

CNAME records

You can't specify settings for HealthCheckConfig when the DNSConfig includes CNAME for the value of Type. If you do, the CreateService request will fail with an InvalidInput error.

Request interval

A Route 53 health checker in each health-checking Amazon Web Services Region sends a health check request to an endpoint every 30 seconds. On average, your endpoint receives a health check request about every two seconds. However, health checkers don't coordinate with one another. Therefore, you might sometimes see several requests in one second that's followed by a few seconds with no health checks at all.

Health checking regions

Health checkers perform checks from all Route 53 health-checking Regions. For a list of the current Regions, see Regions.

Alias records

When you register an instance, if you include the AWS_ALIAS_DNS_NAME attribute, Cloud Map creates a Route 53 alias record. Note the following:

• Route 53 automatically sets EvaluateTargetHealth to true for alias records. When EvaluateTargetHealth is true, the alias record inherits the health of the referenced Amazon Web Services resource. such as an ELB load balancer. For more information, see EvaluateTargetHealth.

• If you include HealthCheckConfig and then use the service to register an instance that creates an alias record, Route 53 doesn't create the health check.

Charges for health checks

Health checks are basic Route 53 health checks that monitor an Amazon Web Services endpoint. For information about pricing for health checks, see Amazon Route 53 Pricing.

HealthCheckCustomConfig

A complex type that contains 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.

To change the status of a custom health check, submit an UpdateInstanceCustomHealthStatus request. Cloud Map doesn't monitor the status of the resource, it just keeps a record of the status specified in the most recent UpdateInstanceCustomHealthStatus request.

Here's how custom health checks work:

1. You create a service.

2. You register an instance.

3. You configure a third-party health checker to monitor the resource that's associated with the new instance.

   Cloud Map doesn't check the health of the resource directly.

4. The third-party health-checker determines that the resource is unhealthy and notifies your application.

5. Your application submits an UpdateInstanceCustomHealthStatus request.

6. Cloud Map waits for 30 seconds.

7. If another UpdateInstanceCustomHealthStatus request doesn't arrive during that time to change the status back to healthy, Cloud Map stops routing traffic to the resource.

HttpInstanceSummary

In a response to a DiscoverInstances request, HttpInstanceSummary contains information about one instance that matches the values that you specified in the request.

HttpNamespaceChange

Updated properties for the HTTP namespace.

HttpProperties

A complex type that contains the name of an HTTP namespace.

Instance

A complex type that contains information about an instance that Cloud Map creates when you submit a RegisterInstance request.

InstanceSummary

A complex type that contains information about the instances that you registered by using a specified service.

Namespace

A complex type that contains information about a specified namespace.

NamespaceFilter

A complex type that identifies the namespaces that you want to list. You can choose to list public or private namespaces.

NamespaceProperties

A complex type that contains information that's specific to the namespace type.

NamespaceSummary

A complex type that contains information about a namespace.

Operation

A complex type that contains information about a specified operation.

OperationFilter

A complex type that lets you select the operations that you want to list.

OperationSummary

A complex type that contains information about an operation that matches the criteria that you specified in a ListOperations request.

PrivateDnsNamespaceChange

Updated properties for the private DNS namespace.

PrivateDnsNamespaceProperties

DNS properties for the private DNS namespace.

PrivateDnsNamespacePropertiesChange

Updated properties for the private DNS namespace.

PrivateDnsPropertiesMutable

DNS properties for the private DNS namespace.

PrivateDnsPropertiesMutableChange

Updated DNS properties for the private DNS namespace.

PublicDnsNamespaceChange

Updated properties for the public DNS namespace.

PublicDnsNamespaceProperties

DNS properties for the public DNS namespace.

PublicDnsNamespacePropertiesChange

Updated properties for the public DNS namespace.

PublicDnsPropertiesMutable

DNS properties for the public DNS namespace.

PublicDnsPropertiesMutableChange

Updated DNS properties for the public DNS namespace.

Service

A complex type that contains information about the specified service.

ServiceAttributes

A complex type that contains information about attributes associated with a specific service.

ServiceChange

A complex type that contains changes to an existing service.

ServiceFilter

A complex type that lets you specify the namespaces that you want to list services for.

ServiceSummary

A complex type that contains information about a specified service.

Soa

Start of Authority (SOA) properties for a public or private DNS namespace.

SoaChange

Updated Start of Authority (SOA) properties for a public or private DNS namespace.

Tag

A custom key-value pair that's associated with a resource.

Enums

CustomHealthStatus

When writing a match expression against CustomHealthStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

FilterCondition

When writing a match expression against FilterCondition, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

HealthCheckType

When writing a match expression against HealthCheckType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

HealthStatus

When writing a match expression against HealthStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

HealthStatusFilter

When writing a match expression against HealthStatusFilter, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

NamespaceFilterName

When writing a match expression against NamespaceFilterName, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

NamespaceType

When writing a match expression against NamespaceType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

OperationFilterName

When writing a match expression against OperationFilterName, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

OperationStatus

When writing a match expression against OperationStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

OperationTargetType

When writing a match expression against OperationTargetType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

OperationType

When writing a match expression against OperationType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

RecordType

When writing a match expression against RecordType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

RoutingPolicy

When writing a match expression against RoutingPolicy, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

ServiceFilterName

When writing a match expression against ServiceFilterName, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

ServiceType

When writing a match expression against ServiceType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

ServiceTypeOption

When writing a match expression against ServiceTypeOption, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.