Cloudpods/backend/vendor/github.com/aws/aws-sdk-go/service/wafv2/doc.go

// Code generated by private/model/cli/gen-api/main.go. DO NOT EDIT.

// Package wafv2 provides the client and types for making API
// requests to AWS WAFV2.
//
// This is the latest version of the 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 WAF prior to this release, you can't use this WAFV2 API to access
// any WAF resources that you created before. You can access your old rules,
// web ACLs, and other WAF resources only through the WAF Classic APIs. The
// WAF Classic APIs have retained the prior names, endpoints, and namespaces.
//
// For information, including how to migrate your WAF resources to this version,
// see the WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html).
//
// 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 REST
// API, an Application Load Balancer, an AppSync GraphQL API, or an Amazon Cognito
// user pool. 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, the Amazon API Gateway REST API, CloudFront
// distribution, the Application Load Balancer, the AppSync GraphQL API, or
// the Amazon Cognito user pool 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 WAF
// API actions, data types, and errors. For detailed information about WAF features
// and an overview of how to use WAF, see the WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/what-is-aws-waf.html).
//
// You can make calls using the endpoints listed in WAF endpoints and quotas
// (https://docs.aws.amazon.com/general/latest/gr/waf.html).
//
//   - For regional applications, you can use any of the endpoints in the list.
//     A regional application can be an Application Load Balancer (ALB), an Amazon
//     API Gateway REST API, an AppSync GraphQL API, or an Amazon Cognito user
//     pool.
//
//   - For Amazon CloudFront applications, you must use the API endpoint listed
//     for US East (N. Virginia): us-east-1.
//
// Alternatively, you can use one of the Amazon Web Services SDKs to access
// an API that's tailored to the programming language or platform that you're
// using. For more information, see Amazon Web Services SDKs (http://aws.amazon.com/tools/#SDKs).
//
// We currently provide two versions of the WAF API: this API and the prior
// versions, the classic 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 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 calls.
//
//   - The limits 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.
//
// See https://docs.aws.amazon.com/goto/WebAPI/wafv2-2019-07-29 for more information on this service.
//
// See wafv2 package documentation for more information.
// https://docs.aws.amazon.com/sdk-for-go/api/service/wafv2/
//
// # Using the Client
//
// To contact AWS WAFV2 with the SDK use the New function to create
// a new service client. With that client you can make API requests to the service.
// These clients are safe to use concurrently.
//
// See the SDK's documentation for more information on how to use the SDK.
// https://docs.aws.amazon.com/sdk-for-go/api/
//
// See aws.Config documentation for more information on configuring SDK clients.
// https://docs.aws.amazon.com/sdk-for-go/api/aws/#Config
//
// See the AWS WAFV2 client WAFV2 for more
// information on creating client for this service.
// https://docs.aws.amazon.com/sdk-for-go/api/service/wafv2/#New
package wafv2