1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208
|
// Code generated by smithy-go-codegen DO NOT EDIT.
package waf
import (
"context"
"fmt"
awsmiddleware "github.com/aws/aws-sdk-go-v2/aws/middleware"
"github.com/aws/aws-sdk-go-v2/aws/signer/v4"
"github.com/aws/aws-sdk-go-v2/service/waf/types"
"github.com/aws/smithy-go/middleware"
smithyhttp "github.com/aws/smithy-go/transport/http"
)
// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html)
// in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API
// and see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html)
// . With the latest version, AWS WAF has a single set of endpoints for regional
// and global use. Inserts or deletes ActivatedRule objects in a WebACL . Each Rule
// identifies web requests that you want to allow, block, or count. When you update
// a WebACL , you specify the following values:
// - A default action for the WebACL , either ALLOW or BLOCK . AWS WAF performs
// the default action if a request doesn't match the criteria in any of the Rules
// in a WebACL .
// - The Rules that you want to add or delete. If you want to replace one Rule
// with another, you delete the existing Rule and add the new one.
// - For each Rule , whether you want AWS WAF to allow requests, block requests,
// or count requests that match the conditions in the Rule .
// - The order in which you want AWS WAF to evaluate the Rules in a WebACL . If
// you add more than one Rule to a WebACL , AWS WAF evaluates each request
// against the Rules in order based on the value of Priority . (The Rule that has
// the lowest value for Priority is evaluated first.) When a web request matches
// all the predicates (such as ByteMatchSets and IPSets ) in a Rule , AWS WAF
// immediately takes the corresponding action, allow or block, and doesn't evaluate
// the request against the remaining Rules in the WebACL , if any.
//
// To create and configure a WebACL , perform the following steps:
// - Create and update the predicates that you want to include in Rules . For
// more information, see CreateByteMatchSet , UpdateByteMatchSet , CreateIPSet ,
// UpdateIPSet , CreateSqlInjectionMatchSet , and UpdateSqlInjectionMatchSet .
// - Create and update the Rules that you want to include in the WebACL . For
// more information, see CreateRule and UpdateRule .
// - Create a WebACL . See CreateWebACL .
// - Use GetChangeToken to get the change token that you provide in the
// ChangeToken parameter of an UpdateWebACL request.
// - Submit an UpdateWebACL request to specify the Rules that you want to include
// in the WebACL , to specify the default action, and to associate the WebACL
// with a CloudFront distribution. The ActivatedRule can be a rule group. If you
// specify a rule group as your ActivatedRule , you can exclude specific rules
// from that rule group. If you already have a rule group associated with a web ACL
// and want to submit an UpdateWebACL request to exclude certain rules from that
// rule group, you must first remove the rule group from the web ACL, the re-insert
// it again, specifying the excluded rules. For details, see
// ActivatedRule$ExcludedRules .
//
// Be aware that if you try to add a RATE_BASED rule to a web ACL without setting
// the rule type when first creating the rule, the UpdateWebACL request will fail
// because the request tries to add a REGULAR rule (the default rule type) with the
// specified ID, which does not exist. For more information about how to use the
// AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/)
// .
func (c *Client) UpdateWebACL(ctx context.Context, params *UpdateWebACLInput, optFns ...func(*Options)) (*UpdateWebACLOutput, error) {
if params == nil {
params = &UpdateWebACLInput{}
}
result, metadata, err := c.invokeOperation(ctx, "UpdateWebACL", params, optFns, c.addOperationUpdateWebACLMiddlewares)
if err != nil {
return nil, err
}
out := result.(*UpdateWebACLOutput)
out.ResultMetadata = metadata
return out, nil
}
type UpdateWebACLInput struct {
// The value returned by the most recent call to GetChangeToken .
//
// This member is required.
ChangeToken *string
// The WebACLId of the WebACL that you want to update. WebACLId is returned by
// CreateWebACL and by ListWebACLs .
//
// This member is required.
WebACLId *string
// A default action for the web ACL, either ALLOW or BLOCK. AWS WAF performs the
// default action if a request doesn't match the criteria in any of the rules in a
// web ACL.
DefaultAction *types.WafAction
// An array of updates to make to the WebACL . An array of WebACLUpdate objects
// that you want to insert into or delete from a WebACL . For more information, see
// the applicable data types:
// - WebACLUpdate : Contains Action and ActivatedRule
// - ActivatedRule : Contains Action , OverrideAction , Priority , RuleId , and
// Type . ActivatedRule|OverrideAction applies only when updating or adding a
// RuleGroup to a WebACL . In this case, you do not use ActivatedRule|Action .
// For all other update requests, ActivatedRule|Action is used instead of
// ActivatedRule|OverrideAction .
// - WafAction : Contains Type
Updates []types.WebACLUpdate
noSmithyDocumentSerde
}
type UpdateWebACLOutput struct {
// The ChangeToken that you used to submit the UpdateWebACL request. You can also
// use this value to query the status of the request. For more information, see
// GetChangeTokenStatus .
ChangeToken *string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
noSmithyDocumentSerde
}
func (c *Client) addOperationUpdateWebACLMiddlewares(stack *middleware.Stack, options Options) (err error) {
if err := stack.Serialize.Add(&setOperationInputMiddleware{}, middleware.After); err != nil {
return err
}
err = stack.Serialize.Add(&awsAwsjson11_serializeOpUpdateWebACL{}, middleware.After)
if err != nil {
return err
}
err = stack.Deserialize.Add(&awsAwsjson11_deserializeOpUpdateWebACL{}, middleware.After)
if err != nil {
return err
}
if err := addProtocolFinalizerMiddlewares(stack, options, "UpdateWebACL"); err != nil {
return fmt.Errorf("add protocol finalizers: %v", err)
}
if err = addlegacyEndpointContextSetter(stack, options); err != nil {
return err
}
if err = addSetLoggerMiddleware(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddClientRequestIDMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddComputeContentLengthMiddleware(stack); err != nil {
return err
}
if err = addResolveEndpointMiddleware(stack, options); err != nil {
return err
}
if err = v4.AddComputePayloadSHA256Middleware(stack); err != nil {
return err
}
if err = addRetryMiddlewares(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddRawResponseToMetadata(stack); err != nil {
return err
}
if err = awsmiddleware.AddRecordResponseTiming(stack); err != nil {
return err
}
if err = addClientUserAgent(stack, options); err != nil {
return err
}
if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = addSetLegacyContextSigningOptionsMiddleware(stack); err != nil {
return err
}
if err = addOpUpdateWebACLValidationMiddleware(stack); err != nil {
return err
}
if err = stack.Initialize.Add(newServiceMetadataMiddleware_opUpdateWebACL(options.Region), middleware.Before); err != nil {
return err
}
if err = awsmiddleware.AddRecursionDetection(stack); err != nil {
return err
}
if err = addRequestIDRetrieverMiddleware(stack); err != nil {
return err
}
if err = addResponseErrorMiddleware(stack); err != nil {
return err
}
if err = addRequestResponseLogging(stack, options); err != nil {
return err
}
if err = addDisableHTTPSMiddleware(stack, options); err != nil {
return err
}
return nil
}
func newServiceMetadataMiddleware_opUpdateWebACL(region string) *awsmiddleware.RegisterServiceMetadata {
return &awsmiddleware.RegisterServiceMetadata{
Region: region,
ServiceID: ServiceID,
OperationName: "UpdateWebACL",
}
}
|