ResolverEndpoint
route53resolver.services.k8s.aws/v1alpha1
| Type | Link |
|---|---|
| GoDoc | route53resolver-controller/apis/v1alpha1#ResolverEndpoint |
Metadata
| Property | Value |
|---|---|
| Scope | Namespaced |
| Kind | ResolverEndpoint |
| ListKind | ResolverEndpointList |
| Plural | resolverendpoints |
| Singular | resolverendpoint |
In the response to a CreateResolverEndpoint (https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_CreateResolverEndpoint.html), DeleteResolverEndpoint (https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_DeleteResolverEndpoint.html), GetResolverEndpoint (https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_GetResolverEndpoint.html), Updates the name, or ResolverEndpointType for an endpoint, or UpdateResolverEndpoint (https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_UpdateResolverEndpoint.html) request, a complex type that contains settings for an existing inbound or outbound Resolver endpoint.
Spec
direction: string
ipAddresses:
- ip: string
ipv6: string
subnetID: string
subnetRef:
from:
name: string
name: string
resolverEndpointType: string
securityGroupIDs:
- string
securityGroupRefs:
from:
name: string
tags:
- key: string
value: string
| Field | Description |
|---|---|
| direction Required | string Specify the applicable value: * INBOUND: Resolver forwards DNS queries to the DNS service for a VPC from your network * OUTBOUND: Resolver forwards DNS queries from the DNS service for a VPC to your network |
| ipAddresses Required | array The subnets and IP addresses in your VPC that DNS queries originate from (for outbound endpoints) or that you forward DNS queries to (for inbound endpoints). The subnet ID uniquely identifies a VPC. |
| ipAddresses.[] Required | object In a CreateResolverEndpoint (https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_CreateResolverEndpoint.html) |
| request, the IP address that DNS queries originate from (for outbound endpoints) | |
| or that you forward DNS queries to (for inbound endpoints). IpAddressRequest | |
| also includes the ID of the subnet that contains the IP address. | |
| ipAddresses.[].ipv6 Optional | string |
| ipAddresses.[].subnetID Optional | string |
| ipAddresses.[].subnetRef Optional | object Reference field for SubnetID |
| ipAddresses.[].subnetRef.from Optional | object AWSResourceReference provides all the values necessary to reference another k8s resource for finding the identifier(Id/ARN/Name) |
| ipAddresses.[].subnetRef.from.name Optional | string |
| name Optional | string A friendly name that lets you easily find a configuration in the Resolver dashboard in the Route 53 console. |
| resolverEndpointType Optional | string For the endpoint type you can choose either IPv4, IPv6. or dual-stack. A dual-stack endpoint means that it will resolve via both IPv4 and IPv6. This endpoint type is applied to all IP addresses. |
| securityGroupIDs Optional | array The ID of one or more security groups that you want to use to control access to this VPC. The security group that you specify must include one or more inbound rules (for inbound Resolver endpoints) or outbound rules (for outbound Resolver 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. |
| securityGroupIDs.[] Required | string |
| securityGroupRefs.[] Required | object AWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference |
| type to provide more user friendly syntax for references using ‘from’ field | |
| Ex: | |
| APIIDRef: |
from:
name: my-api || **securityGroupRefs.[].from**<br/>Optional | **object**<br/>AWSResourceReference provides all the values necessary to reference another<br/>k8s resource for finding the identifier(Id/ARN/Name) |
| securityGroupRefs.[].from.name
Optional | string
|
| tags
Optional | array
A list of the tag keys and values that you want to associate with the endpoint. |
| tags.[]
Required | object
One tag that you want to add to the specified resource. A tag consists of
a Key (a name for the tag) and a Value. || tags.[].key
Optional | string
|
| tags.[].value
Optional | string
|
Status
ackResourceMetadata:
arn: string
ownerAccountID: string
region: string
conditions:
- lastTransitionTime: string
message: string
reason: string
status: string
type: string
creationTime: string
creatorRequestID: string
hostVPCID: string
id: string
ipAddressCount: integer
modificationTime: string
status: string
statusMessage: string
| Field | Description |
|---|---|
| ackResourceMetadata Optional | object All CRs managed by ACK have a common Status.ACKResourceMetadata memberthat is used to contain resource sync state, account ownership, constructed ARN for the resource |
| ackResourceMetadata.arn Optional | string ARN is the Amazon Resource Name for the resource. This is a globally-unique identifier and is set only by the ACK service controller once the controller has orchestrated the creation of the resource OR when it has verified that an “adopted” resource (a resource where the ARN annotation was set by the Kubernetes user on the CR) exists and matches the supplied CR’s Spec field values. TODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse https://github.com/aws/aws-controllers-k8s/issues/270 |
| ackResourceMetadata.ownerAccountID Required | string OwnerAccountID is the AWS Account ID of the account that owns the backend AWS service API resource. |
| ackResourceMetadata.region Required | string Region is the AWS region in which the resource exists or will exist. |
| conditions Optional | array All CRS managed by ACK have a common Status.Conditions member thatcontains a collection of ackv1alpha1.Condition objects that describethe various terminal states of the CR and its backend AWS service API resource |
| conditions.[] Required | object Condition is the common struct used by all CRDs managed by ACK service |
| controllers to indicate terminal states of the CR and its backend AWS | |
| service API resource | |
| conditions.[].message Optional | string A human readable message indicating details about the transition. |
| conditions.[].reason Optional | string The reason for the condition’s last transition. |
| conditions.[].status Optional | string Status of the condition, one of True, False, Unknown. |
| conditions.[].type Optional | string Type is the type of the Condition |
| creationTime Optional | string The date and time that the endpoint was created, in Unix time format and Coordinated Universal Time (UTC). |
| creatorRequestID Optional | string A unique string that identifies the request that created the Resolver endpoint. The CreatorRequestId allows failed requests to be retried without the risk of running the operation twice. |
| hostVPCID Optional | string The ID of the VPC that you want to create the Resolver endpoint in. |
| id Optional | string The ID of the Resolver endpoint. |
| ipAddressCount Optional | integer The number of IP addresses that the Resolver endpoint can use for DNS queries. |
| modificationTime Optional | string The date and time that the endpoint was last modified, in Unix time format and Coordinated Universal Time (UTC). |
| status Optional | string 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 (https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/DNSLimitations.html#limits-api-entities-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. |
| statusMessage Optional | string A detailed description of the status of the Resolver endpoint. |