Class ResolverFirewallRule


  • public class ResolverFirewallRule
    extends com.pulumi.resources.CustomResource
    Provides a Route 53 Resolver DNS Firewall rule resource. ## Example Usage ### Domain List Rule
     
     package generated_program;
     
     import com.pulumi.Context;
     import com.pulumi.Pulumi;
     import com.pulumi.core.Output;
     import com.pulumi.aws.route53.ResolverFirewallDomainList;
     import com.pulumi.aws.route53.ResolverFirewallDomainListArgs;
     import com.pulumi.aws.route53.ResolverFirewallRuleGroup;
     import com.pulumi.aws.route53.ResolverFirewallRuleGroupArgs;
     import com.pulumi.aws.route53.ResolverFirewallRule;
     import com.pulumi.aws.route53.ResolverFirewallRuleArgs;
     import java.util.ArrayList;
     import java.util.Arrays;
     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 example = new ResolverFirewallDomainList("example", ResolverFirewallDomainListArgs.builder()
                 .name("example")
                 .domains("example.com")
                 .tags(Map.ofEntries(
                 ))
                 .build());
     
             var exampleResolverFirewallRuleGroup = new ResolverFirewallRuleGroup("exampleResolverFirewallRuleGroup", ResolverFirewallRuleGroupArgs.builder()
                 .name("example")
                 .tags(Map.ofEntries(
                 ))
                 .build());
     
             var exampleResolverFirewallRule = new ResolverFirewallRule("exampleResolverFirewallRule", ResolverFirewallRuleArgs.builder()
                 .name("example")
                 .action("BLOCK")
                 .blockOverrideDnsType("CNAME")
                 .blockOverrideDomain("example.com")
                 .blockOverrideTtl(1)
                 .blockResponse("OVERRIDE")
                 .firewallDomainListId(example.id())
                 .firewallRuleGroupId(exampleResolverFirewallRuleGroup.id())
                 .priority(100)
                 .build());
     
         }
     }
     
     
    ### DNS Firewall Advanced Rule
     
     package generated_program;
     
     import com.pulumi.Context;
     import com.pulumi.Pulumi;
     import com.pulumi.core.Output;
     import com.pulumi.aws.route53.ResolverFirewallRuleGroup;
     import com.pulumi.aws.route53.ResolverFirewallRuleGroupArgs;
     import com.pulumi.aws.route53.ResolverFirewallRule;
     import com.pulumi.aws.route53.ResolverFirewallRuleArgs;
     import java.util.ArrayList;
     import java.util.Arrays;
     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 example = new ResolverFirewallRuleGroup("example", ResolverFirewallRuleGroupArgs.builder()
                 .name("example")
                 .tags(Map.ofEntries(
                 ))
                 .build());
     
             var exampleResolverFirewallRule = new ResolverFirewallRule("exampleResolverFirewallRule", ResolverFirewallRuleArgs.builder()
                 .name("block-dga")
                 .action("BLOCK")
                 .blockResponse("NODATA")
                 .firewallRuleGroupId(example.id())
                 .dnsThreatProtection("DGA")
                 .confidenceThreshold("HIGH")
                 .priority(100)
                 .build());
     
         }
     }
     
     
    ## Import DNS Firewall Advanced rule: Using `pulumi import`, import Route 53 Resolver DNS Firewall rules using the Route 53 Resolver DNS Firewall rule group ID and domain list ID (for standard rules) or threat protection ID (for advanced rules) separated by ':'. For example: ```sh $ pulumi import aws:route53/resolverFirewallRule:ResolverFirewallRule example rslvr-frg-0123456789abcdef:rslvr-fdl-0123456789abcdef ```
    • Nested Class Summary

      • Nested classes/interfaces inherited from class com.pulumi.resources.CustomResource

        com.pulumi.resources.CustomResource.CustomResourceInternal
      • Nested classes/interfaces inherited from class com.pulumi.resources.Resource

        com.pulumi.resources.Resource.LazyField<T extends java.lang.Object>, com.pulumi.resources.Resource.LazyFields, com.pulumi.resources.Resource.ResourceInternal
    • Field Summary

      • Fields inherited from class com.pulumi.resources.Resource

        childResources, remote
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      com.pulumi.core.Output<java.lang.String> action()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> blockOverrideDnsType()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> blockOverrideDomain()  
      com.pulumi.core.Output<java.util.Optional<java.lang.Integer>> blockOverrideTtl()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> blockResponse()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> confidenceThreshold()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> dnsThreatProtection()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> firewallDomainListId()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> firewallDomainRedirectionAction()  
      com.pulumi.core.Output<java.lang.String> firewallRuleGroupId()  
      com.pulumi.core.Output<java.lang.String> firewallThreatProtectionId()  
      static ResolverFirewallRule get​(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, ResolverFirewallRuleState state, com.pulumi.resources.CustomResourceOptions options)
      Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
      com.pulumi.core.Output<java.lang.String> name()  
      com.pulumi.core.Output<java.lang.Integer> priority()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> qType()  
      com.pulumi.core.Output<java.lang.String> region()  
      • Methods inherited from class com.pulumi.resources.CustomResource

        getId, id, idFuture
      • Methods inherited from class com.pulumi.resources.Resource

        getChildResources, getResourceName, getResourceType, getUrn, pulumiChildResources, pulumiResourceName, pulumiResourceType, urn
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • ResolverFirewallRule

        public ResolverFirewallRule​(java.lang.String name)
        Parameters:
        name - The _unique_ name of the resulting resource.
      • ResolverFirewallRule

        public ResolverFirewallRule​(java.lang.String name,
                                    ResolverFirewallRuleArgs args)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.
      • ResolverFirewallRule

        public ResolverFirewallRule​(java.lang.String name,
                                    ResolverFirewallRuleArgs args,
                                    @Nullable
                                    com.pulumi.resources.CustomResourceOptions options)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.
        options - A bag of options that control this resource's behavior.
    • Method Detail

      • action

        public com.pulumi.core.Output<java.lang.String> action()
        Returns:
        The action that DNS Firewall should take on a DNS query when it matches one of the domains in the rule's domain list, or a threat in a DNS Firewall Advanced rule. Valid values: `ALLOW`, `BLOCK`, `ALERT`. Note: `ALLOW` is not valid for DNS Firewall Advanced rules.
      • blockOverrideDnsType

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> blockOverrideDnsType()
        Returns:
        The DNS record's type. This determines the format of the record value that you provided in BlockOverrideDomain. Value values: `CNAME`.
      • blockOverrideDomain

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> blockOverrideDomain()
        Returns:
        The custom DNS record to send back in response to the query.
      • blockOverrideTtl

        public com.pulumi.core.Output<java.util.Optional<java.lang.Integer>> blockOverrideTtl()
        Returns:
        The recommended amount of time, in seconds, for the DNS resolver or web browser to cache the provided override record. Minimum value of 0. Maximum value of 604800.
      • blockResponse

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> blockResponse()
        Returns:
        The way that you want DNS Firewall to block the request. Valid values: `NODATA`, `NXDOMAIN`, `OVERRIDE`.
      • confidenceThreshold

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> confidenceThreshold()
        Returns:
        The confidence threshold for DNS Firewall Advanced rules. You must provide this value when creating a DNS Firewall Advanced rule. Valid values: `LOW`, `MEDIUM`, `HIGH`. Conflicts with `firewallDomainListId`.
      • dnsThreatProtection

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> dnsThreatProtection()
        Returns:
        The type of DNS Firewall Advanced rule. You must provide this value when creating a DNS Firewall Advanced rule. Valid values: `DGA`, `DICTIONARY_DGA`, `DNS_TUNNELING`. Conflicts with `firewallDomainListId`.
      • firewallDomainListId

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> firewallDomainListId()
        Returns:
        The ID of the domain list that you want to use in the rule. Required for standard rules. Conflicts with `dnsThreatProtection` and `confidenceThreshold`.
      • firewallDomainRedirectionAction

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> firewallDomainRedirectionAction()
        Returns:
        Evaluate DNS redirection in the DNS redirection chain, such as CNAME, DNAME, ot ALIAS. Valid values are `INSPECT_REDIRECTION_DOMAIN` and `TRUST_REDIRECTION_DOMAIN`. Default value is `INSPECT_REDIRECTION_DOMAIN`.
      • firewallRuleGroupId

        public com.pulumi.core.Output<java.lang.String> firewallRuleGroupId()
        Returns:
        The unique identifier of the firewall rule group where you want to create the rule.
      • firewallThreatProtectionId

        public com.pulumi.core.Output<java.lang.String> firewallThreatProtectionId()
        Returns:
        The ID of the DNS Firewall Advanced rule. Only set for DNS Firewall Advanced rules.
      • name

        public com.pulumi.core.Output<java.lang.String> name()
        Returns:
        A name that lets you identify the rule, to manage and use it.
      • priority

        public com.pulumi.core.Output<java.lang.Integer> priority()
        Returns:
        The setting that determines the processing order of the rule in the rule group. DNS Firewall processes the rules in a rule group by order of priority, starting from the lowest setting.
      • qType

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> qType()
        Returns:
        The query type you want the rule to evaluate. Additional details can be found [here](https://en.wikipedia.org/wiki/List_of_DNS_record_types)
      • region

        public com.pulumi.core.Output<java.lang.String> region()
        Returns:
        Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.
      • get

        public static ResolverFirewallRule get​(java.lang.String name,
                                               com.pulumi.core.Output<java.lang.String> id,
                                               @Nullable
                                               ResolverFirewallRuleState state,
                                               @Nullable
                                               com.pulumi.resources.CustomResourceOptions options)
        Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
        Parameters:
        name - The _unique_ name of the resulting resource.
        id - The _unique_ provider ID of the resource to lookup.
        state -
        options - Optional settings to control the behavior of the CustomResource.