Skip to content

Commit 672d299

Browse files
Improved the visibility of the guidance for updating AWS WAF resources, such as web ACLs and rule groups.
1 parent 17d9d10 commit 672d299

17 files changed

+1114
-502
lines changed

generator/ServiceModels/wafv2/wafv2-2019-07-29.docs.json

Lines changed: 7 additions & 7 deletions
Large diffs are not rendered by default.

generator/ServiceModels/wafv2/wafv2-2019-07-29.endpoint-tests.json

Lines changed: 111 additions & 111 deletions
Large diffs are not rendered by default.

generator/ServiceModels/wafv2/wafv2-2019-07-29.normal.json

Lines changed: 7 additions & 7 deletions
Large diffs are not rendered by default.

sdk/src/Services/WAFV2/Generated/Model/GetSampledRequestsRequest.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -77,8 +77,8 @@ internal bool IsSetMaxItems()
7777
/// <summary>
7878
/// Gets and sets the property RuleMetricName.
7979
/// <para>
80-
/// The metric name assigned to the <code>Rule</code> or <code>RuleGroup</code> for which
81-
/// you want a sample of requests.
80+
/// The metric name assigned to the <code>Rule</code> or <code>RuleGroup</code> dimension
81+
/// for which you want a sample of requests.
8282
/// </para>
8383
/// </summary>
8484
[AWSProperty(Required=true, Min=1, Max=255)]

sdk/src/Services/WAFV2/Generated/Model/PutLoggingConfigurationRequest.cs

Lines changed: 21 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,27 @@ namespace Amazon.WAFV2.Model
3535
///
3636
/// <note>
3737
/// <para>
38+
/// This operation completely replaces any mutable specifications that you already have
39+
/// for a logging configuration with the ones that you provide to this call.
40+
/// </para>
41+
///
42+
/// <para>
43+
/// To modify an existing logging configuration, do the following:
44+
/// </para>
45+
/// <ol> <li>
46+
/// <para>
47+
/// Retrieve it by calling <a>GetLoggingConfiguration</a>
48+
/// </para>
49+
/// </li> <li>
50+
/// <para>
51+
/// Update its settings as needed
52+
/// </para>
53+
/// </li> <li>
54+
/// <para>
55+
/// Provide the complete logging configuration specification to this call
56+
/// </para>
57+
/// </li> </ol> </note> <note>
58+
/// <para>
3859
/// You can define one logging destination per web ACL.
3960
/// </para>
4061
/// </note>
@@ -78,15 +99,6 @@ namespace Amazon.WAFV2.Model
7899
/// For additional information about web ACL logging, see <a href="https://docs.aws.amazon.com/waf/latest/developerguide/logging.html">Logging
79100
/// web ACL traffic information</a> in the <i>WAF Developer Guide</i>.
80101
/// </para>
81-
/// <note>
82-
/// <para>
83-
/// This operation completely replaces the mutable specifications that you already have
84-
/// for the logging configuration with the ones that you provide to this call. To modify
85-
/// the logging configuration, retrieve it by calling <a>GetLoggingConfiguration</a>,
86-
/// update the settings as needed, and then provide the complete logging configuration
87-
/// specification to this call.
88-
/// </para>
89-
/// </note>
90102
/// </summary>
91103
public partial class PutLoggingConfigurationRequest : AmazonWAFV2Request
92104
{

sdk/src/Services/WAFV2/Generated/Model/UpdateIPSetRequest.cs

Lines changed: 18 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -35,11 +35,25 @@ namespace Amazon.WAFV2.Model
3535
/// <note>
3636
/// <para>
3737
/// This operation completely replaces the mutable specifications that you already have
38-
/// for the IP set with the ones that you provide to this call. To modify the IP set,
39-
/// retrieve it by calling <a>GetIPSet</a>, update the settings as needed, and then provide
40-
/// the complete IP set specification to this call.
38+
/// for the IP set with the ones that you provide to this call.
4139
/// </para>
42-
/// </note>
40+
///
41+
/// <para>
42+
/// To modify an IP set, do the following:
43+
/// </para>
44+
/// <ol> <li>
45+
/// <para>
46+
/// Retrieve it by calling <a>GetIPSet</a>
47+
/// </para>
48+
/// </li> <li>
49+
/// <para>
50+
/// Update its settings as needed
51+
/// </para>
52+
/// </li> <li>
53+
/// <para>
54+
/// Provide the complete IP set specification to this call
55+
/// </para>
56+
/// </li> </ol> </note>
4357
/// <para>
4458
/// When you make changes to web ACLs or web ACL components, like rules and rule groups,
4559
/// WAF propagates the changes everywhere that the web ACL and its components are stored

sdk/src/Services/WAFV2/Generated/Model/UpdateRegexPatternSetRequest.cs

Lines changed: 18 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -35,11 +35,25 @@ namespace Amazon.WAFV2.Model
3535
/// <note>
3636
/// <para>
3737
/// This operation completely replaces the mutable specifications that you already have
38-
/// for the regex pattern set with the ones that you provide to this call. To modify the
39-
/// regex pattern set, retrieve it by calling <a>GetRegexPatternSet</a>, update the settings
40-
/// as needed, and then provide the complete regex pattern set specification to this call.
38+
/// for the regex pattern set with the ones that you provide to this call.
4139
/// </para>
42-
/// </note>
40+
///
41+
/// <para>
42+
/// To modify a regex pattern set, do the following:
43+
/// </para>
44+
/// <ol> <li>
45+
/// <para>
46+
/// Retrieve it by calling <a>GetRegexPatternSet</a>
47+
/// </para>
48+
/// </li> <li>
49+
/// <para>
50+
/// Update its settings as needed
51+
/// </para>
52+
/// </li> <li>
53+
/// <para>
54+
/// Provide the complete regex pattern set specification to this call
55+
/// </para>
56+
/// </li> </ol> </note>
4357
/// <para>
4458
/// When you make changes to web ACLs or web ACL components, like rules and rule groups,
4559
/// WAF propagates the changes everywhere that the web ACL and its components are stored

sdk/src/Services/WAFV2/Generated/Model/UpdateRuleGroupRequest.cs

Lines changed: 18 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -35,11 +35,25 @@ namespace Amazon.WAFV2.Model
3535
/// <note>
3636
/// <para>
3737
/// This operation completely replaces the mutable specifications that you already have
38-
/// for the rule group with the ones that you provide to this call. To modify the rule
39-
/// group, retrieve it by calling <a>GetRuleGroup</a>, update the settings as needed,
40-
/// and then provide the complete rule group specification to this call.
38+
/// for the rule group with the ones that you provide to this call.
4139
/// </para>
42-
/// </note>
40+
///
41+
/// <para>
42+
/// To modify a rule group, do the following:
43+
/// </para>
44+
/// <ol> <li>
45+
/// <para>
46+
/// Retrieve it by calling <a>GetRuleGroup</a>
47+
/// </para>
48+
/// </li> <li>
49+
/// <para>
50+
/// Update its settings as needed
51+
/// </para>
52+
/// </li> <li>
53+
/// <para>
54+
/// Provide the complete rule group specification to this call
55+
/// </para>
56+
/// </li> </ol> </note>
4357
/// <para>
4458
/// When you make changes to web ACLs or web ACL components, like rules and rule groups,
4559
/// WAF propagates the changes everywhere that the web ACL and its components are stored

sdk/src/Services/WAFV2/Generated/Model/UpdateWebACLRequest.cs

Lines changed: 22 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -33,8 +33,29 @@ namespace Amazon.WAFV2.Model
3333
/// Updates the specified <a>WebACL</a>. While updating a web ACL, WAF provides continuous
3434
/// coverage to the resources that you have associated with the web ACL.
3535
///
36+
/// <note>
37+
/// <para>
38+
/// This operation completely replaces the mutable specifications that you already have
39+
/// for the web ACL with the ones that you provide to this call.
40+
/// </para>
3641
///
3742
/// <para>
43+
/// To modify a web ACL, do the following:
44+
/// </para>
45+
/// <ol> <li>
46+
/// <para>
47+
/// Retrieve it by calling <a>GetWebACL</a>
48+
/// </para>
49+
/// </li> <li>
50+
/// <para>
51+
/// Update its settings as needed
52+
/// </para>
53+
/// </li> <li>
54+
/// <para>
55+
/// Provide the complete web ACL specification to this call
56+
/// </para>
57+
/// </li> </ol> </note>
58+
/// <para>
3859
/// When you make changes to web ACLs or web ACL components, like rules and rule groups,
3960
/// WAF propagates the changes everywhere that the web ACL and its components are stored
4061
/// and used. Your changes are applied within seconds, but there might be a brief period
@@ -47,14 +68,7 @@ namespace Amazon.WAFV2.Model
4768
/// ACL that is already associated with a resource. Generally, any inconsistencies of
4869
/// this type last only a few seconds.
4970
/// </para>
50-
/// <note>
51-
/// <para>
52-
/// This operation completely replaces the mutable specifications that you already have
53-
/// for the web ACL with the ones that you provide to this call. To modify the web ACL,
54-
/// retrieve it by calling <a>GetWebACL</a>, update the settings as needed, and then provide
55-
/// the complete web ACL specification to this call.
56-
/// </para>
57-
/// </note>
71+
///
5872
/// <para>
5973
/// A web ACL defines a collection of rules to use to inspect and control web requests.
6074
/// Each rule has an action defined (allow, block, or count) for requests that match the

sdk/src/Services/WAFV2/Generated/Model/VisibilityConfig.cs

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -61,10 +61,10 @@ internal bool IsSetCloudWatchMetricsEnabled()
6161
/// <summary>
6262
/// Gets and sets the property MetricName.
6363
/// <para>
64-
/// A name of the Amazon CloudWatch metric. The name can contain only the characters:
64+
/// A name of the Amazon CloudWatch metric dimension. The name can contain only the characters:
6565
/// A-Z, a-z, 0-9, - (hyphen), and _ (underscore). The name can be from one to 128 characters
66-
/// long. It can't contain whitespace or metric names reserved for WAF, for example <code>All</code>
67-
/// and <code>Default_Action</code>.
66+
/// long. It can't contain whitespace or metric names that are reserved for WAF, for example
67+
/// <code>All</code> and <code>Default_Action</code>.
6868
/// </para>
6969
/// </summary>
7070
[AWSProperty(Required=true, Min=1, Max=255)]

0 commit comments

Comments
 (0)