Route53Resolver / Client / create_firewall_rule

create_firewall_rule

Route53Resolver.Client.create_firewall_rule(**kwargs)

Creates a single DNS Firewall rule in the specified rule group. The rule can use any one of the following match sources, and the chosen source must be supplied through the matching request field — they are mutually exclusive:

• FirewallDomainListId — match a customer-managed or AWS-managed domain list.

• DnsThreatProtection — match a built-in DNS Firewall Advanced threat detector ( DGA, DNS_TUNNELING, or DICTIONARY_DGA).

• FirewallRuleType — match one of the rule-type variants returned by ListFirewallRuleTypes: FirewallAdvancedContentCategory, FirewallAdvancedThreatCategory, DnsThreatProtection, or PartnerThreatProtection. The PartnerThreatProtection variant requires an active AWS Marketplace subscription to the named partner product.

For rules that require asynchronous provisioning (today, the PartnerThreatProtection rule type), the rule’s Status begins at CREATING and transitions to COMPLETE once the rule is provisioned and the marketplace entitlement is verified. If provisioning fails, Status becomes CREATION_FAILED and StatusMessage contains a human-readable reason; the rule is then immutable and must be removed with DeleteFirewallRule.

See also: AWS API Documentation

Request Syntax

response = client.create_firewall_rule(
    CreatorRequestId='string',
    FirewallRuleGroupId='string',
    FirewallDomainListId='string',
    Priority=123,
    Action='ALLOW'|'BLOCK'|'ALERT',
    BlockResponse='NODATA'|'NXDOMAIN'|'OVERRIDE',
    BlockOverrideDomain='string',
    BlockOverrideDnsType='CNAME',
    BlockOverrideTtl=123,
    Name='string',
    FirewallDomainRedirectionAction='INSPECT_REDIRECTION_DOMAIN'|'TRUST_REDIRECTION_DOMAIN',
    Qtype='string',
    DnsThreatProtection='DGA'|'DNS_TUNNELING'|'DICTIONARY_DGA',
    ConfidenceThreshold='LOW'|'MEDIUM'|'HIGH',
    FirewallRuleType={
        'PartnerThreatProtection': {
            'Partner': 'string'
        },
        'FirewallAdvancedContentCategory': {
            'Category': 'string'
        },
        'FirewallAdvancedThreatCategory': {
            'Category': 'string'
        },
        'DnsThreatProtection': {
            'Value': 'string',
            'ConfidenceThreshold': 'LOW'|'MEDIUM'|'HIGH'
        }
    }
)

Parameters:

• CreatorRequestId (string) –

  [REQUIRED]

  A unique string that identifies the request and that allows you to retry failed requests without the risk of running the operation twice. CreatorRequestId can be any unique string, for example, a date/time stamp.

  This field is autopopulated if not provided.

• FirewallRuleGroupId (string) –

  [REQUIRED]

  The unique identifier of the firewall rule group where you want to create the rule.

• FirewallDomainListId (string) – The ID of the domain list that you want to use in the rule. Can’t be used together with DnsThreatProtecton.

• Priority (integer) –

  [REQUIRED]

  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.

  You must specify a unique priority for each rule in a rule group. To make it easier to insert rules later, leave space between the numbers, for example, use 100, 200, and so on. You can change the priority setting for the rules in a rule group at any time.

• Action (string) –

  [REQUIRED]

  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:

  • ALLOW - Permit the request to go through. Not available for DNS Firewall Advanced rules.

  • ALERT - Permit the request and send metrics and logs to Cloud Watch.

  • BLOCK - Disallow the request. This option requires additional details in the rule’s BlockResponse.

• BlockResponse (string) –

  The way that you want DNS Firewall to block the request, used with 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.

  This setting is required if the rule action setting is BLOCK.

• BlockOverrideDomain (string) –

  The custom DNS record to send back in response to the query. Used for the rule action BLOCK with a BlockResponse setting of OVERRIDE.

  This setting is required if the BlockResponse setting is OVERRIDE.

• BlockOverrideDnsType (string) –

  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.

  This setting is required if the BlockResponse setting is OVERRIDE.

• BlockOverrideTtl (integer) –

  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.

  This setting is required if the BlockResponse setting is OVERRIDE.

• Name (string) –

  [REQUIRED]

  A name that lets you identify the rule in the rule group.

• FirewallDomainRedirectionAction (string) –

  How you want the the rule to evaluate DNS redirection in the DNS redirection chain, such as CNAME or DNAME.

  INSPECT_REDIRECTION_DOMAIN: (Default) inspects all domains in the redirection chain. The individual domains in the redirection chain must be added to the domain list.

  TRUST_REDIRECTION_DOMAIN: Inspects only the first domain in the redirection chain. You don’t need to add the subsequent domains in the domain in the redirection list to the domain list.

• Qtype (string) –

  The DNS query type you want the rule to evaluate. Allowed values are;

  • A: Returns an IPv4 address.

  • AAAA: Returns an Ipv6 address.

  • CAA: Restricts CAs that can create SSL/TLS certifications for the domain.

  • CNAME: Returns another domain name.

  • DS: Record that identifies the DNSSEC signing key of a delegated zone.

  • MX: Specifies mail servers.

  • NAPTR: Regular-expression-based rewriting of domain names.

  • NS: Authoritative name servers.

  • PTR: Maps an IP address to a domain name.

  • SOA: Start of authority record for the zone.

  • SPF: Lists the servers authorized to send emails from a domain.

  • SRV: Application specific values that identify servers.

  • TXT: Verifies email senders and application-specific values.

  • A query type you define by using the DNS type ID, for example 28 for AAAA. The values must be defined as TYPENUMBER, where the NUMBER can be 1-65534, for example, TYPE28. For more information, see List of DNS record types.

• DnsThreatProtection (string) –

  The type of the DNS Firewall Advanced rule. This setting is mutually exclusive with FirewallDomainListId and FirewallRuleType. Valid values are:

  • DGA: Domain generation algorithms detection. DGAs are used by attackers to generate a large number of domains to launch malware attacks.

  • DNS_TUNNELING: DNS tunneling detection. DNS tunneling is used by attackers to exfiltrate data from the client by using the DNS tunnel without making a network connection to the client.

  • DICTIONARY_DGA: Dictionary-based domain generation algorithms detection. Dictionary DGAs use wordlists to generate domains that appear more legitimate, making them harder to detect than traditional DGAs.

• ConfidenceThreshold (string) –

  The confidence threshold for DNS Firewall Advanced. You must provide this value when you create a DNS Firewall Advanced rule. The confidence level values mean:

  • LOW: Provides the highest detection rate for threats, but also increases false positives.

  • MEDIUM: Provides a balance between detecting threats and false positives.

  • HIGH: Detects only the most well corroborated threats with a low rate of false positives.

• FirewallRuleType (dict) –

  The rule type configuration for the firewall rule. This is a tagged union — set exactly one of its members. This setting is mutually exclusive with the top-level FirewallDomainListId and DnsThreatProtection fields. Use one of:

  • FirewallAdvancedContentCategory — match an AWS-managed content category (for example, VIOLENCE_AND_HATE_SPEECH).

  • FirewallAdvancedThreatCategory — match an AWS-managed advanced threat category (for example, PHISHING).

  • DnsThreatProtection — match a built-in DNS Firewall Advanced threat detector ( DGA, DNS_TUNNELING, or DICTIONARY_DGA).

  • PartnerThreatProtection — match a third-party threat feed delivered through AWS Marketplace. The selected partner must be an active subscription on the calling account.

  To enumerate the values supported in your account, call ListFirewallRuleTypes.

  • PartnerThreatProtection (dict) –

    Configures the rule to match a third-party threat feed delivered through AWS Marketplace. The calling account must hold an active subscription to the partner product named in Partner; if the subscription is missing or revoked, the rule is created with Status CREATION_FAILED and cannot be modified — only deleted. See PartnerThreatProtectionConfig.

    • Partner (string) – [REQUIRED]

      The identifier of the partner threat-protection product, exactly as returned in the Value field of a FirewallRuleTypeDefinition with RuleType set to PartnerThreatProtection. The calling account must hold an active AWS Marketplace subscription to this product.

  • FirewallAdvancedContentCategory (dict) –

    Configures the rule to match an AWS-managed content category (for example, VIOLENCE_AND_HATE_SPEECH). See FirewallAdvancedContentCategoryConfig.

    • Category (string) – [REQUIRED]

      The content category identifier. To retrieve the list of available content categories, call ListFirewallRuleTypes with RuleType set to FirewallAdvancedContentCategory.

  • FirewallAdvancedThreatCategory (dict) –

    Configures the rule to match an AWS-managed advanced threat category (for example, PHISHING). See FirewallAdvancedThreatCategoryConfig.

    • Category (string) – [REQUIRED]

      The threat category identifier. To retrieve the list of available threat categories, call ListFirewallRuleTypes with RuleType set to FirewallAdvancedThreatCategory.

  • DnsThreatProtection (dict) –

    Configures the rule to match a built-in DNS Firewall Advanced threat detector — DGA, DNS_TUNNELING, or DICTIONARY_DGA. See DnsThreatProtectionRuleTypeConfig.

    • Value (string) – [REQUIRED]

      The type of DNS threat protection. Valid values are:

      • DGA: Domain generation algorithms detection. DGAs are used by attackers to generate a large number of domains to launch malware attacks.

      • DNS_TUNNELING: DNS tunneling detection. DNS tunneling is used by attackers to exfiltrate data from the client by using the DNS tunnel without making a network connection to the client.

      • DICTIONARY_DGA: Dictionary-based domain generation algorithms detection. Dictionary DGAs use wordlists to generate domains that appear more legitimate, making them harder to detect than traditional DGAs.

    • ConfidenceThreshold (string) – [REQUIRED]

      The confidence threshold for DNS Firewall Advanced. You must provide this value when you create or update a DNS Firewall Advanced rule. The confidence level values mean:

      • LOW: Provides the highest detection rate for threats, but also increases false positives.

      • MEDIUM: Provides a balance between detecting threats and false positives.

      • HIGH: Detects only the most well corroborated threats with a low rate of false positives.

Return type:

dict

Returns:

Response Syntax

{
    'FirewallRule': {
        'FirewallRuleGroupId': 'string',
        'FirewallDomainListId': 'string',
        'FirewallThreatProtectionId': 'string',
        'Name': 'string',
        'Priority': 123,
        'Action': 'ALLOW'|'BLOCK'|'ALERT',
        'BlockResponse': 'NODATA'|'NXDOMAIN'|'OVERRIDE',
        'BlockOverrideDomain': 'string',
        'BlockOverrideDnsType': 'CNAME',
        'BlockOverrideTtl': 123,
        'CreatorRequestId': 'string',
        'CreationTime': 'string',
        'ModificationTime': 'string',
        'FirewallDomainRedirectionAction': 'INSPECT_REDIRECTION_DOMAIN'|'TRUST_REDIRECTION_DOMAIN',
        'Qtype': 'string',
        'DnsThreatProtection': 'DGA'|'DNS_TUNNELING'|'DICTIONARY_DGA',
        'ConfidenceThreshold': 'LOW'|'MEDIUM'|'HIGH',
        'FirewallRuleType': {
            'PartnerThreatProtection': {
                'Partner': 'string'
            },
            'FirewallAdvancedContentCategory': {
                'Category': 'string'
            },
            'FirewallAdvancedThreatCategory': {
                'Category': 'string'
            },
            'DnsThreatProtection': {
                'Value': 'string',
                'ConfidenceThreshold': 'LOW'|'MEDIUM'|'HIGH'
            }
        },
        'Status': 'string',
        'StatusMessage': 'string'
    }
}

Response Structure

• (dict) –

  • FirewallRule (dict) –

    The firewall rule that you just created.

    • FirewallRuleGroupId (string) –

      The unique identifier of the Firewall rule group of the rule.

    • FirewallDomainListId (string) –

      The ID of the domain list that’s used in the rule.

    • FirewallThreatProtectionId (string) –

      ID of the DNS Firewall Advanced rule.

    • Name (string) –

      The name of the rule.

    • Priority (integer) –

      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.

    • Action (string) –

      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:

      • ALLOW - Permit the request to go through. Not available for DNS Firewall Advanced rules.

      • ALERT - Permit the request to go through but send an alert to the logs.

      • BLOCK - Disallow the request. If this is specified, additional handling details are provided in the rule’s BlockResponse setting.

    • BlockResponse (string) –

      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.

    • BlockOverrideDomain (string) –

      The custom DNS record to send back in response to the query. Used for the rule action BLOCK with a BlockResponse setting of OVERRIDE.

    • BlockOverrideDnsType (string) –

      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.

    • BlockOverrideTtl (integer) –

      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.

    • CreatorRequestId (string) –

      A unique string defined by you to identify the request. This allows you to retry failed requests without the risk of executing the operation twice. This can be any unique string, for example, a timestamp.

    • CreationTime (string) –

      The date and time that the rule was created, in Unix time format and Coordinated Universal Time (UTC).

    • ModificationTime (string) –

      The date and time that the rule was last modified, in Unix time format and Coordinated Universal Time (UTC).

    • FirewallDomainRedirectionAction (string) –

      How you want the the rule to evaluate DNS redirection in the DNS redirection chain, such as CNAME or DNAME.

      INSPECT_REDIRECTION_DOMAIN: (Default) inspects all domains in the redirection chain. The individual domains in the redirection chain must be added to the domain list.

      TRUST_REDIRECTION_DOMAIN: Inspects only the first domain in the redirection chain. You don’t need to add the subsequent domains in the domain in the redirection list to the domain list.

    • Qtype (string) –

      The DNS query type you want the rule to evaluate. Allowed values are;

      • A: Returns an IPv4 address.

      • AAAA: Returns an Ipv6 address.

      • CAA: Restricts CAs that can create SSL/TLS certifications for the domain.

      • CNAME: Returns another domain name.

      • DS: Record that identifies the DNSSEC signing key of a delegated zone.

      • MX: Specifies mail servers.

      • NAPTR: Regular-expression-based rewriting of domain names.

      • NS: Authoritative name servers.

      • PTR: Maps an IP address to a domain name.

      • SOA: Start of authority record for the zone.

      • SPF: Lists the servers authorized to send emails from a domain.

      • SRV: Application specific values that identify servers.

      • TXT: Verifies email senders and application-specific values.

      • A query type you define by using the DNS type ID, for example 28 for AAAA. The values must be defined as TYPENUMBER, where the NUMBER can be 1-65534, for example, TYPE28. For more information, see List of DNS record types.

    • DnsThreatProtection (string) –

      The type of the DNS Firewall Advanced rule. Valid values are:

      • DGA: Domain generation algorithms detection. DGAs are used by attackers to generate a large number of domains to launch malware attacks.

      • DNS_TUNNELING: DNS tunneling detection. DNS tunneling is used by attackers to exfiltrate data from the client by using the DNS tunnel without making a network connection to the client.

      • DICTIONARY_DGA: Dictionary-based domain generation algorithms detection. Dictionary DGAs use wordlists to generate domains that appear more legitimate, making them harder to detect than traditional DGAs.

    • ConfidenceThreshold (string) –

      The confidence threshold for DNS Firewall Advanced. You must provide this value when you create a DNS Firewall Advanced rule. The confidence level values mean:

      • LOW: Provides the highest detection rate for threats, but also increases false positives.

      • MEDIUM: Provides a balance between detecting threats and false positives.

      • HIGH: Detects only the most well corroborated threats with a low rate of false positives.

    • FirewallRuleType (dict) –

      The rule type configuration for the firewall rule. This is a tagged union — exactly one of its members will be populated. Possible members are:

      • FirewallAdvancedContentCategory — an AWS-managed content category (for example, VIOLENCE_AND_HATE_SPEECH).

      • FirewallAdvancedThreatCategory — an AWS-managed advanced threat category (for example, PHISHING).

      • DnsThreatProtection — a built-in DNS Firewall Advanced threat detector ( DGA, DNS_TUNNELING, or DICTIONARY_DGA).

      • PartnerThreatProtection — a third-party threat feed delivered through AWS Marketplace.

      To enumerate the values supported in your account, call ListFirewallRuleTypes.

      • PartnerThreatProtection (dict) –

        Configures the rule to match a third-party threat feed delivered through AWS Marketplace. The calling account must hold an active subscription to the partner product named in Partner; if the subscription is missing or revoked, the rule is created with Status CREATION_FAILED and cannot be modified — only deleted. See PartnerThreatProtectionConfig.

        • Partner (string) –

          The identifier of the partner threat-protection product, exactly as returned in the Value field of a FirewallRuleTypeDefinition with RuleType set to PartnerThreatProtection. The calling account must hold an active AWS Marketplace subscription to this product.

      • FirewallAdvancedContentCategory (dict) –

        Configures the rule to match an AWS-managed content category (for example, VIOLENCE_AND_HATE_SPEECH). See FirewallAdvancedContentCategoryConfig.

        • Category (string) –

          The content category identifier. To retrieve the list of available content categories, call ListFirewallRuleTypes with RuleType set to FirewallAdvancedContentCategory.

      • FirewallAdvancedThreatCategory (dict) –

        Configures the rule to match an AWS-managed advanced threat category (for example, PHISHING). See FirewallAdvancedThreatCategoryConfig.

        • Category (string) –

          The threat category identifier. To retrieve the list of available threat categories, call ListFirewallRuleTypes with RuleType set to FirewallAdvancedThreatCategory.

      • DnsThreatProtection (dict) –

        Configures the rule to match a built-in DNS Firewall Advanced threat detector — DGA, DNS_TUNNELING, or DICTIONARY_DGA. See DnsThreatProtectionRuleTypeConfig.

        • Value (string) –

          The type of DNS threat protection. Valid values are:

          • DGA: Domain generation algorithms detection. DGAs are used by attackers to generate a large number of domains to launch malware attacks.

          • DNS_TUNNELING: DNS tunneling detection. DNS tunneling is used by attackers to exfiltrate data from the client by using the DNS tunnel without making a network connection to the client.

          • DICTIONARY_DGA: Dictionary-based domain generation algorithms detection. Dictionary DGAs use wordlists to generate domains that appear more legitimate, making them harder to detect than traditional DGAs.

        • ConfidenceThreshold (string) –

          The confidence threshold for DNS Firewall Advanced. You must provide this value when you create or update a DNS Firewall Advanced rule. The confidence level values mean:

          • LOW: Provides the highest detection rate for threats, but also increases false positives.

          • MEDIUM: Provides a balance between detecting threats and false positives.

          • HIGH: Detects only the most well corroborated threats with a low rate of false positives.

    • Status (string) –

      The lifecycle state of the firewall rule. Possible values:

      • CREATING — DNS Firewall is provisioning the rule. Rules created with the PartnerThreatProtection rule type begin in this state while DNS Firewall verifies the calling account’s AWS Marketplace entitlement.

      • COMPLETE — The rule is provisioned and enforcing matches.

      • CREATION_FAILED — Provisioning failed. StatusMessage contains a human-readable reason. A rule in this state is immutable: UpdateFirewallRule rejects the request, and the rule must be removed with DeleteFirewallRule.

      For rules that do not require asynchronous provisioning, this field may be absent.

    • StatusMessage (string) –

      An additional message about the rule’s lifecycle state. Populated when Status is CREATION_FAILED to describe why provisioning failed.

Exceptions

• Route53Resolver.Client.exceptions.ResourceNotFoundException

• Route53Resolver.Client.exceptions.ValidationException

• Route53Resolver.Client.exceptions.LimitExceededException

• Route53Resolver.Client.exceptions.AccessDeniedException

• Route53Resolver.Client.exceptions.InternalServiceErrorException

• Route53Resolver.Client.exceptions.ThrottlingException