github.com/aavshr/aws-sdk-go@v1.41.3/service/wafv2/doc.go (about)

     1  // Code generated by private/model/cli/gen-api/main.go. DO NOT EDIT.
     2  
     3  // Package wafv2 provides the client and types for making API
     4  // requests to AWS WAFV2.
     5  //
     6  //
     7  // This is the latest version of the WAF API, released in November, 2019. The
     8  // names of the entities that you use to access this API, like endpoints and
     9  // namespaces, all have the versioning information added, like "V2" or "v2",
    10  // to distinguish from the prior version. We recommend migrating your resources
    11  // to this version, because it has a number of significant improvements.
    12  //
    13  // If you used WAF prior to this release, you can't use this WAFV2 API to access
    14  // any WAF resources that you created before. You can access your old rules,
    15  // web ACLs, and other WAF resources only through the WAF Classic APIs. The
    16  // WAF Classic APIs have retained the prior names, endpoints, and namespaces.
    17  //
    18  // For information, including how to migrate your WAF resources to this version,
    19  // see the WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html).
    20  //
    21  // WAF is a web application firewall that lets you monitor the HTTP and HTTPS
    22  // requests that are forwarded to Amazon CloudFront, an Amazon API Gateway REST
    23  // API, an Application Load Balancer, or an AppSync GraphQL API. WAF also lets
    24  // you control access to your content. Based on conditions that you specify,
    25  // such as the IP addresses that requests originate from or the values of query
    26  // strings, the Amazon API Gateway REST API, CloudFront distribution, the Application
    27  // Load Balancer, or the AppSync GraphQL API responds to requests either with
    28  // the requested content or with an HTTP 403 status code (Forbidden). You also
    29  // can configure CloudFront to return a custom error page when a request is
    30  // blocked.
    31  //
    32  // This API guide is for developers who need detailed information about WAF
    33  // API actions, data types, and errors. For detailed information about WAF features
    34  // 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).
    35  //
    36  // You can make calls using the endpoints listed in WAF endpoints and quotas
    37  // (https://docs.aws.amazon.com/general/latest/gr/waf.html).
    38  //
    39  //    * For regional applications, you can use any of the endpoints in the list.
    40  //    A regional application can be an Application Load Balancer (ALB), an Amazon
    41  //    API Gateway REST API, or an AppSync GraphQL API.
    42  //
    43  //    * For Amazon CloudFront applications, you must use the API endpoint listed
    44  //    for US East (N. Virginia): us-east-1.
    45  //
    46  // Alternatively, you can use one of the Amazon Web Services SDKs to access
    47  // an API that's tailored to the programming language or platform that you're
    48  // using. For more information, see Amazon Web Services SDKs (http://aws.amazon.com/tools/#SDKs).
    49  //
    50  // We currently provide two versions of the WAF API: this API and the prior
    51  // versions, the classic WAF APIs. This new API provides the same functionality
    52  // as the older versions, with the following major improvements:
    53  //
    54  //    * You use one API for both global and regional applications. Where you
    55  //    need to distinguish the scope, you specify a Scope parameter and set it
    56  //    to CLOUDFRONT or REGIONAL.
    57  //
    58  //    * You can define a web ACL or rule group with a single call, and update
    59  //    it with a single call. You define all rule specifications in JSON format,
    60  //    and pass them to your rule group or web ACL calls.
    61  //
    62  //    * The limits WAF places on the use of rules more closely reflects the
    63  //    cost of running each type of rule. Rule groups include capacity settings,
    64  //    so you know the maximum cost of a rule group when you use it.
    65  //
    66  // See https://docs.aws.amazon.com/goto/WebAPI/wafv2-2019-07-29 for more information on this service.
    67  //
    68  // See wafv2 package documentation for more information.
    69  // https://docs.aws.amazon.com/sdk-for-go/api/service/wafv2/
    70  //
    71  // Using the Client
    72  //
    73  // To contact AWS WAFV2 with the SDK use the New function to create
    74  // a new service client. With that client you can make API requests to the service.
    75  // These clients are safe to use concurrently.
    76  //
    77  // See the SDK's documentation for more information on how to use the SDK.
    78  // https://docs.aws.amazon.com/sdk-for-go/api/
    79  //
    80  // See aws.Config documentation for more information on configuring SDK clients.
    81  // https://docs.aws.amazon.com/sdk-for-go/api/aws/#Config
    82  //
    83  // See the AWS WAFV2 client WAFV2 for more
    84  // information on creating client for this service.
    85  // https://docs.aws.amazon.com/sdk-for-go/api/service/wafv2/#New
    86  package wafv2