FirewallRule - Amazon Route 53

FirewallRule

A single firewall rule in a rule group.

Contents

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

Type: String

Valid Values: ALLOW | BLOCK | ALERT

Required: No

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

Valid Values: CNAME

Required: No

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

Length Constraints: Minimum length of 1. Maximum length of 255.

Required: No

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

Required: No

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

Valid Values: NODATA | NXDOMAIN | OVERRIDE

Required: No

CreationTime

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

Type: String

Length Constraints: Minimum length of 20. Maximum length of 40.

Required: No

CreatorRequestId

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.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Required: No

FirewallDomainListId

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Required: No

FirewallRuleGroupId

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Required: No

ModificationTime

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

Type: String

Length Constraints: Minimum length of 20. Maximum length of 40.

Required: No

Name

The name of the rule.

Type: String

Length Constraints: Maximum length of 64.

Pattern: (?!^[0-9]+$)([a-zA-Z0-9\-_' ']+)

Required: No

Priority

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.

Type: Integer

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: