Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

Note: You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . route53resolver ]

create-resolver-rule

Description

For DNS queries that originate in your VPCs, specifies which resolver endpoint the queries pass through, one domain name that you want to forward to your network, and the IP addresses of the DNS resolvers in your network.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  create-resolver-rule
--creator-request-id <value>
[--name <value>]
--rule-type <value>
--domain-name <value>
[--target-ips <value>]
[--resolver-endpoint-id <value>]
[--tags <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--creator-request-id (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.

--name (string)

A friendly name that lets you easily find a rule in the Resolver dashboard in the Route 53 console.

--rule-type (string)

Specify FORWARD . Other resolver rule types aren't supported.

Possible values:

  • FORWARD
  • SYSTEM
  • RECURSIVE

--domain-name (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).

--target-ips (list)

The IPs that you want Resolver to forward DNS queries to. You can specify only IPv4 addresses. Separate IP addresses with a comma.

(structure)

In a CreateResolverRule request, an array of the IPs that you want to forward DNS queries to.

Ip -> (string)

One IP address that you want to forward DNS queries to. You can specify only IPv4 addresses.

Port -> (integer)

The port at Ip that you want to forward DNS queries to.

Shorthand Syntax:

Ip=string,Port=integer ...

JSON Syntax:

[
  {
    "Ip": "string",
    "Port": integer
  }
  ...
]

--resolver-endpoint-id (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 .

--tags (list)

A list of the tag keys and values that you want to associate with the endpoint.

(structure)

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 .

Key -> (string)

The name for the tag. For example, if you want to associate Resolver resources with the account IDs of your customers for billing purposes, the value of Key might be account-id .

Value -> (string)

The value for the tag. For example, if Key is account-id , then Value might be the ID of the customer account that you're creating the resource for.

Shorthand Syntax:

Key=string,Value=string ...

JSON Syntax:

[
  {
    "Key": "string",
    "Value": "string"
  }
  ...
]

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.

Examples

To create a Resolver rule

The following create-resolver-rule example creates a Resolver forwarding rule. The rule uses the outbound endpoint rslvr-out-d5e5920e37example to forward DNS queries for example.com to the IP address 192.0.2.44.

aws route53resolver create-resolver-rule \
    --creator-request-id 2020-01-02-18:47 \
    --domain-name example.com \
    --name my-rule \
    --resolver-endpoint-id rslvr-out-d5e5920e37example \
    --rule-type FORWARD \
    --target-ips="Ip=192.0.2.44"

Output:

{
    "ResolverRule": {
        "Id": "rslvr-rr-42b60677c0example",
        "CreatorRequestId": "2020-01-02-18:47",
        "Arn": "arn:aws:route53resolver:us-west-2:111122223333:resolver-rule/rslvr-rr-42b60677c0example",
        "DomainName": "example.com.",
        "Status": "COMPLETE",
        "StatusMessage": "[Trace id: 1-5dc4b177-ff1d9d001a0f80005example] Successfully created Resolver Rule.",
        "RuleType": "FORWARD",
        "Name": "my-rule",
        "TargetIps": [
            {
                "Ip": "192.0.2.44",
                "Port": 53
            }
        ],
        "ResolverEndpointId": "rslvr-out-d5e5920e37example",
        "OwnerId": "111122223333",
        "ShareStatus": "NOT_SHARED"
    }
}

Alternatively, when you have complicated parameters with multiple values, you can choose to include the parameters in a JSON file and then specify the file when you call create-resolver-rule. Here's the command, which includes a parameter that specifies the name and location of the JSON file.

aws route53resolver create-resolver-rule \
    --cli-input-json file://c:\temp\create-resolver-rule.json

Contents of create-resolver-rule.json:

{
    "CreatorRequestId": "2020-01-02-18:47",
    "Name": "my-rule",
    "RuleType": "FORWARD",
    "DomainName": "example.com",
    "TargetIps": [
        {
            "Ip": "192.0.2.44",
            "Port": 53
        }
    ],
    "ResolverEndpointId": "rslvr-out-d5e5920e37example",
    "Tags": [
        {
            "Key": "my-key",
            "Value": "my-value"
        }
    ]
}

For more information about rules, see Managing Forwarding Rules in the Amazon Route 53 Developer Guide.

Output

ResolverRule -> (structure)

Information about the CreateResolverRule request, including the status of the request.

Id -> (string)

The ID that Resolver assigned to the resolver rule when you created it.

CreatorRequestId -> (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 executing the operation twice.

Arn -> (string)

The ARN (Amazon Resource Name) for the resolver rule specified by Id .

DomainName -> (string)

DNS queries for this domain name are forwarded to the IP addresses that are specified in TargetIps . If a query matches multiple resolver rules (example.com and www.example.com), the query is routed using the resolver rule that contains the most specific domain name (www.example.com).

Status -> (string)

A code that specifies the current status of the resolver rule.

StatusMessage -> (string)

A detailed description of the status of a resolver rule.

RuleType -> (string)

This value is always FORWARD . Other resolver rule types aren't supported.

Name -> (string)

The name for the resolver rule, which you specified when you created the resolver rule.

TargetIps -> (list)

An array that contains the IP addresses and ports that you want to forward

(structure)

In a CreateResolverRule request, an array of the IPs that you want to forward DNS queries to.

Ip -> (string)

One IP address that you want to forward DNS queries to. You can specify only IPv4 addresses.

Port -> (integer)

The port at Ip that you want to forward DNS queries to.

ResolverEndpointId -> (string)

The ID of the endpoint that the rule is associated with.

OwnerId -> (string)

When a rule is shared with another AWS account, the account ID of the account that the rule is shared with.

ShareStatus -> (string)

Whether the rules 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.