1. Packages
  2. AWS
  3. API Docs
  4. route53
  5. getResolverRule
AWS v6.60.0 published on Tuesday, Nov 19, 2024 by Pulumi

aws.route53.getResolverRule

Explore with Pulumi AI

aws logo
AWS v6.60.0 published on Tuesday, Nov 19, 2024 by Pulumi

    aws.route53.ResolverRule provides details about a specific Route53 Resolver rule.

    Example Usage

    The following example shows how to get a Route53 Resolver rule based on its associated domain name and rule type.

    import * as pulumi from "@pulumi/pulumi";
    import * as aws from "@pulumi/aws";
    
    const example = aws.route53.getResolverRule({
        domainName: "subdomain.example.com",
        ruleType: "SYSTEM",
    });
    
    import pulumi
    import pulumi_aws as aws
    
    example = aws.route53.get_resolver_rule(domain_name="subdomain.example.com",
        rule_type="SYSTEM")
    
    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.LookupResolverRule(ctx, &route53.LookupResolverRuleArgs{
    			DomainName: pulumi.StringRef("subdomain.example.com"),
    			RuleType:   pulumi.StringRef("SYSTEM"),
    		}, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Aws = Pulumi.Aws;
    
    return await Deployment.RunAsync(() => 
    {
        var example = Aws.Route53.GetResolverRule.Invoke(new()
        {
            DomainName = "subdomain.example.com",
            RuleType = "SYSTEM",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.aws.route53.Route53Functions;
    import com.pulumi.aws.route53.inputs.GetResolverRuleArgs;
    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) {
            final var example = Route53Functions.getResolverRule(GetResolverRuleArgs.builder()
                .domainName("subdomain.example.com")
                .ruleType("SYSTEM")
                .build());
    
        }
    }
    
    variables:
      example:
        fn::invoke:
          Function: aws:route53:getResolverRule
          Arguments:
            domainName: subdomain.example.com
            ruleType: SYSTEM
    

    Using getResolverRule

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getResolverRule(args: GetResolverRuleArgs, opts?: InvokeOptions): Promise<GetResolverRuleResult>
    function getResolverRuleOutput(args: GetResolverRuleOutputArgs, opts?: InvokeOptions): Output<GetResolverRuleResult>
    def get_resolver_rule(domain_name: Optional[str] = None,
                          name: Optional[str] = None,
                          resolver_endpoint_id: Optional[str] = None,
                          resolver_rule_id: Optional[str] = None,
                          rule_type: Optional[str] = None,
                          tags: Optional[Mapping[str, str]] = None,
                          opts: Optional[InvokeOptions] = None) -> GetResolverRuleResult
    def get_resolver_rule_output(domain_name: Optional[pulumi.Input[str]] = None,
                          name: Optional[pulumi.Input[str]] = None,
                          resolver_endpoint_id: Optional[pulumi.Input[str]] = None,
                          resolver_rule_id: Optional[pulumi.Input[str]] = None,
                          rule_type: Optional[pulumi.Input[str]] = None,
                          tags: Optional[pulumi.Input[Mapping[str, pulumi.Input[str]]]] = None,
                          opts: Optional[InvokeOptions] = None) -> Output[GetResolverRuleResult]
    func LookupResolverRule(ctx *Context, args *LookupResolverRuleArgs, opts ...InvokeOption) (*LookupResolverRuleResult, error)
    func LookupResolverRuleOutput(ctx *Context, args *LookupResolverRuleOutputArgs, opts ...InvokeOption) LookupResolverRuleResultOutput

    > Note: This function is named LookupResolverRule in the Go SDK.

    public static class GetResolverRule 
    {
        public static Task<GetResolverRuleResult> InvokeAsync(GetResolverRuleArgs args, InvokeOptions? opts = null)
        public static Output<GetResolverRuleResult> Invoke(GetResolverRuleInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetResolverRuleResult> getResolverRule(GetResolverRuleArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: aws:route53/getResolverRule:getResolverRule
      arguments:
        # arguments dictionary

    The following arguments are supported:

    DomainName string
    Domain name the desired resolver rule forwards DNS queries for. Conflicts with resolver_rule_id.
    Name string
    Friendly name of the desired resolver rule. Conflicts with resolver_rule_id.
    ResolverEndpointId string
    ID of the outbound resolver endpoint of the desired resolver rule. Conflicts with resolver_rule_id.
    ResolverRuleId string
    ID of the desired resolver rule. Conflicts with domain_name, name, resolver_endpoint_id and rule_type.
    RuleType string
    Rule type of the desired resolver rule. Valid values are FORWARD, SYSTEM and RECURSIVE. Conflicts with resolver_rule_id.
    Tags Dictionary<string, string>
    Map of tags assigned to the resolver rule.
    DomainName string
    Domain name the desired resolver rule forwards DNS queries for. Conflicts with resolver_rule_id.
    Name string
    Friendly name of the desired resolver rule. Conflicts with resolver_rule_id.
    ResolverEndpointId string
    ID of the outbound resolver endpoint of the desired resolver rule. Conflicts with resolver_rule_id.
    ResolverRuleId string
    ID of the desired resolver rule. Conflicts with domain_name, name, resolver_endpoint_id and rule_type.
    RuleType string
    Rule type of the desired resolver rule. Valid values are FORWARD, SYSTEM and RECURSIVE. Conflicts with resolver_rule_id.
    Tags map[string]string
    Map of tags assigned to the resolver rule.
    domainName String
    Domain name the desired resolver rule forwards DNS queries for. Conflicts with resolver_rule_id.
    name String
    Friendly name of the desired resolver rule. Conflicts with resolver_rule_id.
    resolverEndpointId String
    ID of the outbound resolver endpoint of the desired resolver rule. Conflicts with resolver_rule_id.
    resolverRuleId String
    ID of the desired resolver rule. Conflicts with domain_name, name, resolver_endpoint_id and rule_type.
    ruleType String
    Rule type of the desired resolver rule. Valid values are FORWARD, SYSTEM and RECURSIVE. Conflicts with resolver_rule_id.
    tags Map<String,String>
    Map of tags assigned to the resolver rule.
    domainName string
    Domain name the desired resolver rule forwards DNS queries for. Conflicts with resolver_rule_id.
    name string
    Friendly name of the desired resolver rule. Conflicts with resolver_rule_id.
    resolverEndpointId string
    ID of the outbound resolver endpoint of the desired resolver rule. Conflicts with resolver_rule_id.
    resolverRuleId string
    ID of the desired resolver rule. Conflicts with domain_name, name, resolver_endpoint_id and rule_type.
    ruleType string
    Rule type of the desired resolver rule. Valid values are FORWARD, SYSTEM and RECURSIVE. Conflicts with resolver_rule_id.
    tags {[key: string]: string}
    Map of tags assigned to the resolver rule.
    domain_name str
    Domain name the desired resolver rule forwards DNS queries for. Conflicts with resolver_rule_id.
    name str
    Friendly name of the desired resolver rule. Conflicts with resolver_rule_id.
    resolver_endpoint_id str
    ID of the outbound resolver endpoint of the desired resolver rule. Conflicts with resolver_rule_id.
    resolver_rule_id str
    ID of the desired resolver rule. Conflicts with domain_name, name, resolver_endpoint_id and rule_type.
    rule_type str
    Rule type of the desired resolver rule. Valid values are FORWARD, SYSTEM and RECURSIVE. Conflicts with resolver_rule_id.
    tags Mapping[str, str]
    Map of tags assigned to the resolver rule.
    domainName String
    Domain name the desired resolver rule forwards DNS queries for. Conflicts with resolver_rule_id.
    name String
    Friendly name of the desired resolver rule. Conflicts with resolver_rule_id.
    resolverEndpointId String
    ID of the outbound resolver endpoint of the desired resolver rule. Conflicts with resolver_rule_id.
    resolverRuleId String
    ID of the desired resolver rule. Conflicts with domain_name, name, resolver_endpoint_id and rule_type.
    ruleType String
    Rule type of the desired resolver rule. Valid values are FORWARD, SYSTEM and RECURSIVE. Conflicts with resolver_rule_id.
    tags Map<String>
    Map of tags assigned to the resolver rule.

    getResolverRule Result

    The following output properties are available:

    Arn string
    ARN (Amazon Resource Name) for the resolver rule.
    DomainName string
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    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
    ResolverRuleId string
    RuleType string
    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 assigned to the resolver rule.
    Arn string
    ARN (Amazon Resource Name) for the resolver rule.
    DomainName string
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    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
    ResolverRuleId string
    RuleType string
    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 assigned to the resolver rule.
    arn String
    ARN (Amazon Resource Name) for the resolver rule.
    domainName String
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    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
    resolverRuleId String
    ruleType String
    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 assigned to the resolver rule.
    arn string
    ARN (Amazon Resource Name) for the resolver rule.
    domainName string
    id string
    The provider-assigned unique ID for this managed resource.
    name string
    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
    resolverRuleId string
    ruleType string
    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 assigned to the resolver rule.
    arn str
    ARN (Amazon Resource Name) for the resolver rule.
    domain_name str
    id str
    The provider-assigned unique ID for this managed resource.
    name str
    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
    resolver_rule_id str
    rule_type str
    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 assigned to the resolver rule.
    arn String
    ARN (Amazon Resource Name) for the resolver rule.
    domainName String
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    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
    resolverRuleId String
    ruleType String
    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 assigned to the resolver rule.

    Package Details

    Repository
    AWS Classic pulumi/pulumi-aws
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the aws Terraform Provider.
    aws logo
    AWS v6.60.0 published on Tuesday, Nov 19, 2024 by Pulumi