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, using the specified domain list.

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'
)

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) –
[REQUIRED]

The ID of the domain list that you want to use in the rule.
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:
- 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.
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-65334, for example, TYPE28. For more information, see List of DNS record types.

Return type:

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

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