class Aws::Route53Resolver::Types::CreateFirewallRuleRequest

@note When making an API call, you may pass CreateFirewallRuleRequest

data as a hash:

    {
      creator_request_id: "CreatorRequestId", # required
      firewall_rule_group_id: "ResourceId", # required
      firewall_domain_list_id: "ResourceId", # required
      priority: 1, # required
      action: "ALLOW", # required, accepts ALLOW, BLOCK, ALERT
      block_response: "NODATA", # accepts NODATA, NXDOMAIN, OVERRIDE
      block_override_domain: "BlockOverrideDomain",
      block_override_dns_type: "CNAME", # accepts CNAME
      block_override_ttl: 1,
      name: "Name", # required
    }

@!attribute [rw] creator_request_id

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.

**A suitable default value is auto-generated.** You should normally
not need to pass this option.
@return [String]

@!attribute [rw] firewall_rule_group_id

The unique identifier of the firewall rule group where you want to
create the rule.
@return [String]

@!attribute [rw] firewall_domain_list_id

The ID of the domain list that you want to use in the rule.
@return [String]

@!attribute [rw] 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.
@return [Integer]

@!attribute [rw] 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 and send metrics and logs to Cloud
  Watch.

* `BLOCK` - Disallow the request. This option requires additional
  details in the rule's `BlockResponse`.
@return [String]

@!attribute [rw] block_response

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`.
@return [String]

@!attribute [rw] block_override_domain

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`.
@return [String]

@!attribute [rw] block_override_dns_type

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`.
@return [String]

@!attribute [rw] block_override_ttl

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`.
@return [Integer]

@!attribute [rw] name

A name that lets you identify the rule in the rule group.
@return [String]

@see docs.aws.amazon.com/goto/WebAPI/route53resolver-2018-04-01/CreateFirewallRuleRequest AWS API Documentation

Constants

SENSITIVE