1. Packages
  2. AWS Native
  3. API Docs
  4. route53resolver
  5. ResolverRule

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.102.0 published on Tuesday, Apr 16, 2024 by Pulumi

aws-native.route53resolver.ResolverRule

Explore with Pulumi AI

aws-native logo

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.102.0 published on Tuesday, Apr 16, 2024 by Pulumi

    Resource Type definition for AWS::Route53Resolver::ResolverRule

    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[ResolverRuleRuleType] = None,
                     name: Optional[str] = None,
                     resolver_endpoint_id: Optional[str] = None,
                     tags: Optional[Sequence[_root_inputs.TagArgs]] = None,
                     target_ips: Optional[Sequence[ResolverRuleTargetAddressArgs]] = 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-native:route53resolver:ResolverRule
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    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.
    name String
    The unique name of the resource.
    args ResolverRuleArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

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

    Coming soon!
    
    Coming soon!
    
    Coming soon!
    
    Coming soon!
    
    const resolverRuleResource = new aws_native.route53resolver.ResolverRule("resolverRuleResource", {
        domainName: "string",
        ruleType: aws_native.route53resolver.ResolverRuleRuleType.Forward,
        name: "string",
        resolverEndpointId: "string",
        tags: [{
            key: "string",
            value: "string",
        }],
        targetIps: [{
            ip: "string",
            ipv6: "string",
            port: "string",
            protocol: aws_native.route53resolver.ResolverRuleTargetAddressProtocol.Do53,
        }],
    });
    
    Coming soon!
    

    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 in TargetIps
    RuleType Pulumi.AwsNative.Route53Resolver.ResolverRuleRuleType
    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.
    Name string
    The name for the Resolver rule
    ResolverEndpointId string
    The ID of the endpoint that the rule is associated with.
    Tags List<Pulumi.AwsNative.Inputs.Tag>
    An array of key-value pairs to apply to this resource.
    TargetIps List<Pulumi.AwsNative.Route53Resolver.Inputs.ResolverRuleTargetAddress>
    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.
    DomainName string
    DNS queries for this domain name are forwarded to the IP addresses that are specified in TargetIps
    RuleType ResolverRuleRuleType
    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.
    Name string
    The name for the Resolver rule
    ResolverEndpointId string
    The ID of the endpoint that the rule is associated with.
    Tags TagArgs
    An array of key-value pairs to apply to this resource.
    TargetIps []ResolverRuleTargetAddressArgs
    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.
    domainName String
    DNS queries for this domain name are forwarded to the IP addresses that are specified in TargetIps
    ruleType ResolverRuleRuleType
    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.
    name String
    The name for the Resolver rule
    resolverEndpointId String
    The ID of the endpoint that the rule is associated with.
    tags List<Tag>
    An array of key-value pairs to apply to this resource.
    targetIps List<ResolverRuleTargetAddress>
    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.
    domainName string
    DNS queries for this domain name are forwarded to the IP addresses that are specified in TargetIps
    ruleType ResolverRuleRuleType
    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.
    name string
    The name for the Resolver rule
    resolverEndpointId string
    The ID of the endpoint that the rule is associated with.
    tags Tag[]
    An array of key-value pairs to apply to this resource.
    targetIps ResolverRuleTargetAddress[]
    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.
    domain_name str
    DNS queries for this domain name are forwarded to the IP addresses that are specified in TargetIps
    rule_type ResolverRuleRuleType
    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.
    name str
    The name for the Resolver rule
    resolver_endpoint_id str
    The ID of the endpoint that the rule is associated with.
    tags Sequence[TagArgs]
    An array of key-value pairs to apply to this resource.
    target_ips Sequence[ResolverRuleTargetAddressArgs]
    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.
    domainName String
    DNS queries for this domain name are forwarded to the IP addresses that are specified in TargetIps
    ruleType "FORWARD" | "SYSTEM" | "RECURSIVE"
    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.
    name String
    The name for the Resolver rule
    resolverEndpointId String
    The ID of the endpoint that the rule is associated with.
    tags List<Property Map>
    An array of key-value pairs to apply to this resource.
    targetIps List<Property Map>
    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.

    Outputs

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

    Arn string
    The Amazon Resource Name (ARN) of the resolver rule.
    Id string
    The provider-assigned unique ID for this managed resource.
    ResolverRuleId string
    The ID of the endpoint that the rule is associated with.
    Arn string
    The Amazon Resource Name (ARN) of the resolver rule.
    Id string
    The provider-assigned unique ID for this managed resource.
    ResolverRuleId string
    The ID of the endpoint that the rule is associated with.
    arn String
    The Amazon Resource Name (ARN) of the resolver rule.
    id String
    The provider-assigned unique ID for this managed resource.
    resolverRuleId String
    The ID of the endpoint that the rule is associated with.
    arn string
    The Amazon Resource Name (ARN) of the resolver rule.
    id string
    The provider-assigned unique ID for this managed resource.
    resolverRuleId string
    The ID of the endpoint that the rule is associated with.
    arn str
    The Amazon Resource Name (ARN) of the resolver rule.
    id str
    The provider-assigned unique ID for this managed resource.
    resolver_rule_id str
    The ID of the endpoint that the rule is associated with.
    arn String
    The Amazon Resource Name (ARN) of the resolver rule.
    id String
    The provider-assigned unique ID for this managed resource.
    resolverRuleId String
    The ID of the endpoint that the rule is associated with.

    Supporting Types

    ResolverRuleRuleType, ResolverRuleRuleTypeArgs

    Forward
    FORWARD
    System
    SYSTEM
    Recursive
    RECURSIVE
    ResolverRuleRuleTypeForward
    FORWARD
    ResolverRuleRuleTypeSystem
    SYSTEM
    ResolverRuleRuleTypeRecursive
    RECURSIVE
    Forward
    FORWARD
    System
    SYSTEM
    Recursive
    RECURSIVE
    Forward
    FORWARD
    System
    SYSTEM
    Recursive
    RECURSIVE
    FORWARD
    FORWARD
    SYSTEM
    SYSTEM
    RECURSIVE
    RECURSIVE
    "FORWARD"
    FORWARD
    "SYSTEM"
    SYSTEM
    "RECURSIVE"
    RECURSIVE

    ResolverRuleTargetAddress, ResolverRuleTargetAddressArgs

    Ip string
    One IP address that you want to forward DNS queries to. You can specify only IPv4 addresses.
    Ipv6 string
    One IPv6 address that you want to forward DNS queries to. You can specify only IPv6 addresses.
    Port string
    The port at Ip that you want to forward DNS queries to.
    Protocol Pulumi.AwsNative.Route53Resolver.ResolverRuleTargetAddressProtocol
    The protocol that you want to use to forward DNS queries.
    Ip string
    One IP address that you want to forward DNS queries to. You can specify only IPv4 addresses.
    Ipv6 string
    One IPv6 address that you want to forward DNS queries to. You can specify only IPv6 addresses.
    Port string
    The port at Ip that you want to forward DNS queries to.
    Protocol ResolverRuleTargetAddressProtocol
    The protocol that you want to use to forward DNS queries.
    ip String
    One IP address that you want to forward DNS queries to. You can specify only IPv4 addresses.
    ipv6 String
    One IPv6 address that you want to forward DNS queries to. You can specify only IPv6 addresses.
    port String
    The port at Ip that you want to forward DNS queries to.
    protocol ResolverRuleTargetAddressProtocol
    The protocol that you want to use to forward DNS queries.
    ip string
    One IP address that you want to forward DNS queries to. You can specify only IPv4 addresses.
    ipv6 string
    One IPv6 address that you want to forward DNS queries to. You can specify only IPv6 addresses.
    port string
    The port at Ip that you want to forward DNS queries to.
    protocol ResolverRuleTargetAddressProtocol
    The protocol that you want to use to forward DNS queries.
    ip str
    One IP address that you want to forward DNS queries to. You can specify only IPv4 addresses.
    ipv6 str
    One IPv6 address that you want to forward DNS queries to. You can specify only IPv6 addresses.
    port str
    The port at Ip that you want to forward DNS queries to.
    protocol ResolverRuleTargetAddressProtocol
    The protocol that you want to use to forward DNS queries.
    ip String
    One IP address that you want to forward DNS queries to. You can specify only IPv4 addresses.
    ipv6 String
    One IPv6 address that you want to forward DNS queries to. You can specify only IPv6 addresses.
    port String
    The port at Ip that you want to forward DNS queries to.
    protocol "Do53" | "DoH"
    The protocol that you want to use to forward DNS queries.

    ResolverRuleTargetAddressProtocol, ResolverRuleTargetAddressProtocolArgs

    Do53
    Do53
    DoH
    DoH
    ResolverRuleTargetAddressProtocolDo53
    Do53
    ResolverRuleTargetAddressProtocolDoH
    DoH
    Do53
    Do53
    DoH
    DoH
    Do53
    Do53
    DoH
    DoH
    DO53
    Do53
    DO_H
    DoH
    "Do53"
    Do53
    "DoH"
    DoH

    Tag, TagArgs

    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    AWS Native is in preview. AWS Classic is fully supported.

    AWS Native v0.102.0 published on Tuesday, Apr 16, 2024 by Pulumi