NAME

Paws::WAFv2 - Perl Interface to AWS AWS WAFV2

SYNOPSIS

use Paws;

my $obj = Paws->service('WAFv2');
my $res = $obj->Method(
  Arg1 => $val1,
  Arg2 => [ 'V1', 'V2' ],
  # if Arg3 is an object, the HashRef will be used as arguments to the constructor
  # of the arguments type
  Arg3 => { Att1 => 'Val1' },
  # if Arg4 is an array of objects, the HashRefs will be passed as arguments to
  # the constructor of the arguments type
  Arg4 => [ { Att1 => 'Val1'  }, { Att1 => 'Val2' } ],
);

DESCRIPTION

This is the latest version of the AWS WAF API, released in November, 2019. The names of the entities that you use to access this API, like endpoints and namespaces, all have the versioning information added, like "V2" or "v2", to distinguish from the prior version. We recommend migrating your resources to this version, because it has a number of significant improvements.

If you used AWS WAF prior to this release, you can't use this AWS WAFV2 API to access any AWS WAF resources that you created before. You can access your old rules, web ACLs, and other AWS WAF resources only through the AWS WAF Classic APIs. The AWS WAF Classic APIs have retained the prior names, endpoints, and namespaces.

For information, including how to migrate your AWS WAF resources to this version, see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html).

AWS WAF is a web application firewall that lets you monitor the HTTP and HTTPS requests that are forwarded to Amazon CloudFront, an Amazon API Gateway API, or an Application Load Balancer. AWS WAF also lets you control access to your content. Based on conditions that you specify, such as the IP addresses that requests originate from or the values of query strings, API Gateway, CloudFront, or the Application Load Balancer responds to requests either with the requested content or with an HTTP 403 status code (Forbidden). You also can configure CloudFront to return a custom error page when a request is blocked.

This API guide is for developers who need detailed information about AWS WAF API actions, data types, and errors. For detailed information about AWS WAF features and an overview of how to use AWS WAF, see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/).

You can make API calls using the endpoints listed in AWS Service Endpoints for AWS WAF (https://docs.aws.amazon.com/general/latest/gr/rande.html#waf_region).

For regional applications, you can use any of the endpoints in the list. A regional application can be an Application Load Balancer (ALB) or an API Gateway stage.
For AWS CloudFront applications, you must use the API endpoint listed for US East (N. Virginia): us-east-1.

Alternatively, you can use one of the AWS SDKs to access an API that's tailored to the programming language or platform that you're using. For more information, see AWS SDKs (http://aws.amazon.com/tools/#SDKs).

We currently provide two versions of the AWS WAF API: this API and the prior versions, the classic AWS WAF APIs. This new API provides the same functionality as the older versions, with the following major improvements:

You use one API for both global and regional applications. Where you need to distinguish the scope, you specify a Scope parameter and set it to CLOUDFRONT or REGIONAL.
You can define a Web ACL or rule group with a single API call, and update it with a single call. You define all rule specifications in JSON format, and pass them to your rule group or Web ACL API calls.
The limits AWS WAF places on the use of rules more closely reflects the cost of running each type of rule. Rule groups include capacity settings, so you know the maximum cost of a rule group when you use it.

For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/wafv2-2019-07-29

METHODS

AssociateWebACL

ResourceArn => Str
WebACLArn => Str

Each argument is described in detail in: Paws::WAFv2::AssociateWebACL

Returns: a Paws::WAFv2::AssociateWebACLResponse instance

This is the latest version of AWS WAF, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html).

Associates a Web ACL with a regional application resource, to protect the resource. A regional application can be an Application Load Balancer (ALB) or an API Gateway stage.

For AWS CloudFront, you can associate the Web ACL by providing the Id of the WebACL to the CloudFront API call UpdateDistribution. For information, see UpdateDistribution (https://docs.aws.amazon.com/cloudfront/latest/APIReference/API_UpdateDistribution.html).

CheckCapacity

Rules => ArrayRef[Paws::WAFv2::Rule]
Scope => Str

Each argument is described in detail in: Paws::WAFv2::CheckCapacity

Returns: a Paws::WAFv2::CheckCapacityResponse instance

Returns the web ACL capacity unit (WCU) requirements for a specified scope and set of rules. You can use this to check the capacity requirements for the rules you want to use in a RuleGroup or WebACL.

AWS WAF uses WCUs to calculate and control the operating resources that are used to run your rules, rule groups, and web ACLs. AWS WAF calculates capacity differently for each rule type, to reflect the relative cost of each rule. Simple rules that cost little to run use fewer WCUs than more complex rules that use more processing power. Rule group capacity is fixed at creation, which helps users plan their web ACL WCU usage when they use a rule group. The WCU limit for web ACLs is 1,500.

CreateIPSet

Addresses => ArrayRef[Str|Undef]
IPAddressVersion => Str
Name => Str
Scope => Str
[Description => Str]
[Tags => ArrayRef[Paws::WAFv2::Tag]]

Each argument is described in detail in: Paws::WAFv2::CreateIPSet

Returns: a Paws::WAFv2::CreateIPSetResponse instance

Creates an IPSet, which you use to identify web requests that originate from specific IP addresses or ranges of IP addresses. For example, if you're receiving a lot of requests from a ranges of IP addresses, you can configure AWS WAF to block them using an IPSet that lists those IP addresses.

CreateRegexPatternSet

Name => Str
RegularExpressionList => ArrayRef[Paws::WAFv2::Regex]
Scope => Str
[Description => Str]
[Tags => ArrayRef[Paws::WAFv2::Tag]]

Each argument is described in detail in: Paws::WAFv2::CreateRegexPatternSet

Returns: a Paws::WAFv2::CreateRegexPatternSetResponse instance

Creates a RegexPatternSet per the specifications provided.

CreateRuleGroup

Capacity => Int
Name => Str
Scope => Str
VisibilityConfig => Paws::WAFv2::VisibilityConfig
[Description => Str]
[Rules => ArrayRef[Paws::WAFv2::Rule]]
[Tags => ArrayRef[Paws::WAFv2::Tag]]

Each argument is described in detail in: Paws::WAFv2::CreateRuleGroup

Returns: a Paws::WAFv2::CreateRuleGroupResponse instance

Creates a RuleGroup per the specifications provided.

A rule group defines a collection of rules to inspect and control web requests that you can use in a WebACL. When you create a rule group, you define an immutable capacity limit. If you update a rule group, you must stay within the capacity. This allows others to reuse the rule group with confidence in its capacity requirements.

CreateWebACL

DefaultAction => Paws::WAFv2::DefaultAction
Name => Str
Scope => Str
VisibilityConfig => Paws::WAFv2::VisibilityConfig
[Description => Str]
[Rules => ArrayRef[Paws::WAFv2::Rule]]
[Tags => ArrayRef[Paws::WAFv2::Tag]]

Each argument is described in detail in: Paws::WAFv2::CreateWebACL

Returns: a Paws::WAFv2::CreateWebACLResponse instance

Creates a WebACL per the specifications provided.

A Web ACL defines a collection of rules to use to inspect and control web requests. Each rule has an action defined (allow, block, or count) for requests that match the statement of the rule. In the Web ACL, you assign a default action to take (allow, block) for any request that does not match any of the rules. The rules in a Web ACL can be a combination of the types Rule, RuleGroup, and managed rule group. You can associate a Web ACL with one or more AWS resources to protect. The resources can be Amazon CloudFront, an Amazon API Gateway API, or an Application Load Balancer.

DeleteIPSet

Id => Str
LockToken => Str
Name => Str
Scope => Str

Each argument is described in detail in: Paws::WAFv2::DeleteIPSet

Returns: a Paws::WAFv2::DeleteIPSetResponse instance

Deletes the specified IPSet.

DeleteLoggingConfiguration

ResourceArn => Str

Each argument is described in detail in: Paws::WAFv2::DeleteLoggingConfiguration

Returns: a Paws::WAFv2::DeleteLoggingConfigurationResponse instance

Deletes the LoggingConfiguration from the specified web ACL.

DeleteRegexPatternSet

Id => Str
LockToken => Str
Name => Str
Scope => Str

Each argument is described in detail in: Paws::WAFv2::DeleteRegexPatternSet

Returns: a Paws::WAFv2::DeleteRegexPatternSetResponse instance

Deletes the specified RegexPatternSet.

DeleteRuleGroup

Id => Str
LockToken => Str
Name => Str
Scope => Str

Each argument is described in detail in: Paws::WAFv2::DeleteRuleGroup

Returns: a Paws::WAFv2::DeleteRuleGroupResponse instance

Deletes the specified RuleGroup.

DeleteWebACL

Id => Str
LockToken => Str
Name => Str
Scope => Str

Each argument is described in detail in: Paws::WAFv2::DeleteWebACL

Returns: a Paws::WAFv2::DeleteWebACLResponse instance

Deletes the specified WebACL.

DescribeManagedRuleGroup

Name => Str
Scope => Str
VendorName => Str

Each argument is described in detail in: Paws::WAFv2::DescribeManagedRuleGroup

Returns: a Paws::WAFv2::DescribeManagedRuleGroupResponse instance

Provides high-level information for a managed rule group, including descriptions of the rules.

DisassociateWebACL

ResourceArn => Str

Each argument is described in detail in: Paws::WAFv2::DisassociateWebACL

Returns: a Paws::WAFv2::DisassociateWebACLResponse instance

Disassociates a Web ACL from a regional application resource. A regional application can be an Application Load Balancer (ALB) or an API Gateway stage.

For AWS CloudFront, you can disassociate the Web ACL by providing an empty WebACLId in the CloudFront API call UpdateDistribution. For information, see UpdateDistribution (https://docs.aws.amazon.com/cloudfront/latest/APIReference/API_UpdateDistribution.html).

GetIPSet

Id => Str
Name => Str
Scope => Str

Each argument is described in detail in: Paws::WAFv2::GetIPSet

Returns: a Paws::WAFv2::GetIPSetResponse instance

Retrieves the specified IPSet.

GetLoggingConfiguration

ResourceArn => Str

Each argument is described in detail in: Paws::WAFv2::GetLoggingConfiguration

Returns: a Paws::WAFv2::GetLoggingConfigurationResponse instance

Returns the LoggingConfiguration for the specified web ACL.

GetRateBasedStatementManagedKeys

RuleName => Str
Scope => Str
WebACLId => Str
WebACLName => Str

Each argument is described in detail in: Paws::WAFv2::GetRateBasedStatementManagedKeys

Returns: a Paws::WAFv2::GetRateBasedStatementManagedKeysResponse instance

Retrieves the keys that are currently blocked by a rate-based rule. The maximum number of managed keys that can be blocked for a single rate-based rule is 10,000. If more than 10,000 addresses exceed the rate limit, those with the highest rates are blocked.

GetRegexPatternSet

Id => Str
Name => Str
Scope => Str

Each argument is described in detail in: Paws::WAFv2::GetRegexPatternSet

Returns: a Paws::WAFv2::GetRegexPatternSetResponse instance

Retrieves the specified RegexPatternSet.

GetRuleGroup

Id => Str
Name => Str
Scope => Str

Each argument is described in detail in: Paws::WAFv2::GetRuleGroup

Returns: a Paws::WAFv2::GetRuleGroupResponse instance

Retrieves the specified RuleGroup.

GetSampledRequests

MaxItems => Int
RuleMetricName => Str
Scope => Str
TimeWindow => Paws::WAFv2::TimeWindow
WebAclArn => Str

Each argument is described in detail in: Paws::WAFv2::GetSampledRequests

Returns: a Paws::WAFv2::GetSampledRequestsResponse instance

Gets detailed information about a specified number of requests--a sample--that AWS WAF randomly selects from among the first 5,000 requests that your AWS resource received during a time range that you choose. You can specify a sample size of up to 500 requests, and you can specify any time range in the previous three hours.

GetSampledRequests returns a time range, which is usually the time range that you specified. However, if your resource (such as a CloudFront distribution) received 5,000 requests before the specified time range elapsed, GetSampledRequests returns an updated time range. This new time range indicates the actual period during which AWS WAF selected the requests in the sample.

GetWebACL

Id => Str
Name => Str
Scope => Str

Each argument is described in detail in: Paws::WAFv2::GetWebACL

Returns: a Paws::WAFv2::GetWebACLResponse instance

Retrieves the specified WebACL.

GetWebACLForResource

ResourceArn => Str

Each argument is described in detail in: Paws::WAFv2::GetWebACLForResource

Returns: a Paws::WAFv2::GetWebACLForResourceResponse instance

Retrieves the WebACL for the specified resource.

ListAvailableManagedRuleGroups

Scope => Str
[Limit => Int]
[NextMarker => Str]

Each argument is described in detail in: Paws::WAFv2::ListAvailableManagedRuleGroups

Returns: a Paws::WAFv2::ListAvailableManagedRuleGroupsResponse instance

Retrieves an array of managed rule groups that are available for you to use. This list includes all AWS managed rule groups and the AWS Marketplace managed rule groups that you're subscribed to.

ListIPSets

Scope => Str
[Limit => Int]
[NextMarker => Str]

Each argument is described in detail in: Paws::WAFv2::ListIPSets

Returns: a Paws::WAFv2::ListIPSetsResponse instance

Retrieves an array of IPSetSummary objects for the IP sets that you manage.

ListLoggingConfigurations

[Limit => Int]
[NextMarker => Str]
[Scope => Str]

Each argument is described in detail in: Paws::WAFv2::ListLoggingConfigurations

Returns: a Paws::WAFv2::ListLoggingConfigurationsResponse instance

Retrieves an array of your LoggingConfiguration objects.

ListRegexPatternSets

Scope => Str
[Limit => Int]
[NextMarker => Str]

Each argument is described in detail in: Paws::WAFv2::ListRegexPatternSets

Returns: a Paws::WAFv2::ListRegexPatternSetsResponse instance

Retrieves an array of RegexPatternSetSummary objects for the regex pattern sets that you manage.

ListResourcesForWebACL

WebACLArn => Str
[ResourceType => Str]

Each argument is described in detail in: Paws::WAFv2::ListResourcesForWebACL

Returns: a Paws::WAFv2::ListResourcesForWebACLResponse instance

Retrieves an array of the Amazon Resource Names (ARNs) for the regional resources that are associated with the specified web ACL. If you want the list of AWS CloudFront resources, use the AWS CloudFront call ListDistributionsByWebACLId.

ListRuleGroups

Scope => Str
[Limit => Int]
[NextMarker => Str]

Each argument is described in detail in: Paws::WAFv2::ListRuleGroups

Returns: a Paws::WAFv2::ListRuleGroupsResponse instance

Retrieves an array of RuleGroupSummary objects for the rule groups that you manage.

ListTagsForResource

ResourceARN => Str
[Limit => Int]
[NextMarker => Str]

Each argument is described in detail in: Paws::WAFv2::ListTagsForResource

Returns: a Paws::WAFv2::ListTagsForResourceResponse instance

Retrieves the TagInfoForResource for the specified resource.

ListWebACLs

Scope => Str
[Limit => Int]
[NextMarker => Str]

Each argument is described in detail in: Paws::WAFv2::ListWebACLs

Returns: a Paws::WAFv2::ListWebACLsResponse instance

Retrieves an array of WebACLSummary objects for the web ACLs that you manage.

PutLoggingConfiguration

LoggingConfiguration => Paws::WAFv2::LoggingConfiguration

Each argument is described in detail in: Paws::WAFv2::PutLoggingConfiguration

Returns: a Paws::WAFv2::PutLoggingConfigurationResponse instance

Enables the specified LoggingConfiguration, to start logging from a web ACL, according to the configuration provided.

You can access information about all traffic that AWS WAF inspects using the following steps:

Create an Amazon Kinesis Data Firehose.

Create the data firehose with a PUT source and in the region that you are operating. If you are capturing logs for Amazon CloudFront, always create the firehose in US East (N. Virginia).

Do not create the data firehose using a Kinesis stream as your source.
Associate that firehose to your web ACL using a PutLoggingConfiguration request.

When you successfully enable logging using a PutLoggingConfiguration request, AWS WAF will create a service linked role with the necessary permissions to write logs to the Amazon Kinesis Data Firehose. For more information, see Logging Web ACL Traffic Information (https://docs.aws.amazon.com/waf/latest/developerguide/logging.html) in the AWS WAF Developer Guide.

TagResource

ResourceARN => Str
Tags => ArrayRef[Paws::WAFv2::Tag]

Each argument is described in detail in: Paws::WAFv2::TagResource

Returns: a Paws::WAFv2::TagResourceResponse instance

Associates tags with the specified AWS resource. Tags are key:value pairs that you can associate with AWS resources. For example, the tag key might be "customer" and the tag value might be "companyA." You can specify one or more tags to add to each container. You can add up to 50 tags to each AWS resource.

UntagResource

ResourceARN => Str
TagKeys => ArrayRef[Str|Undef]

Each argument is described in detail in: Paws::WAFv2::UntagResource

Returns: a Paws::WAFv2::UntagResourceResponse instance

Disassociates tags from an AWS resource. Tags are key:value pairs that you can associate with AWS resources. For example, the tag key might be "customer" and the tag value might be "companyA." You can specify one or more tags to add to each container. You can add up to 50 tags to each AWS resource.

UpdateIPSet

Addresses => ArrayRef[Str|Undef]
Id => Str
LockToken => Str
Name => Str
Scope => Str
[Description => Str]

Each argument is described in detail in: Paws::WAFv2::UpdateIPSet

Returns: a Paws::WAFv2::UpdateIPSetResponse instance

Updates the specified IPSet.

UpdateRegexPatternSet

Id => Str
LockToken => Str
Name => Str
RegularExpressionList => ArrayRef[Paws::WAFv2::Regex]
Scope => Str
[Description => Str]

Each argument is described in detail in: Paws::WAFv2::UpdateRegexPatternSet

Returns: a Paws::WAFv2::UpdateRegexPatternSetResponse instance

Updates the specified RegexPatternSet.

UpdateRuleGroup

Id => Str
LockToken => Str
Name => Str
Scope => Str
VisibilityConfig => Paws::WAFv2::VisibilityConfig
[Description => Str]
[Rules => ArrayRef[Paws::WAFv2::Rule]]

Each argument is described in detail in: Paws::WAFv2::UpdateRuleGroup

Returns: a Paws::WAFv2::UpdateRuleGroupResponse instance

Updates the specified RuleGroup.

UpdateWebACL

DefaultAction => Paws::WAFv2::DefaultAction
Id => Str
LockToken => Str
Name => Str
Scope => Str
VisibilityConfig => Paws::WAFv2::VisibilityConfig
[Description => Str]
[Rules => ArrayRef[Paws::WAFv2::Rule]]

Each argument is described in detail in: Paws::WAFv2::UpdateWebACL

Returns: a Paws::WAFv2::UpdateWebACLResponse instance

Updates the specified WebACL.

PAGINATORS

Paginator methods are helpers that repetively call methods that return partial results

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

To install Paws::SDK::Config, copy and paste the appropriate command in to your terminal.

cpanm

cpanm Paws::SDK::Config

CPAN shell

perl -MCPAN -e shell
install Paws::SDK::Config

For more information on module installation, please visit the detailed CPAN module installation guide.

	Global
`s`	Focus search bar
`?`	Bring up this help dialog

	GitHub
`g` `p`	Go to pull requests
`g` `i`	Go to GitHub issues (only if GitHub is preferred repository)

	POD
`g` `a`	Go to author
`g` `c`	Go to changes
`g` `i`	Go to issues
`g` `d`	Go to dist
`g` `r`	Go to repository/SCM
`g` `s`	Go to source
`g` `b`	Go to file browse

	Search terms
module: (e.g. module:Plugin)
distribution: (e.g. distribution:Dancer auth)
author: (e.g. author:SONGMU Redis)
version: (e.g. version:1.00)