Amazon Route 53 Auto Naming 2017-03-14

This page describes the parameters and results for the operations of the
Amazon Route 53 Auto Naming (2017-03-14), and shows how to use the Aws\ServiceDiscovery\ServiceDiscoveryClient
object to call the described operations. This documentation is specific to the
2017-03-14 API version of the service.

Operation Summary

Each of the following operations can be created from a client using
$client->getCommand('CommandName'), where "CommandName" is the
name of one of the following operations. Note: a command is a value that
encapsulates an operation and the parameters used to create an HTTP request.

You can also create and send a command immediately using the magic methods
available on a client object: $client->commandName(/* parameters */).
You can send the command asynchronously (returning a promise) by appending the
word "Async" to the operation name: $client->commandNameAsync(/* parameters */).

Creates a service, which defines the configuration for the following entities: Up to three records (A, AAAA, and SRV) or one CNAME record Optionally, a health check After you create the service, you can submit a RegisterInstance request, and Amazon Route 53 uses the values in the configuration to create the specified entities.

Submits a request to perform the following operations: Add or delete DnsRecords configurations Update the TTL setting for existing DnsRecords configurations Add, update, or delete HealthCheckConfig for a specified service You must specify all DnsRecords configurations (and, optionally, HealthCheckConfig) that you want to appear in the updated service.

Paginators

Paginators handle automatically iterating over paginated API results. Paginators
are associated with specific API operations, and they accept the parameters
that the corresponding API operation accepts. You can get a paginator from a
client class using
getPaginator($paginatorName, $operationParameters). This client supports
the following paginators:

Operations

CreatePrivateDnsNamespace

Creates a private namespace based on DNS, which will be visible only inside a specified Amazon VPC. The namespace defines your service naming scheme. For example, if you name your namespace example.com and name your service backend, the resulting DNS name for the service will be backend.example.com. For the current limit on the number of namespaces that you can create using the same AWS account, see Limits on Auto Naming in the Route 53 Developer Guide.

Parameter Syntax

Parameter Details

Members

CreatorRequestId

Type: string

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.

Description

Type: string

A description for the namespace.

Name

Type: string

The name that you want to assign to this namespace. When you create a namespace, Amazon Route 53 automatically creates a hosted zone that has the same name as the namespace.

Vpc

Type: string

The ID of the Amazon VPC that you want to associate the namespace with.

Result Syntax

[
'OperationId' => '<string>',
]

Result Details

Members

OperationId

Type: string

A value that you can use to determine whether the request completed successfully. To get the status of the operation, see GetOperation.

Errors

InvalidInput:

One or more specified values aren't valid. For example, when you're creating a namespace, the value of Name might not be a valid DNS name.

NamespaceAlreadyExists:

The namespace that you're trying to create already exists.

ResourceLimitExceeded:

The resource can't be created because you've reached the limit on the number of resources.

DuplicateRequest:

The operation is already in progress.

CreatePublicDnsNamespace

Creates a public namespace based on DNS, which will be visible on the internet. The namespace defines your service naming scheme. For example, if you name your namespace example.com and name your service backend, the resulting DNS name for the service will be backend.example.com. For the current limit on the number of namespaces that you can create using the same AWS account, see Limits on Auto Naming in the Route 53 Developer Guide.

Parameter Syntax

Parameter Details

Members

CreatorRequestId

Type: string

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.

Description

Type: string

A description for the namespace.

Name

Type: string

The name that you want to assign to this namespace.

Result Syntax

[
'OperationId' => '<string>',
]

Result Details

Members

OperationId

Type: string

A value that you can use to determine whether the request completed successfully. To get the status of the operation, see GetOperation.

Errors

InvalidInput:

One or more specified values aren't valid. For example, when you're creating a namespace, the value of Name might not be a valid DNS name.

NamespaceAlreadyExists:

The namespace that you're trying to create already exists.

ResourceLimitExceeded:

The resource can't be created because you've reached the limit on the number of resources.

Parameter Details

Members

CreatorRequestId

Type: string

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.

Public DNS namespaces only. A complex type that contains settings for an optional health check. If you specify settings for a health check, Route 53 associates the health check with all the records that you specify in DnsConfig.

Parameter Details

Members

An array that contains the IDs of all the instances that you want to get the health status for.

If you omit Instances, Amazon Route 53 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.

MaxResults

Type: int

The maximum number of instances that you want Route 53 to return in the response to a GetInstancesHealthStatus request. If you don't specify a value for MaxResults, Route 53 returns up to 100 instances.

NextToken

Type: string

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.

ServiceId

Type: string

The ID of the service that the instance is associated with.

Result Syntax

[
'NextToken' => '<string>',
'Status' => ['<string>', ...],
]

Result Details

Members

NextToken

Type: string

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.

Parameter Syntax

Parameter Details

Members

The maximum number of instances that you want Amazon Route 53 to return in the response to a ListInstances request. If you don't specify a value for MaxResults, Route 53 returns up to 100 instances.

NextToken

Type: string

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.

Result Syntax

Result Details

Members

Summary information about the instances that are associated with the specified service.

NextToken

Type: string

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.

Errors

ServiceNotFound:

No service exists with the specified ID.

InvalidInput:

One or more specified values aren't valid. For example, when you're creating a namespace, the value of Name might not be a valid DNS name.

Parameter Details

Members

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.

MaxResults

Type: int

The maximum number of namespaces that you want Amazon Route 53 to return in the response to a ListNamespaces request. If you don't specify a value for MaxResults, Route 53 returns up to 100 namespaces.

NextToken

Type: string

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.

Route 53 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.

Result Details

Members

An array that contains one NamespaceSummary object for each namespace that matches the specified filter criteria.

NextToken

Type: string

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.

Route 53 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.

Errors

InvalidInput:

One or more specified values aren't valid. For example, when you're creating a namespace, the value of Name might not be a valid DNS name.

Parameter Details

Members

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.

MaxResults

Type: int

The maximum number of items that you want Amazon Route 53 to return in the response to a ListOperations request. If you don't specify a value for MaxResults, Route 53 returns up to 100 operations.

NextToken

Type: string

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.

Route 53 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.

Result Syntax

Result Details

Members

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.

Route 53 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.

Parameter Details

Members

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.

MaxResults

Type: int

The maximum number of services that you want Amazon Route 53 to return in the response to a ListServices request. If you don't specify a value for MaxResults, Route 53 returns up to 100 services.

NextToken

Type: string

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.

Route 53 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.

Result Details

Members

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.

Route 53 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.

Parameter Details

Members

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 Route 53 to create an 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, Route 53 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 when you created the service.

CreatorRequestId

Type: string

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.

InstanceId

Type: string

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, Route 53 updates the existing records. If there's also an existing health check, Route 53 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.

ServiceId

Type: string

The ID of the service that you want to use for settings for the records and health check that Route 53 will create.

Result Syntax

[
'OperationId' => '<string>',
]

Result Details

Members

OperationId

Type: string

A value that you can use to determine whether the request completed successfully. To get the status of the operation, see GetOperation.

Errors

DuplicateRequest:

The operation is already in progress.

InvalidInput:

One or more specified values aren't valid. For example, when you're creating a namespace, the value of Name might not be a valid DNS name.

ResourceInUse:

The specified resource can't be deleted because it contains other resources. For example, you can't delete a service that contains any instances.

ResourceLimitExceeded:

The resource can't be created because you've reached the limit on the number of resources.

You must specify all DnsRecords configurations (and, optionally, HealthCheckConfig) that you want to appear in the updated service. Any current configurations that don't appear in an UpdateService request are deleted.

When you update the TTL setting for a service, Amazon Route 53 also updates the corresponding settings in all the records and health checks that were created by using the specified service.

DnsConfig

Description

Members

An array that contains one DnsRecord object for each record that you want Route 53 to create when you register an instance.

NamespaceId

Type: string

The ID of the namespace to use for DNS configuration.

RoutingPolicy

Type: string

The routing policy that you want to apply to all records that Route 53 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.

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.

DnsConfigChange

Description

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

Members

An array that contains one DnsRecord object for each record that you want Route 53 to create when you register an instance.

DnsProperties

Description

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

Members

HostedZoneId

Type: string

The ID for the hosted zone that Route 53 creates when you create a namespace.

DnsRecord

Description

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

Members

TTL

Type: long (int|float)

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.

Type

Type: string

The type of the resource, which indicates the type of value that Route 53 returns in response to DNS queries.

Note the following:

A, AAAA, and SRV records: You can specify settings for a maximum of one A, one AAAA, and one SRV record. You can specify them in any combination.

CNAME records: If you specify CNAME for Type, you can't define any other records. This is a limitation of DNS—you can't create a CNAME record and any other type of record that has the same name as a CNAME record.

Alias records: If you want Route 53 to create an alias record when you register an instance, specify A or AAAA for Type.

All records: You specify settings other than TTL and Type when you register an instance.

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 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 and if you specify values for AWS_INSTANCE_IPV4, AWS_INSTANCE_IPV6, or both in the RegisterInstance request, Route 53 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.

DuplicateRequest

Description

The operation is already in progress.

Members

Message

Type: string

HealthCheckConfig

Description

Public DNS namespaces only. A complex type that contains settings for an optional health check. If you specify settings for a health check, Amazon Route 53 associates the health check with all the records that you specify in DnsConfig.

A and AAAA records

If DnsConfig includes configurations for both A and AAAA records, Route 53 creates a health check that uses the IPv4 address to check the health of the resource. If the endpoint that is 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

The health check uses 30 seconds as the request interval. This is the number of seconds between the time that each Route 53 health checker gets a response from your endpoint and the time that it sends the next health check request. A health checker in each data center around the world sends your endpoint a health check request every 30 seconds. On average, your endpoint receives a health check request about every two seconds. Health checkers in different data centers don't coordinate with one another, so you'll sometimes see several requests per second 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, Route 53 creates an 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 AWS 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.

Members

FailureThreshold

Type: int

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.

ResourcePath

Type: string

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 and a leading forward slash (/) character.

Type

Type: string

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.

HealthCheckCustomConfig

Members

Instance

Description

A complex type that contains information about an instance that Amazon Route 53 creates when you submit a RegisterInstance request.

Members

Attributes

Type: Associative array of custom strings keys (AttrKey) to strings

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 Route 53 to create an 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, Route 53 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 when you created the service.

CreatorRequestId

Type: string

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.

Id

Type: string

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, Route 53 updates the existing records. If there's also an existing health check, Route 53 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.

InstanceNotFound

Description

No instance exists with the specified ID, or the instance was recently registered, and information about the instance hasn't propagated yet.

Members

Message

Type: string

InstanceSummary

Description

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

Members

Attributes

Type: Associative array of custom strings keys (AttrKey) to strings

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.

Id

Type: string

The ID for an instance that you created by using a specified service.

InvalidInput

Description

One or more specified values aren't valid. For example, when you're creating a namespace, the value of Name might not be a valid DNS name.

Members

Message

Type: string

Namespace

Description

A complex type that contains information about a specified namespace.

Members

Arn

Type: string

The Amazon Resource Name (ARN) that Route 53 assigns to the namespace when you create it.

CreateDate

Type: timestamp (string|DateTime or anything parsable by strtotime)

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.

CreatorRequestId

Type: string

A unique string that identifies the request and that allows failed requests to be retried without the risk of executing an operation twice.

Description

Type: string

The description that you specify for the namespace when you create it.

Members

NamespaceProperties

Description

Members

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

NamespaceSummary

Description

A complex type that contains information about a namespace.

Members

Arn

Type: string

The Amazon Resource Name (ARN) that Route 53 assigns to the namespace when you create it.

Id

Type: string

The ID of the namespace.

Name

Type: string

The name of the namespace. When you create a namespace, Route 53 automatically creates a hosted zone that has the same name as the namespace.

Type

Type: string

The type of the namespace, either public or private.

Operation

Description

A complex type that contains information about a specified operation.

Members

CreateDate

Type: timestamp (string|DateTime or anything parsable by strtotime)

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.

ErrorCode

Type: string

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

ErrorMessage

Type: string

If the value of Status is FAIL, the reason that the operation failed.

Id

Type: string

The ID of the operation that you want to get information about.

Status

Type: string

The status of the operation. Values include the following:

SUBMITTED: This is the initial state immediately after you submit a request.

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.

OperationFilter

Description

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

Members

Condition

Type: string

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.

Name

Type: string

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.

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.

OperationNotFound

Description

No operation exists with the specified ID.

Members

Message

Type: string

OperationSummary

Description

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

Members

Id

Type: string

The ID for an operation.

Status

Type: string

The status of the operation. Values include the following:

SUBMITTED: This is the initial state immediately after you submit a request.

PENDING: Route 53 is performing the operation.

SUCCESS: The operation succeeded.

FAIL: The operation failed. For the failure reason, see ErrorMessage.

ResourceInUse

Description

The specified resource can't be deleted because it contains other resources. For example, you can't delete a service that contains any instances.

Members

Message

Type: string

ResourceLimitExceeded

Description

The resource can't be created because you've reached the limit on the number of resources.

Members

Message

Type: string

Service

Description

A complex type that contains information about the specified service.

Members

Arn

Type: string

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

CreateDate

Type: timestamp (string|DateTime or anything parsable by strtotime)

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.

CreatorRequestId

Type: string

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.

Public DNS namespaces only. A complex type that contains settings for an optional health check. If you specify settings for a health check, Route 53 associates the health check with all the records that you specify in DnsConfig.

Public DNS namespaces only. A complex type that contains settings for an optional health check. If you specify settings for a health check, Amazon Route 53 associates the health check with all the records that you specify in DnsConfig.

A and AAAA records

If DnsConfig includes configurations for both A and AAAA records, Route 53 creates a health check that uses the IPv4 address to check the health of the resource. If the endpoint that is 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

The health check uses 30 seconds as the request interval. This is the number of seconds between the time that each Route 53 health checker gets a response from your endpoint and the time that it sends the next health check request. A health checker in each data center around the world sends your endpoint a health check request every 30 seconds. On average, your endpoint receives a health check request about every two seconds. Health checkers in different data centers don't coordinate with one another, so you'll sometimes see several requests per second 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, Route 53 creates an 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 AWS 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.