ResolverRule

route53resolver.services.k8s.aws/v1alpha1

TypeLink
GoDocroute53resolver-controller/apis/v1alpha1#ResolverRule

Metadata

PropertyValue
ScopeNamespaced
KindResolverRule
ListKindResolverRuleList
Pluralresolverrules
Singularresolverrule

For queries that originate in your VPC, detailed information about a Resolver rule, which specifies how to route DNS queries out of the VPC. The ResolverRule parameter appears in the response to a CreateResolverRule (https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_CreateResolverRule.html), DeleteResolverRule (https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_DeleteResolverRule.html), GetResolverRule (https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_GetResolverRule.html), ListResolverRules (https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_ListResolverRules.html), or UpdateResolverRule (https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_UpdateResolverRule.html) request.

Spec

associations:
- id: string
  name: string
  resolverRuleID: string
  status: string
  statusMessage: string
  vpcID: string
domainName: string
name: string
resolverEndpointID: string
ruleType: string
tags:
- key: string
  value: string
targetIPs:
- ip: string
  ipv6: string
  port: integer
FieldDescription
associations
Optional
array
associations.[]
Required
object
In the response to an AssociateResolverRule (https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_AssociateResolverRule.html),
DisassociateResolverRule (https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_DisassociateResolverRule.html),
or ListResolverRuleAssociations (https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_ListResolverRuleAssociations.html)
request, provides information about an association between a Resolver rule
and a VPC. The association determines which DNS queries that originate in
the VPC are forwarded to your network.
associations.[].name
Optional
string
associations.[].resolverRuleID
Optional
string
associations.[].status
Optional
string
associations.[].statusMessage
Optional
string
associations.[].vpcID
Optional
string
domainName
Required
string
DNS queries for this domain name are forwarded to the IP addresses that you
specify in TargetIps. If a query matches multiple Resolver rules (example.com
and www.example.com), outbound DNS queries are routed using the Resolver
rule that contains the most specific domain name (www.example.com).
name
Optional
string
A friendly name that lets you easily find a rule in the Resolver dashboard
in the Route 53 console.
resolverEndpointID
Optional
string
The ID of the outbound Resolver endpoint that you want to use to route DNS
queries to the IP addresses that you specify in TargetIps.
ruleType
Required
string
When you want to forward DNS queries for specified domain name to resolvers
on your network, specify FORWARD.


When you have a forwarding rule to forward DNS queries for a domain to your
network and you want Resolver to process queries for a subdomain of that
domain, specify SYSTEM.


For example, to forward DNS queries for example.com to resolvers on your
network, you create a rule and specify FORWARD for RuleType. To then have
Resolver process queries for apex.example.com, you create a rule and specify
SYSTEM for RuleType.


Currently, only Resolver can create rules that have a value of RECURSIVE
for RuleType.
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.[].value
Optional
string
targetIPs
Optional
array
The IPs that you want Resolver to forward DNS queries to. You can specify
only IPv4 addresses. Separate IP addresses with a space.


TargetIps is available only when the value of Rule type is FORWARD.
targetIPs.[]
Required
object
In a CreateResolverRule (https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_CreateResolverRule.html)
request, an array of the IPs that you want to forward DNS queries to.
targetIPs.[].ipv6
Optional
string
targetIPs.[].port
Optional
integer

Status

ackResourceMetadata: 
  arn: string
  ownerAccountID: string
  region: string
conditions:
- lastTransitionTime: string
  message: string
  reason: string
  status: string
  type: string
creationTime: string
creatorRequestID: string
id: string
modificationTime: string
ownerID: string
shareStatus: string
status: string
statusMessage: string
FieldDescription
ackResourceMetadata
Optional
object
All CRs managed by ACK have a common Status.ACKResourceMetadata member
that 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 that
contains a collection of ackv1alpha1.Condition objects that describe
the 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 Resolver rule was created, in Unix time format
and Coordinated Universal Time (UTC).
creatorRequestID
Optional
string
A unique string that you specified when you created the Resolver rule. CreatorRequestId
identifies the request and allows failed requests to be retried without the
risk of running the operation twice.
id
Optional
string
The ID that Resolver assigned to the Resolver rule when you created it.
modificationTime
Optional
string
The date and time that the Resolver rule was last updated, in Unix time format
and Coordinated Universal Time (UTC).
ownerID
Optional
string
When a rule is shared with another Amazon Web Services account, the account
ID of the account that the rule is shared with.
shareStatus
Optional
string
Whether the rule is shared and, if so, whether the current account is sharing
the rule with another account, or another account is sharing the rule with
the current account.
status
Optional
string
A code that specifies the current status of the Resolver rule.
statusMessage
Optional
string
A detailed description of the status of a Resolver rule.