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
|
// Code generated by smithy-go-codegen DO NOT EDIT.
package wafv2
import (
"context"
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/wafv2/types"
"github.com/aws/smithy-go/middleware"
smithyhttp "github.com/aws/smithy-go/transport/http"
)
// Updates the specified RuleGroup. This operation completely replaces the mutable
// specifications that you already have for the rule group with the ones that you
// provide to this call. To modify the rule group, retrieve it by calling
// GetRuleGroup, update the settings as needed, and then provide the complete rule
// group specification to this call. When you make changes to web ACLs or web ACL
// components, like rules and rule groups, WAF propagates the changes everywhere
// that the web ACL and its components are stored and used. Your changes are
// applied within seconds, but there might be a brief period of inconsistency when
// the changes have arrived in some places and not in others. So, for example, if
// you change a rule action setting, the action might be the old action in one area
// and the new action in another area. Or if you add an IP address to an IP set
// used in a blocking rule, the new address might briefly be blocked in one area
// while still allowed in another. This temporary inconsistency can occur when you
// first associate a web ACL with an Amazon Web Services resource and when you
// change a web ACL that is already associated with a resource. Generally, any
// inconsistencies of this type last only a few seconds. 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.
func (c *Client) UpdateRuleGroup(ctx context.Context, params *UpdateRuleGroupInput, optFns ...func(*Options)) (*UpdateRuleGroupOutput, error) {
if params == nil {
params = &UpdateRuleGroupInput{}
}
result, metadata, err := c.invokeOperation(ctx, "UpdateRuleGroup", params, optFns, c.addOperationUpdateRuleGroupMiddlewares)
if err != nil {
return nil, err
}
out := result.(*UpdateRuleGroupOutput)
out.ResultMetadata = metadata
return out, nil
}
type UpdateRuleGroupInput struct {
// A unique identifier for the rule group. This ID is returned in the responses to
// create and list commands. You provide it to operations like update and delete.
//
// This member is required.
Id *string
// A token used for optimistic locking. WAF returns a token to your get and list
// requests, to mark the state of the entity at the time of the request. To make
// changes to the entity associated with the token, you provide the token to
// operations like update and delete. WAF uses the token to ensure that no changes
// have been made to the entity since you last retrieved it. If a change has been
// made, the update fails with a WAFOptimisticLockException. If this happens,
// perform another get, and use the new token returned by that operation.
//
// This member is required.
LockToken *string
// The name of the rule group. You cannot change the name of a rule group after you
// create it.
//
// This member is required.
Name *string
// Specifies whether this is for an Amazon CloudFront distribution or for a
// regional application. 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. To work with CloudFront, you must also specify the Region US
// East (N. Virginia) as follows:
//
// * CLI - Specify the Region when you use the
// CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
//
// * API and SDKs - For
// all calls, use the Region endpoint us-east-1.
//
// This member is required.
Scope types.Scope
// Defines and enables Amazon CloudWatch metrics and web request sample collection.
//
// This member is required.
VisibilityConfig *types.VisibilityConfig
// A map of custom response keys and content bodies. When you create a rule with a
// block action, you can send a custom response to the web request. You define
// these for the rule group, and then use them in the rules that you define in the
// rule group. For information about customizing web requests and responses, see
// Customizing web requests and responses in WAF
// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-custom-request-response.html)
// in the WAF Developer Guide
// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). For
// information about the limits on count and size for custom request and response
// settings, see WAF quotas
// (https://docs.aws.amazon.com/waf/latest/developerguide/limits.html) in the WAF
// Developer Guide
// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html).
CustomResponseBodies map[string]types.CustomResponseBody
// A description of the rule group that helps with identification.
Description *string
// The Rule statements used to identify the web requests that you want to allow,
// block, or count. Each rule includes one top-level statement that WAF uses to
// identify matching web requests, and parameters that govern how WAF handles them.
Rules []types.Rule
noSmithyDocumentSerde
}
type UpdateRuleGroupOutput struct {
// A token used for optimistic locking. WAF returns this token to your update
// requests. You use NextLockToken in the same manner as you use LockToken.
NextLockToken *string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
noSmithyDocumentSerde
}
func (c *Client) addOperationUpdateRuleGroupMiddlewares(stack *middleware.Stack, options Options) (err error) {
err = stack.Serialize.Add(&awsAwsjson11_serializeOpUpdateRuleGroup{}, middleware.After)
if err != nil {
return err
}
err = stack.Deserialize.Add(&awsAwsjson11_deserializeOpUpdateRuleGroup{}, middleware.After)
if 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 = addHTTPSignerV4Middleware(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); err != nil {
return err
}
if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = addOpUpdateRuleGroupValidationMiddleware(stack); err != nil {
return err
}
if err = stack.Initialize.Add(newServiceMetadataMiddleware_opUpdateRuleGroup(options.Region), middleware.Before); 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
}
return nil
}
func newServiceMetadataMiddleware_opUpdateRuleGroup(region string) *awsmiddleware.RegisterServiceMetadata {
return &awsmiddleware.RegisterServiceMetadata{
Region: region,
ServiceID: ServiceID,
SigningName: "wafv2",
OperationName: "UpdateRuleGroup",
}
}
|
