NAME

Paws::Route53Resolver::CreateFirewallRule - Arguments for method CreateFirewallRule on Paws::Route53Resolver

DESCRIPTION

This class represents the parameters used for calling the method CreateFirewallRule on the Amazon Route 53 Resolver service. Use the attributes of this class as arguments to method CreateFirewallRule.

You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateFirewallRule.

SYNOPSIS

    my $route53resolver = Paws->service('Route53Resolver');
    my $CreateFirewallRuleResponse = $route53resolver->CreateFirewallRule(
      Action               => 'ALLOW',
      CreatorRequestId     => 'MyCreatorRequestId',
      FirewallDomainListId => 'MyResourceId',
      FirewallRuleGroupId  => 'MyResourceId',
      Name                 => 'MyName',
      Priority             => 1,
      BlockOverrideDnsType => 'CNAME',                    # OPTIONAL
      BlockOverrideDomain  => 'MyBlockOverrideDomain',    # OPTIONAL
      BlockOverrideTtl     => 1,                          # OPTIONAL
      BlockResponse        => 'NODATA',                   # OPTIONAL
    );
    # Results:
    my $FirewallRule = $CreateFirewallRuleResponse->FirewallRule;
    # Returns a L<Paws::Route53Resolver::CreateFirewallRuleResponse> object.

Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. For the AWS API documentation, see <https://docs.aws.amazon.com/goto/WebAPI/route53resolver/CreateFirewallRule>

ATTRIBUTES

REQUIRED Action => Str

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

Valid values are: "ALLOW", "BLOCK", "ALERT"

BlockOverrideDnsType => Str

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

Valid values are: "CNAME"

BlockOverrideDomain => Str

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

BlockOverrideTtl => Int

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

BlockResponse => Str

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

Valid values are: "NODATA", "NXDOMAIN", "OVERRIDE"

REQUIRED CreatorRequestId => Str

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.

REQUIRED FirewallDomainListId => Str

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

REQUIRED FirewallRuleGroupId => Str

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

REQUIRED Name => Str

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

REQUIRED Priority => Int

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.

BUGS and CONTRIBUTIONS

The source code is located here: <https://github.com/pplu/aws-sdk-perl>

Please report bugs to: <https://github.com/pplu/aws-sdk-perl/issues>