resolver_rules

Creates, updates, deletes or gets a resolver_rule resource or lists resolver_rules in a region

Overview

Name	resolver_rules
Type	Resource
Description	Resource Type definition for AWS::Route53Resolver::ResolverRule
Id	awscc.route53resolver.resolver_rules

Fields

get (all properties)

Name	Datatype	Description
resolver_endpoint_id	string	The ID of the endpoint that the rule is associated with.
domain_name	string	DNS queries for this domain name are forwarded to the IP addresses that are specified in TargetIps
name	string	The name for the Resolver rule
rule_type	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.
delegation_record	string	The name server domain for queries to be delegated to if a query matches the delegation record.
▶tags	array	An array of key-value pairs to apply to this resource.
▶target_ips	array	An array that contains the IP addresses and ports that an outbound endpoint forwards DNS queries to. Typically, these are the IP addresses of DNS resolvers on your network. Specify IPv4 addresses. IPv6 is not supported.
arn	string	The Amazon Resource Name (ARN) of the resolver rule.
resolver_rule_id	string	The ID of the endpoint that the rule is associated with.
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
resolver_rule_id	string	The ID of the endpoint that the rule is associated with.
region	string	AWS region.

For more information, see AWS::Route53Resolver::ResolverRule.

Methods

Name	Resource	Accessible by	Required Params
create_resource	resolver_rules	INSERT	RuleType, region
delete_resource	resolver_rules	DELETE	Identifier, region
update_resource	resolver_rules	UPDATE	Identifier, PatchDocument, region
list_resources	resolver_rules_list_only	SELECT	region
get_resource	resolver_rules	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual resolver_rule.

SELECT
  region,
  resolver_endpoint_id,
  domain_name,
  name,
  rule_type,
  delegation_record,
  tags,
  target_ips,
  arn,
  resolver_rule_id
FROM awscc.route53resolver.resolver_rules
WHERE
  region = 'us-east-1' AND
  Identifier = '{{ resolver_rule_id }}';

list (identifiers only)

Lists all resolver_rules in a region.

SELECT
  region,
  resolver_rule_id
FROM awscc.route53resolver.resolver_rules_list_only
WHERE
  region = 'us-east-1';

INSERT example

Use the following StackQL query and manifest file to create a new resolver_rule resource, using stack-deploy.

Required Properties

/*+ create */
INSERT INTO awscc.route53resolver.resolver_rules (
  RuleType,
  region
)
SELECT
  '{{ rule_type }}',
  '{{ region }}';

All Properties

/*+ create */
INSERT INTO awscc.route53resolver.resolver_rules (
  ResolverEndpointId,
  DomainName,
  Name,
  RuleType,
  DelegationRecord,
  Tags,
  TargetIps,
  region
)
SELECT
  '{{ resolver_endpoint_id }}',
  '{{ domain_name }}',
  '{{ name }}',
  '{{ rule_type }}',
  '{{ delegation_record }}',
  '{{ tags }}',
  '{{ target_ips }}',
  '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: resolver_rule
    props:
      - name: resolver_endpoint_id
        value: '{{ resolver_endpoint_id }}'
      - name: domain_name
        value: '{{ domain_name }}'
      - name: name
        value: '{{ name }}'
      - name: rule_type
        value: '{{ rule_type }}'
      - name: delegation_record
        value: '{{ delegation_record }}'
      - name: tags
        value:
          - key: '{{ key }}'
            value: '{{ value }}'
      - name: target_ips
        value:
          - ip: '{{ ip }}'
            ipv6: '{{ ipv6 }}'
            port: '{{ port }}'
            protocol: '{{ protocol }}'
            server_name_indication: '{{ server_name_indication }}'

UPDATE example

Use the following StackQL query and manifest file to update a resolver_rule resource, using stack-deploy.

/*+ update */
UPDATE awscc.route53resolver.resolver_rules
SET PatchDocument = string('{{ {
    "ResolverEndpointId": resolver_endpoint_id,
    "DomainName": domain_name,
    "Name": name,
    "DelegationRecord": delegation_record,
    "Tags": tags,
    "TargetIps": target_ips
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ resolver_rule_id }}';

DELETE example

/*+ delete */
DELETE FROM awscc.route53resolver.resolver_rules
WHERE
  Identifier = '{{ resolver_rule_id }}' AND
  region = 'us-east-1';

Permissions

To operate on the resolver_rules resource, the following permissions are required:

Create

route53resolver:CreateResolverRule,
route53resolver:GetResolverRule,
route53resolver:ListTagsForResource,
route53resolver:TagResource

Read

route53resolver:GetResolverRule,
route53resolver:ListTagsForResource

Update

route53resolver:UpdateResolverRule,
route53resolver:GetResolverRule,
route53resolver:ListTagsForResource,
route53resolver:TagResource,
route53resolver:UntagResource

Delete

route53resolver:DeleteResolverRule,
route53resolver:GetResolverRule

List

route53resolver:ListResolverRules