Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS
  3. API Docs
  4. route53
  5. ResolverRule
AWS v6.77.1 published on Friday, Apr 18, 2025 by Pulumi
pulumi/pulumi-aws

aws.route53.ResolverRule

Explore with Pulumi AI

AWS v6.77.1 published on Friday, Apr 18, 2025 by Pulumi
pulumi/pulumi-aws

Provides a Route53 Resolver rule.

Example Usage

System rule

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",
});
Copy
import pulumi
import pulumi_aws as aws

sys = aws.route53.ResolverRule("sys",
    domain_name="subdomain.example.com",
    rule_type="SYSTEM")
Copy
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v6/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
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var sys = new Aws.Route53.ResolverRule("sys", new()
    {
        DomainName = "subdomain.example.com",
        RuleType = "SYSTEM",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.route53.ResolverRule;
import com.pulumi.aws.route53.ResolverRuleArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var sys = new ResolverRule("sys", ResolverRuleArgs.builder()
            .domainName("subdomain.example.com")
            .ruleType("SYSTEM")
            .build());

    }
}
Copy
resources:
  sys:
    type: aws:route53:ResolverRule
    properties:
      domainName: subdomain.example.com
      ruleType: SYSTEM
Copy

Forward rule

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

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

fwd = aws.route53.ResolverRule("fwd",
    domain_name="example.com",
    name="example",
    rule_type="FORWARD",
    resolver_endpoint_id=foo["id"],
    target_ips=[{
        "ip": "123.45.67.89",
    }],
    tags={
        "Environment": "Prod",
    })
Copy
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v6/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"),
			Name:               pulumi.String("example"),
			RuleType:           pulumi.String("FORWARD"),
			ResolverEndpointId: pulumi.Any(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
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var fwd = new Aws.Route53.ResolverRule("fwd", new()
    {
        DomainName = "example.com",
        Name = "example",
        RuleType = "FORWARD",
        ResolverEndpointId = foo.Id,
        TargetIps = new[]
        {
            new Aws.Route53.Inputs.ResolverRuleTargetIpArgs
            {
                Ip = "123.45.67.89",
            },
        },
        Tags = 
        {
            { "Environment", "Prod" },
        },
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.route53.ResolverRule;
import com.pulumi.aws.route53.ResolverRuleArgs;
import com.pulumi.aws.route53.inputs.ResolverRuleTargetIpArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var fwd = new ResolverRule("fwd", ResolverRuleArgs.builder()
            .domainName("example.com")
            .name("example")
            .ruleType("FORWARD")
            .resolverEndpointId(foo.id())
            .targetIps(ResolverRuleTargetIpArgs.builder()
                .ip("123.45.67.89")
                .build())
            .tags(Map.of("Environment", "Prod"))
            .build());

    }
}
Copy
resources:
  fwd:
    type: aws:route53:ResolverRule
    properties:
      domainName: example.com
      name: example
      ruleType: FORWARD
      resolverEndpointId: ${foo.id}
      targetIps:
        - ip: 123.45.67.89
      tags:
        Environment: Prod
Copy

IPv6 Forward rule

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const fwd = new aws.route53.ResolverRule("fwd", {
    domainName: "example.com",
    name: "example",
    ruleType: "FORWARD",
    resolverEndpointId: foo.id,
    targetIps: [{
        ipv6: "2600:1f18:1686:2000:4e60:6e3e:258:da36",
    }],
    tags: {
        Environment: "Prod",
    },
});
Copy
import pulumi
import pulumi_aws as aws

fwd = aws.route53.ResolverRule("fwd",
    domain_name="example.com",
    name="example",
    rule_type="FORWARD",
    resolver_endpoint_id=foo["id"],
    target_ips=[{
        "ipv6": "2600:1f18:1686:2000:4e60:6e3e:258:da36",
    }],
    tags={
        "Environment": "Prod",
    })
Copy
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v6/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"),
			Name:               pulumi.String("example"),
			RuleType:           pulumi.String("FORWARD"),
			ResolverEndpointId: pulumi.Any(foo.Id),
			TargetIps: route53.ResolverRuleTargetIpArray{
				&route53.ResolverRuleTargetIpArgs{
					Ipv6: pulumi.String("2600:1f18:1686:2000:4e60:6e3e:258:da36"),
				},
			},
			Tags: pulumi.StringMap{
				"Environment": pulumi.String("Prod"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var fwd = new Aws.Route53.ResolverRule("fwd", new()
    {
        DomainName = "example.com",
        Name = "example",
        RuleType = "FORWARD",
        ResolverEndpointId = foo.Id,
        TargetIps = new[]
        {
            new Aws.Route53.Inputs.ResolverRuleTargetIpArgs
            {
                Ipv6 = "2600:1f18:1686:2000:4e60:6e3e:258:da36",
            },
        },
        Tags = 
        {
            { "Environment", "Prod" },
        },
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.route53.ResolverRule;
import com.pulumi.aws.route53.ResolverRuleArgs;
import com.pulumi.aws.route53.inputs.ResolverRuleTargetIpArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var fwd = new ResolverRule("fwd", ResolverRuleArgs.builder()
            .domainName("example.com")
            .name("example")
            .ruleType("FORWARD")
            .resolverEndpointId(foo.id())
            .targetIps(ResolverRuleTargetIpArgs.builder()
                .ipv6("2600:1f18:1686:2000:4e60:6e3e:258:da36")
                .build())
            .tags(Map.of("Environment", "Prod"))
            .build());

    }
}
Copy
resources:
  fwd:
    type: aws:route53:ResolverRule
    properties:
      domainName: example.com
      name: example
      ruleType: FORWARD
      resolverEndpointId: ${foo.id}
      targetIps:
        - ipv6: 2600:1f18:1686:2000:4e60:6e3e:258:da36
      tags:
        Environment: Prod
Copy

Create ResolverRule Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new ResolverRule(name: string, args: ResolverRuleArgs, opts?: CustomResourceOptions);
@overload
def ResolverRule(resource_name: str,
                 args: ResolverRuleArgs,
                 opts: Optional[ResourceOptions] = None)

@overload
def ResolverRule(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 domain_name: Optional[str] = None,
                 rule_type: Optional[str] = None,
                 name: Optional[str] = None,
                 resolver_endpoint_id: Optional[str] = None,
                 tags: Optional[Mapping[str, str]] = None,
                 target_ips: Optional[Sequence[ResolverRuleTargetIpArgs]] = None)
func NewResolverRule(ctx *Context, name string, args ResolverRuleArgs, opts ...ResourceOption) (*ResolverRule, error)
public ResolverRule(string name, ResolverRuleArgs args, CustomResourceOptions? opts = null)
public ResolverRule(String name, ResolverRuleArgs args)
public ResolverRule(String name, ResolverRuleArgs args, CustomResourceOptions options)

type: aws:route53:ResolverRule
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. ResolverRuleArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. 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 This property is required. string
The unique name of the resource.
args This property is required. ResolverRuleArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. ResolverRuleArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. ResolverRuleArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var resolverRuleResource = new Aws.Route53.ResolverRule("resolverRuleResource", new()
{
    DomainName = "string",
    RuleType = "string",
    Name = "string",
    ResolverEndpointId = "string",
    Tags = 
    {
        { "string", "string" },
    },
    TargetIps = new[]
    {
        new Aws.Route53.Inputs.ResolverRuleTargetIpArgs
        {
            Ip = "string",
            Ipv6 = "string",
            Port = 0,
            Protocol = "string",
        },
    },
});
Copy
example, err := route53.NewResolverRule(ctx, "resolverRuleResource", &route53.ResolverRuleArgs{
	DomainName:         pulumi.String("string"),
	RuleType:           pulumi.String("string"),
	Name:               pulumi.String("string"),
	ResolverEndpointId: pulumi.String("string"),
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	TargetIps: route53.ResolverRuleTargetIpArray{
		&route53.ResolverRuleTargetIpArgs{
			Ip:       pulumi.String("string"),
			Ipv6:     pulumi.String("string"),
			Port:     pulumi.Int(0),
			Protocol: pulumi.String("string"),
		},
	},
})
Copy
var resolverRuleResource = new ResolverRule("resolverRuleResource", ResolverRuleArgs.builder()
    .domainName("string")
    .ruleType("string")
    .name("string")
    .resolverEndpointId("string")
    .tags(Map.of("string", "string"))
    .targetIps(ResolverRuleTargetIpArgs.builder()
        .ip("string")
        .ipv6("string")
        .port(0)
        .protocol("string")
        .build())
    .build());
Copy
resolver_rule_resource = aws.route53.ResolverRule("resolverRuleResource",
    domain_name="string",
    rule_type="string",
    name="string",
    resolver_endpoint_id="string",
    tags={
        "string": "string",
    },
    target_ips=[{
        "ip": "string",
        "ipv6": "string",
        "port": 0,
        "protocol": "string",
    }])
Copy
const resolverRuleResource = new aws.route53.ResolverRule("resolverRuleResource", {
    domainName: "string",
    ruleType: "string",
    name: "string",
    resolverEndpointId: "string",
    tags: {
        string: "string",
    },
    targetIps: [{
        ip: "string",
        ipv6: "string",
        port: 0,
        protocol: "string",
    }],
});
Copy
type: aws:route53:ResolverRule
properties:
    domainName: string
    name: string
    resolverEndpointId: string
    ruleType: string
    tags:
        string: string
    targetIps:
        - ip: string
          ipv6: string
          port: 0
          protocol: string
Copy

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

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The ResolverRule resource accepts the following input properties:

DomainName
This property is required.
Changes to this property will trigger replacement.
string
DNS queries for this domain name are forwarded to the IP addresses that are specified using target_ip.
RuleType
This property is required.
Changes to this property will trigger replacement.
string
Rule type. Valid values are FORWARD, SYSTEM and RECURSIVE.
Name string
Friendly name that lets you easily find a rule in the Resolver dashboard in the Route 53 console.
ResolverEndpointId string
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>
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<ResolverRuleTargetIp>
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
This property is required.
Changes to this property will trigger replacement.
string
DNS queries for this domain name are forwarded to the IP addresses that are specified using target_ip.
RuleType
This property is required.
Changes to this property will trigger replacement.
string
Rule type. Valid values are FORWARD, SYSTEM and RECURSIVE.
Name string
Friendly name that lets you easily find a rule in the Resolver dashboard in the Route 53 console.
ResolverEndpointId string
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
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
This property is required.
Changes to this property will trigger replacement.
String
DNS queries for this domain name are forwarded to the IP addresses that are specified using target_ip.
ruleType
This property is required.
Changes to this property will trigger replacement.
String
Rule type. Valid values are FORWARD, SYSTEM and RECURSIVE.
name String
Friendly name that lets you easily find a rule in the Resolver dashboard in the Route 53 console.
resolverEndpointId String
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>
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<ResolverRuleTargetIp>
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
This property is required.
Changes to this property will trigger replacement.
string
DNS queries for this domain name are forwarded to the IP addresses that are specified using target_ip.
ruleType
This property is required.
Changes to this property will trigger replacement.
string
Rule type. Valid values are FORWARD, SYSTEM and RECURSIVE.
name string
Friendly name that lets you easily find a rule in the Resolver dashboard in the Route 53 console.
resolverEndpointId string
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}
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 ResolverRuleTargetIp[]
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
This property is required.
Changes to this property will trigger replacement.
str
DNS queries for this domain name are forwarded to the IP addresses that are specified using target_ip.
rule_type
This property is required.
Changes to this property will trigger replacement.
str
Rule type. Valid values are FORWARD, SYSTEM and RECURSIVE.
name str
Friendly name that lets you easily find a rule in the Resolver dashboard in the Route 53 console.
resolver_endpoint_id str
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]
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.
domainName
This property is required.
Changes to this property will trigger replacement.
String
DNS queries for this domain name are forwarded to the IP addresses that are specified using target_ip.
ruleType
This property is required.
Changes to this property will trigger replacement.
String
Rule type. Valid values are FORWARD, SYSTEM and RECURSIVE.
name String
Friendly name that lets you easily find a rule in the Resolver dashboard in the Route 53 console.
resolverEndpointId String
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>
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<Property Map>
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
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>
Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

Arn string
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
Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

arn String
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>
Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

arn string
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}
Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

arn str
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]
Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

arn String
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>
Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

Look up 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)
public static ResolverRule get(String name, Output<String> id, ResolverRuleState state, CustomResourceOptions options)
resources:  _:    type: aws:route53:ResolverRule    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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
ARN (Amazon Resource Name) for the resolver rule.
DomainName Changes to this property will trigger replacement. string
DNS queries for this domain name are forwarded to the IP addresses that are specified using target_ip.
Name string
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
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 Changes to this property will trigger replacement. string
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>
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>
Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

TargetIps List<ResolverRuleTargetIp>
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
ARN (Amazon Resource Name) for the resolver rule.
DomainName Changes to this property will trigger replacement. string
DNS queries for this domain name are forwarded to the IP addresses that are specified using target_ip.
Name string
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
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 Changes to this property will trigger replacement. string
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
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
Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

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
ARN (Amazon Resource Name) for the resolver rule.
domainName Changes to this property will trigger replacement. String
DNS queries for this domain name are forwarded to the IP addresses that are specified using target_ip.
name String
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
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 Changes to this property will trigger replacement. String
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>
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>
Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

targetIps List<ResolverRuleTargetIp>
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
ARN (Amazon Resource Name) for the resolver rule.
domainName Changes to this property will trigger replacement. string
DNS queries for this domain name are forwarded to the IP addresses that are specified using target_ip.
name string
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
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 Changes to this property will trigger replacement. string
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}
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}
Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

targetIps ResolverRuleTargetIp[]
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
ARN (Amazon Resource Name) for the resolver rule.
domain_name Changes to this property will trigger replacement. str
DNS queries for this domain name are forwarded to the IP addresses that are specified using target_ip.
name str
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
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 Changes to this property will trigger replacement. str
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]
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]
Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

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.
arn String
ARN (Amazon Resource Name) for the resolver rule.
domainName Changes to this property will trigger replacement. String
DNS queries for this domain name are forwarded to the IP addresses that are specified using target_ip.
name String
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
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 Changes to this property will trigger replacement. String
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>
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>
Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

targetIps List<Property Map>
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
, ResolverRuleTargetIpArgs

Ip string
One IPv4 address that you want to forward DNS queries to.
Ipv6 string
One IPv6 address that you want to forward DNS queries to.
Port int
Port at ip that you want to forward DNS queries to. Default value is 53.
Protocol string
Protocol for the resolver endpoint. Valid values can be found in the AWS documentation. Default value is Do53.
Ip string
One IPv4 address that you want to forward DNS queries to.
Ipv6 string
One IPv6 address that you want to forward DNS queries to.
Port int
Port at ip that you want to forward DNS queries to. Default value is 53.
Protocol string
Protocol for the resolver endpoint. Valid values can be found in the AWS documentation. Default value is Do53.
ip String
One IPv4 address that you want to forward DNS queries to.
ipv6 String
One IPv6 address that you want to forward DNS queries to.
port Integer
Port at ip that you want to forward DNS queries to. Default value is 53.
protocol String
Protocol for the resolver endpoint. Valid values can be found in the AWS documentation. Default value is Do53.
ip string
One IPv4 address that you want to forward DNS queries to.
ipv6 string
One IPv6 address that you want to forward DNS queries to.
port number
Port at ip that you want to forward DNS queries to. Default value is 53.
protocol string
Protocol for the resolver endpoint. Valid values can be found in the AWS documentation. Default value is Do53.
ip str
One IPv4 address that you want to forward DNS queries to.
ipv6 str
One IPv6 address that you want to forward DNS queries to.
port int
Port at ip that you want to forward DNS queries to. Default value is 53.
protocol str
Protocol for the resolver endpoint. Valid values can be found in the AWS documentation. Default value is Do53.
ip String
One IPv4 address that you want to forward DNS queries to.
ipv6 String
One IPv6 address that you want to forward DNS queries to.
port Number
Port at ip that you want to forward DNS queries to. Default value is 53.
protocol String
Protocol for the resolver endpoint. Valid values can be found in the AWS documentation. Default value is Do53.

Import

Using pulumi import, import Route53 Resolver rules using the id. For example:

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

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository
AWS Classic pulumi/pulumi-aws
License
Apache-2.0
Notes
This Pulumi package is based on the aws Terraform Provider.
AWS v6.77.1 published on Friday, Apr 18, 2025 by Pulumi
pulumi/pulumi-aws