Amazon Route 53 Resolver

2024/04/30 - Amazon Route 53 Resolver - 4 updated api methods

Changes  Release of FirewallDomainRedirectionAction parameter on the Route 53 DNS Firewall Rule. This allows customers to configure a DNS Firewall rule to inspect all the domains in the DNS redirection chain (default) , such as CNAME, ALIAS, DNAME, etc., or just the first domain and trust the rest.

CreateFirewallRule (updated) Link ¶
Changes (request, response)
Request 
{'FirewallDomainRedirectionAction': 'INSPECT_REDIRECTION_DOMAIN | '
                                    'TRUST_REDIRECTION_DOMAIN'}
Response 
{'FirewallRule': {'FirewallDomainRedirectionAction': 'INSPECT_REDIRECTION_DOMAIN '
                                                     '| '
                                                     'TRUST_REDIRECTION_DOMAIN'}}

Creates a single DNS Firewall rule in the specified rule group, using the specified domain list.

See also: AWS API Documentation

Request Syntax

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'
)
type CreatorRequestId:

string

param CreatorRequestId:

[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.

type FirewallRuleGroupId:

string

param FirewallRuleGroupId:

[REQUIRED]

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

type FirewallDomainListId:

string

param FirewallDomainListId:

[REQUIRED]

The ID of the domain list that you want to use in the rule.

type Priority:

integer

param Priority:

[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.

type Action:

string

param Action:

[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:

  • ALLOW - Permit the request to go through.

  • 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.

type BlockResponse:

string

param BlockResponse:

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.

type BlockOverrideDomain:

string

param BlockOverrideDomain:

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.

type BlockOverrideDnsType:

string

param BlockOverrideDnsType:

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.

type BlockOverrideTtl:

integer

param BlockOverrideTtl:

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.

type Name:

string

param Name:

[REQUIRED]

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

type FirewallDomainRedirectionAction:

string

param FirewallDomainRedirectionAction:

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

``Inspect_Redirection_Domain ``(Default) inspects all domains in the redirection chain. The individual domains in the redirection chain must be added to the allow 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 redirection list to the domain alloww list.

type Qtype:

string

param Qtype:

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-65334, for example, TYPE28. For more information, see List of DNS record types.

rtype:

dict

returns:

Response Syntax

{
    'FirewallRule': {
        'FirewallRuleGroupId': 'string',
        'FirewallDomainListId': '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'
    }
}

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.

      • 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:

        • 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, 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, DNAME, ot ALIAS.

        ``Inspect_Redirection_Domain ``(Default) inspects all domains in the redirection chain. The individual domains in the redirection chain must be added to the allow 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 alloww 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-65334, for example, TYPE28. For more information, see List of DNS record types.

DeleteFirewallRule (updated) Link ¶
Changes (response) 
{'FirewallRule': {'FirewallDomainRedirectionAction': 'INSPECT_REDIRECTION_DOMAIN '
                                                     '| '
                                                     'TRUST_REDIRECTION_DOMAIN'}}

Deletes the specified firewall rule.

See also: AWS API Documentation

Request Syntax

client.delete_firewall_rule(
    FirewallRuleGroupId='string',
    FirewallDomainListId='string',
    Qtype='string'
)
type FirewallRuleGroupId:

string

param FirewallRuleGroupId:

[REQUIRED]

The unique identifier of the firewall rule group that you want to delete the rule from.

type FirewallDomainListId:

string

param FirewallDomainListId:

[REQUIRED]

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

type Qtype:

string

param Qtype:

The DNS query type that the rule you are deleting evaluates. 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-65334, for example, TYPE28. For more information, see List of DNS record types.

rtype:

dict

returns:

Response Syntax

{
    'FirewallRule': {
        'FirewallRuleGroupId': 'string',
        'FirewallDomainListId': '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'
    }
}

Response Structure

  • (dict) --

    • FirewallRule (dict) --

      The specification for the firewall rule that you just deleted.

      • 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.

      • 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:

        • 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, 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, DNAME, ot ALIAS.

        ``Inspect_Redirection_Domain ``(Default) inspects all domains in the redirection chain. The individual domains in the redirection chain must be added to the allow 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 alloww 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-65334, for example, TYPE28. For more information, see List of DNS record types.

ListFirewallRules (updated) Link ¶
Changes (response) 
{'FirewallRules': {'FirewallDomainRedirectionAction': 'INSPECT_REDIRECTION_DOMAIN '
                                                      '| '
                                                      'TRUST_REDIRECTION_DOMAIN'}}

Retrieves the firewall rules that you have defined for the specified firewall rule group. DNS Firewall uses the rules in a rule group to filter DNS network traffic for a VPC.

A single call might return only a partial list of the rules. For information, see MaxResults.

See also: AWS API Documentation

Request Syntax

client.list_firewall_rules(
    FirewallRuleGroupId='string',
    Priority=123,
    Action='ALLOW'|'BLOCK'|'ALERT',
    MaxResults=123,
    NextToken='string'
)
type FirewallRuleGroupId:

string

param FirewallRuleGroupId:

[REQUIRED]

The unique identifier of the firewall rule group that you want to retrieve the rules for.

type Priority:

integer

param Priority:

Optional additional filter for the rules to retrieve.

The setting that determines the processing order of the rules in a rule group. DNS Firewall processes the rules in a rule group by order of priority, starting from the lowest setting.

type Action:

string

param Action:

Optional additional filter for the rules to retrieve.

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, additional handling details are provided in the rule's BlockResponse setting.

type MaxResults:

integer

param MaxResults:

The maximum number of objects that you want Resolver to return for this request. If more objects are available, in the response, Resolver provides a NextToken value that you can use in a subsequent call to get the next batch of objects.

If you don't specify a value for MaxResults, Resolver returns up to 100 objects.

type NextToken:

string

param NextToken:

For the first call to this list request, omit this value.

When you request a list of objects, Resolver returns at most the number of objects specified in MaxResults. If more objects are available for retrieval, Resolver returns a NextToken value in the response. To retrieve the next batch of objects, use the token that was returned for the prior request in your next request.

rtype:

dict

returns:

Response Syntax

{
    'NextToken': 'string',
    'FirewallRules': [
        {
            'FirewallRuleGroupId': 'string',
            'FirewallDomainListId': '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'
        },
    ]
}

Response Structure

  • (dict) --

    • NextToken (string) --

      If objects are still available for retrieval, Resolver returns this token in the response. To retrieve the next batch of objects, provide this token in your next request.

    • FirewallRules (list) --

      A list of the rules that you have defined.

      This might be a partial list of the firewall rules that you've defined. For information, see MaxResults.

      • (dict) --

        A single firewall rule in a rule group.

        • 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.

        • 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:

          • 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, 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, DNAME, ot ALIAS.

          ``Inspect_Redirection_Domain ``(Default) inspects all domains in the redirection chain. The individual domains in the redirection chain must be added to the allow 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 alloww 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-65334, for example, TYPE28. For more information, see List of DNS record types.

UpdateFirewallRule (updated) Link ¶
Changes (request, response)
Request 
{'FirewallDomainRedirectionAction': 'INSPECT_REDIRECTION_DOMAIN | '
                                    'TRUST_REDIRECTION_DOMAIN'}
Response 
{'FirewallRule': {'FirewallDomainRedirectionAction': 'INSPECT_REDIRECTION_DOMAIN '
                                                     '| '
                                                     'TRUST_REDIRECTION_DOMAIN'}}

Updates the specified firewall rule.

See also: AWS API Documentation

Request Syntax

client.update_firewall_rule(
    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'
)
type FirewallRuleGroupId:

string

param FirewallRuleGroupId:

[REQUIRED]

The unique identifier of the firewall rule group for the rule.

type FirewallDomainListId:

string

param FirewallDomainListId:

[REQUIRED]

The ID of the domain list to use in the rule.

type Priority:

integer

param Priority:

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.

type Action:

string

param Action:

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. This option requires additional details in the rule's BlockResponse.

type BlockResponse:

string

param BlockResponse:

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.

type BlockOverrideDomain:

string

param BlockOverrideDomain:

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

type BlockOverrideDnsType:

string

param BlockOverrideDnsType:

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.

type BlockOverrideTtl:

integer

param BlockOverrideTtl:

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.

type Name:

string

param Name:

The name of the rule.

type FirewallDomainRedirectionAction:

string

param FirewallDomainRedirectionAction:

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

``Inspect_Redirection_Domain ``(Default) inspects all domains in the redirection chain. The individual domains in the redirection chain must be added to the allow 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 alloww list.

type Qtype:

string

param Qtype:

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-65334, for example, TYPE28. For more information, see List of DNS record types.

rtype:

dict

returns:

Response Syntax

{
    'FirewallRule': {
        'FirewallRuleGroupId': 'string',
        'FirewallDomainListId': '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'
    }
}

Response Structure

  • (dict) --

    • FirewallRule (dict) --

      The firewall rule that you just updated.

      • 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.

      • 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:

        • 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, 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, DNAME, ot ALIAS.

        ``Inspect_Redirection_Domain ``(Default) inspects all domains in the redirection chain. The individual domains in the redirection chain must be added to the allow 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 alloww 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-65334, for example, TYPE28. For more information, see List of DNS record types.