Amazon Route 53
API Reference

The AWS Documentation website is getting a new look!
Try it now and let us know what you think. Switch to the new look >>

You can return to the original look by selecting English in the language selector above.

ResolverEndpoint

In the response to a CreateResolverEndpoint, DeleteResolverEndpoint, GetResolverEndpoint, ListResolverEndpoints, or UpdateResolverEndpoint request, a complex type that contains settings for an existing inbound or outbound resolver endpoint.

Contents

Arn

The ARN (Amazon Resource Name) for the resolver endpoint.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Required: No

CreationTime

The date and time that the endpoint was created, in Unix time format and Coordinated Universal Time (UTC).

Type: String

Length Constraints: Minimum length of 20. Maximum length of 40.

Required: No

CreatorRequestId

A unique string that identifies the request that created the resolver endpoint. The CreatorRequestId allows failed requests to be retried without the risk of executing the operation twice.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Required: No

Direction

Indicates whether the resolver endpoint allows inbound or outbound DNS queries:

  • INBOUND: allows DNS queries to your VPC from your network or another VPC

  • OUTBOUND: allows DNS queries from your VPC to your network or another VPC

Type: String

Valid Values: INBOUND | OUTBOUND

Required: No

HostVPCId

The ID of the VPC that you want to create the resolver endpoint in.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Required: No

Id

The ID of the resolver endpoint.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Required: No

IpAddressCount

The number of IP addresses that the resolver endpoint can use for DNS queries.

Type: Integer

Required: No

ModificationTime

The date and time that the endpoint was last modified, in Unix time format and Coordinated Universal Time (UTC).

Type: String

Length Constraints: Minimum length of 20. Maximum length of 40.

Required: No

Name

The name that you assigned to the resolver endpoint when you submitted a CreateResolverEndpoint request.

Type: String

Length Constraints: Maximum length of 64.

Pattern: (?!^[0-9]+$)([a-zA-Z0-9-_' ']+)

Required: No

SecurityGroupIds

The ID of one or more security groups that control access to this VPC. The security group must include one or more inbound rules (for inbound endpoints) or outbound rules (for outbound endpoints). Inbound and outbound rules must allow TCP and UDP access. For inbound access, open port 53. For outbound access, open the port that you're using for DNS queries on your network.

Type: Array of strings

Length Constraints: Minimum length of 1. Maximum length of 64.

Required: No

Status

A code that specifies the current status of the resolver endpoint. Valid values include the following:

  • CREATING: Resolver is creating and configuring one or more Amazon VPC network interfaces for this endpoint.

  • OPERATIONAL: The Amazon VPC network interfaces for this endpoint are correctly configured and able to pass inbound or outbound DNS queries between your network and Resolver.

  • UPDATING: Resolver is associating or disassociating one or more network interfaces with this endpoint.

  • AUTO_RECOVERING: Resolver is trying to recover one or more of the network interfaces that are associated with this endpoint. During the recovery process, the endpoint functions with limited capacity because of the limit on the number of DNS queries per IP address (per network interface). For the current limit, see Limits on Route 53 Resolver.

  • ACTION_NEEDED: This endpoint is unhealthy, and Resolver can't automatically recover it. To resolve the problem, we recommend that you check each IP address that you associated with the endpoint. For each IP address that isn't available, add another IP address and then delete the IP address that isn't available. (An endpoint must always include at least two IP addresses.) A status of ACTION_NEEDED can have a variety of causes. Here are two common causes:

    • One or more of the network interfaces that are associated with the endpoint were deleted using Amazon VPC.

    • The network interface couldn't be created for some reason that's outside the control of Resolver.

  • DELETING: Resolver is deleting this endpoint and the associated network interfaces.

Type: String

Valid Values: CREATING | OPERATIONAL | UPDATING | AUTO_RECOVERING | ACTION_NEEDED | DELETING

Required: No

StatusMessage

A detailed description of the status of the resolver endpoint.

Type: String

Length Constraints: Maximum length of 255.

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following:

On this page: