Welcome to Pulumi Registry, your window into the cloud. Read the announcement.

AWS Classic

v4.30.0 published on Tuesday, Nov 30, 2021 by Pulumi

ResolverRule

Provides a Route53 Resolver rule.

Example Usage

System rule

using Pulumi;
using Aws = Pulumi.Aws;

class MyStack : Stack
{
    public MyStack()
    {
        var sys = new Aws.Route53.ResolverRule("sys", new Aws.Route53.ResolverRuleArgs
        {
            DomainName = "subdomain.example.com",
            RuleType = "SYSTEM",
        });
    }

}
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v4/go/aws/route53"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := route53.NewResolverRule(ctx, "sys", &route53.ResolverRuleArgs{
			DomainName: pulumi.String("subdomain.example.com"),
			RuleType:   pulumi.String("SYSTEM"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
import pulumi
import pulumi_aws as aws

sys = aws.route53.ResolverRule("sys",
    domain_name="subdomain.example.com",
    rule_type="SYSTEM")
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const sys = new aws.route53.ResolverRule("sys", {
    domainName: "subdomain.example.com",
    ruleType: "SYSTEM",
});

Forward rule

using Pulumi;
using Aws = Pulumi.Aws;

class MyStack : Stack
{
    public MyStack()
    {
        var fwd = new Aws.Route53.ResolverRule("fwd", new Aws.Route53.ResolverRuleArgs
        {
            DomainName = "example.com",
            RuleType = "FORWARD",
            ResolverEndpointId = aws_route53_resolver_endpoint.Foo.Id,
            TargetIps = 
            {
                new Aws.Route53.Inputs.ResolverRuleTargetIpArgs
                {
                    Ip = "123.45.67.89",
                },
            },
            Tags = 
            {
                { "Environment", "Prod" },
            },
        });
    }

}
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v4/go/aws/route53"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := route53.NewResolverRule(ctx, "fwd", &route53.ResolverRuleArgs{
			DomainName:         pulumi.String("example.com"),
			RuleType:           pulumi.String("FORWARD"),
			ResolverEndpointId: pulumi.Any(aws_route53_resolver_endpoint.Foo.Id),
			TargetIps: route53.ResolverRuleTargetIpArray{
				&route53.ResolverRuleTargetIpArgs{
					Ip: pulumi.String("123.45.67.89"),
				},
			},
			Tags: pulumi.StringMap{
				"Environment": pulumi.String("Prod"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
import pulumi
import pulumi_aws as aws

fwd = aws.route53.ResolverRule("fwd",
    domain_name="example.com",
    rule_type="FORWARD",
    resolver_endpoint_id=aws_route53_resolver_endpoint["foo"]["id"],
    target_ips=[aws.route53.ResolverRuleTargetIpArgs(
        ip="123.45.67.89",
    )],
    tags={
        "Environment": "Prod",
    })
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const fwd = new aws.route53.ResolverRule("fwd", {
    domainName: "example.com",
    ruleType: "FORWARD",
    resolverEndpointId: aws_route53_resolver_endpoint.foo.id,
    targetIps: [{
        ip: "123.45.67.89",
    }],
    tags: {
        Environment: "Prod",
    },
});

Create a ResolverRule Resource

new ResolverRule(name: string, args: ResolverRuleArgs, opts?: CustomResourceOptions);
@overload
def ResolverRule(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 domain_name: Optional[str] = None,
                 name: Optional[str] = None,
                 resolver_endpoint_id: Optional[str] = None,
                 rule_type: Optional[str] = None,
                 tags: Optional[Mapping[str, str]] = None,
                 target_ips: Optional[Sequence[ResolverRuleTargetIpArgs]] = None)
@overload
def ResolverRule(resource_name: str,
                 args: ResolverRuleArgs,
                 opts: Optional[ResourceOptions] = None)
func NewResolverRule(ctx *Context, name string, args ResolverRuleArgs, opts ...ResourceOption) (*ResolverRule, error)
public ResolverRule(string name, ResolverRuleArgs args, CustomResourceOptions? opts = null)
name string
The unique name of the resource.
args ResolverRuleArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name str
The unique name of the resource.
args ResolverRuleArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name string
The unique name of the resource.
args ResolverRuleArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args ResolverRuleArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.

ResolverRule Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

The ResolverRule resource accepts the following input properties:

DomainName string
DNS queries for this domain name are forwarded to the IP addresses that are specified using target_ip.
RuleType string
The rule type. Valid values are FORWARD, SYSTEM and RECURSIVE.
Name string
A friendly name that lets you easily find a rule in the Resolver dashboard in the Route 53 console.
ResolverEndpointId string
The ID of the outbound resolver endpoint that you want to use to route DNS queries to the IP addresses that you specify using target_ip. This argument should only be specified for FORWARD type rules.
Tags Dictionary<string, string>
A map of tags to assign to the resource. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
TargetIps List<ResolverRuleTargetIpArgs>
Configuration block(s) indicating the IPs that you want Resolver to forward DNS queries to (documented below). This argument should only be specified for FORWARD type rules.
DomainName string
DNS queries for this domain name are forwarded to the IP addresses that are specified using target_ip.
RuleType string
The rule type. Valid values are FORWARD, SYSTEM and RECURSIVE.
Name string
A friendly name that lets you easily find a rule in the Resolver dashboard in the Route 53 console.
ResolverEndpointId string
The ID of the outbound resolver endpoint that you want to use to route DNS queries to the IP addresses that you specify using target_ip. This argument should only be specified for FORWARD type rules.
Tags map[string]string
A map of tags to assign to the resource. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
TargetIps []ResolverRuleTargetIpArgs
Configuration block(s) indicating the IPs that you want Resolver to forward DNS queries to (documented below). This argument should only be specified for FORWARD type rules.
domainName string
DNS queries for this domain name are forwarded to the IP addresses that are specified using target_ip.
ruleType string
The rule type. Valid values are FORWARD, SYSTEM and RECURSIVE.
name string
A friendly name that lets you easily find a rule in the Resolver dashboard in the Route 53 console.
resolverEndpointId string
The ID of the outbound resolver endpoint that you want to use to route DNS queries to the IP addresses that you specify using target_ip. This argument should only be specified for FORWARD type rules.
tags {[key: string]: string}
A map of tags to assign to the resource. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
targetIps ResolverRuleTargetIpArgs[]
Configuration block(s) indicating the IPs that you want Resolver to forward DNS queries to (documented below). This argument should only be specified for FORWARD type rules.
domain_name str
DNS queries for this domain name are forwarded to the IP addresses that are specified using target_ip.
rule_type str
The rule type. Valid values are FORWARD, SYSTEM and RECURSIVE.
name str
A friendly name that lets you easily find a rule in the Resolver dashboard in the Route 53 console.
resolver_endpoint_id str
The ID of the outbound resolver endpoint that you want to use to route DNS queries to the IP addresses that you specify using target_ip. This argument should only be specified for FORWARD type rules.
tags Mapping[str, str]
A map of tags to assign to the resource. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
target_ips Sequence[ResolverRuleTargetIpArgs]
Configuration block(s) indicating the IPs that you want Resolver to forward DNS queries to (documented below). This argument should only be specified for FORWARD type rules.

Outputs

All input properties are implicitly available as output properties. Additionally, the ResolverRule resource produces the following output properties:

Arn string
The ARN (Amazon Resource Name) for the resolver rule.
Id string
The provider-assigned unique ID for this managed resource.
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. Values are NOT_SHARED, SHARED_BY_ME or SHARED_WITH_ME
TagsAll Dictionary<string, string>
A map of tags assigned to the resource, including those inherited from the provider .
Arn string
The ARN (Amazon Resource Name) for the resolver rule.
Id string
The provider-assigned unique ID for this managed resource.
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. Values are NOT_SHARED, SHARED_BY_ME or SHARED_WITH_ME
TagsAll map[string]string
A map of tags assigned to the resource, including those inherited from the provider .
arn string
The ARN (Amazon Resource Name) for the resolver rule.
id string
The provider-assigned unique ID for this managed resource.
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. Values are NOT_SHARED, SHARED_BY_ME or SHARED_WITH_ME
tagsAll {[key: string]: string}
A map of tags assigned to the resource, including those inherited from the provider .
arn str
The ARN (Amazon Resource Name) for the resolver rule.
id str
The provider-assigned unique ID for this managed resource.
owner_id str
When a rule is shared with another AWS account, the account ID of the account that the rule is shared with.
share_status str
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. Values are NOT_SHARED, SHARED_BY_ME or SHARED_WITH_ME
tags_all Mapping[str, str]
A map of tags assigned to the resource, including those inherited from the provider .

Look up an Existing ResolverRule Resource

Get an existing ResolverRule resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: ResolverRuleState, opts?: CustomResourceOptions): ResolverRule
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        arn: Optional[str] = None,
        domain_name: Optional[str] = None,
        name: Optional[str] = None,
        owner_id: Optional[str] = None,
        resolver_endpoint_id: Optional[str] = None,
        rule_type: Optional[str] = None,
        share_status: Optional[str] = None,
        tags: Optional[Mapping[str, str]] = None,
        tags_all: Optional[Mapping[str, str]] = None,
        target_ips: Optional[Sequence[ResolverRuleTargetIpArgs]] = None) -> ResolverRule
func GetResolverRule(ctx *Context, name string, id IDInput, state *ResolverRuleState, opts ...ResourceOption) (*ResolverRule, error)
public static ResolverRule Get(string name, Input<string> id, ResolverRuleState? state, CustomResourceOptions? opts = null)
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.

The following state arguments are supported:

Arn string
The ARN (Amazon Resource Name) for the resolver rule.
DomainName string
DNS queries for this domain name are forwarded to the IP addresses that are specified using target_ip.
Name string
A friendly name that lets you easily find a rule in the Resolver dashboard in the Route 53 console.
OwnerId string
When a rule is shared with another AWS account, the account ID of the account that the rule is shared with.
ResolverEndpointId string
The ID of the outbound resolver endpoint that you want to use to route DNS queries to the IP addresses that you specify using target_ip. This argument should only be specified for FORWARD type rules.
RuleType string
The rule type. Valid values are FORWARD, SYSTEM and RECURSIVE.
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. Values are NOT_SHARED, SHARED_BY_ME or SHARED_WITH_ME
Tags Dictionary<string, string>
A map of tags to assign to the resource. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
TagsAll Dictionary<string, string>
A map of tags assigned to the resource, including those inherited from the provider .
TargetIps List<ResolverRuleTargetIpArgs>
Configuration block(s) indicating the IPs that you want Resolver to forward DNS queries to (documented below). This argument should only be specified for FORWARD type rules.
Arn string
The ARN (Amazon Resource Name) for the resolver rule.
DomainName string
DNS queries for this domain name are forwarded to the IP addresses that are specified using target_ip.
Name string
A friendly name that lets you easily find a rule in the Resolver dashboard in the Route 53 console.
OwnerId string
When a rule is shared with another AWS account, the account ID of the account that the rule is shared with.
ResolverEndpointId string
The ID of the outbound resolver endpoint that you want to use to route DNS queries to the IP addresses that you specify using target_ip. This argument should only be specified for FORWARD type rules.
RuleType string
The rule type. Valid values are FORWARD, SYSTEM and RECURSIVE.
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. Values are NOT_SHARED, SHARED_BY_ME or SHARED_WITH_ME
Tags map[string]string
A map of tags to assign to the resource. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
TagsAll map[string]string
A map of tags assigned to the resource, including those inherited from the provider .
TargetIps []ResolverRuleTargetIpArgs
Configuration block(s) indicating the IPs that you want Resolver to forward DNS queries to (documented below). This argument should only be specified for FORWARD type rules.
arn string
The ARN (Amazon Resource Name) for the resolver rule.
domainName string
DNS queries for this domain name are forwarded to the IP addresses that are specified using target_ip.
name string
A friendly name that lets you easily find a rule in the Resolver dashboard in the Route 53 console.
ownerId string
When a rule is shared with another AWS account, the account ID of the account that the rule is shared with.
resolverEndpointId string
The ID of the outbound resolver endpoint that you want to use to route DNS queries to the IP addresses that you specify using target_ip. This argument should only be specified for FORWARD type rules.
ruleType string
The rule type. Valid values are FORWARD, SYSTEM and RECURSIVE.
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. Values are NOT_SHARED, SHARED_BY_ME or SHARED_WITH_ME
tags {[key: string]: string}
A map of tags to assign to the resource. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
tagsAll {[key: string]: string}
A map of tags assigned to the resource, including those inherited from the provider .
targetIps ResolverRuleTargetIpArgs[]
Configuration block(s) indicating the IPs that you want Resolver to forward DNS queries to (documented below). This argument should only be specified for FORWARD type rules.
arn str
The ARN (Amazon Resource Name) for the resolver rule.
domain_name str
DNS queries for this domain name are forwarded to the IP addresses that are specified using target_ip.
name str
A friendly name that lets you easily find a rule in the Resolver dashboard in the Route 53 console.
owner_id str
When a rule is shared with another AWS account, the account ID of the account that the rule is shared with.
resolver_endpoint_id str
The ID of the outbound resolver endpoint that you want to use to route DNS queries to the IP addresses that you specify using target_ip. This argument should only be specified for FORWARD type rules.
rule_type str
The rule type. Valid values are FORWARD, SYSTEM and RECURSIVE.
share_status str
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. Values are NOT_SHARED, SHARED_BY_ME or SHARED_WITH_ME
tags Mapping[str, str]
A map of tags to assign to the resource. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
tags_all Mapping[str, str]
A map of tags assigned to the resource, including those inherited from the provider .
target_ips Sequence[ResolverRuleTargetIpArgs]
Configuration block(s) indicating the IPs that you want Resolver to forward DNS queries to (documented below). This argument should only be specified for FORWARD type rules.

Supporting Types

ResolverRuleTargetIp

Ip string
One IP address that you want to forward DNS queries to. You can specify only IPv4 addresses.
Port int
The port at ip that you want to forward DNS queries to. Default value is 53
Ip string
One IP address that you want to forward DNS queries to. You can specify only IPv4 addresses.
Port int
The port at ip that you want to forward DNS queries to. Default value is 53
ip string
One IP address that you want to forward DNS queries to. You can specify only IPv4 addresses.
port number
The port at ip that you want to forward DNS queries to. Default value is 53
ip str
One IP address that you want to forward DNS queries to. You can specify only IPv4 addresses.
port int
The port at ip that you want to forward DNS queries to. Default value is 53

Import

Route53 Resolver rules can be imported using the id, e.g.,

 $ pulumi import aws:route53/resolverRule:ResolverRule sys rslvr-rr-0123456789abcdef0

Package Details

Repository
https://github.com/pulumi/pulumi-aws
License
Apache-2.0
Notes
This Pulumi package is based on the aws Terraform Provider.