Interface CfnFirewallRuleGroup.FirewallRuleProperty

All Superinterfaces:
All Known Implementing Classes:
Enclosing class:

@Stability(Stable) public static interface CfnFirewallRuleGroup.FirewallRuleProperty extends
A single firewall rule in a rule group.


 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 FirewallRuleProperty firewallRuleProperty = FirewallRuleProperty.builder()
         // the properties below are optional
  • Method Details

    • getAction

      @Stability(Stable) @NotNull String getAction()
      The action that DNS Firewall should take on a DNS query when it matches one of the domains in the rule's domain list: - ALLOW - Permit the request to go through.

      • ALERT - Permit the request to go through but send an alert to the logs.
      • BLOCK - Disallow the request. If this is specified,then BlockResponse must also be specified.

      if BlockResponse is OVERRIDE , then all of the following OVERRIDE attributes must be specified:

      • BlockOverrideDnsType
      • BlockOverrideDomain
      • BlockOverrideTtl
    • getFirewallDomainListId

      @Stability(Stable) @NotNull String getFirewallDomainListId()
      The ID of the domain list that's used in the rule.
    • getPriority

      @Stability(Stable) @NotNull Number getPriority()
      The priority of the rule in the rule group.

      This value must be unique within the rule group. DNS Firewall processes the rules in a rule group by order of priority, starting from the lowest setting.

    • getBlockOverrideDnsType

      @Stability(Stable) @Nullable default String getBlockOverrideDnsType()
      The DNS record's type.

      This determines the format of the record value that you provided in BlockOverrideDomain . Used for the rule action BLOCK with a BlockResponse setting of OVERRIDE .

    • getBlockOverrideDomain

      @Stability(Stable) @Nullable default String getBlockOverrideDomain()
      The custom DNS record to send back in response to the query.

      Used for the rule action BLOCK with a BlockResponse setting of OVERRIDE .

    • getBlockOverrideTtl

      @Stability(Stable) @Nullable default Number getBlockOverrideTtl()
      The recommended amount of time, in seconds, for the DNS resolver or web browser to cache the provided override record.

      Used for the rule action BLOCK with a BlockResponse setting of OVERRIDE .

    • getBlockResponse

      @Stability(Stable) @Nullable default String getBlockResponse()
      The way that you want DNS Firewall to block the request. Used for the rule action setting BLOCK .

      • NODATA - Respond indicating that the query was successful, but no response is available for it.
      • NXDOMAIN - Respond indicating that the domain name that's in the query doesn't exist.
      • OVERRIDE - Provide a custom override in the response. This option requires custom handling details in the rule's BlockOverride* settings.
    • builder

      @Stability(Stable) static CfnFirewallRuleGroup.FirewallRuleProperty.Builder builder()
      a CfnFirewallRuleGroup.FirewallRuleProperty.Builder of CfnFirewallRuleGroup.FirewallRuleProperty