AWS.Tools.WAFRegional.XML
|
<?xml version="1.0"?>
<doc> <assembly> <name>AWS.Tools.WAFRegional</name> </assembly> <members> <!-- Badly formed XML comment ignored for member "T:Amazon.PowerShell.Cmdlets.WAFR.AddWAFRResourceTagCmdlet" --> <member name="P:Amazon.PowerShell.Cmdlets.WAFR.AddWAFRResourceTagCmdlet.ResourceARN"> <summary> <para> The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAFR.AddWAFRResourceTagCmdlet.Tag"> <summary> <para> The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAFR.AddWAFRResourceTagCmdlet.PassThru"> <summary> Returns the value passed to the ResourceARN parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAFR.AddWAFRResourceTagCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.WAFR.GetWAFRActivatedRulesInRuleGroupListCmdlet"> <summary> Returns an array of <a>ActivatedRule</a> objects.<br/><br/>This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAFR.GetWAFRActivatedRulesInRuleGroupListCmdlet.RuleGroupId"> <summary> <para> <para>The <code>RuleGroupId</code> of the <a>RuleGroup</a> for which you want to get a list of <a>ActivatedRule</a> objects.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAFR.GetWAFRActivatedRulesInRuleGroupListCmdlet.Limit"> <summary> <para> <para>Specifies the number of <code>ActivatedRules</code> that you want AWS WAF to return for this request. If you have more <code>ActivatedRules</code> than the number that you specify for <code>Limit</code>, the response includes a <code>NextMarker</code> value that you can use to get another batch of <code>ActivatedRules</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAFR.GetWAFRActivatedRulesInRuleGroupListCmdlet.NextMarker"> <summary> <para> <para>If you specify a value for <code>Limit</code> and you have more <code>ActivatedRules</code> than the value of <code>Limit</code>, AWS WAF returns a <code>NextMarker</code> value in the response that allows you to list another group of <code>ActivatedRules</code>. For the second and subsequent <code>ListActivatedRulesInRuleGroup</code> requests, specify the value of <code>NextMarker</code> from the previous response to get information about another batch of <code>ActivatedRules</code>.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, assign $null, for the first call, and the value of $AWSHistory.LastServiceResponse.NextMarker, for subsequent calls, to this parameter. </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.WAFR.GetWAFRByteMatchSetCmdlet"> <summary> Returns the <a>ByteMatchSet</a> specified by <code>ByteMatchSetId</code>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAFR.GetWAFRByteMatchSetCmdlet.ByteMatchSetId"> <summary> <para> <para>The <code>ByteMatchSetId</code> of the <a>ByteMatchSet</a> that you want to get. <code>ByteMatchSetId</code> is returned by <a>CreateByteMatchSet</a> and by <a>ListByteMatchSets</a>.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.WAFR.GetWAFRByteMatchSetListCmdlet"> <summary> Returns an array of <a>ByteMatchSetSummary</a> objects.<br/><br/>This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAFR.GetWAFRByteMatchSetListCmdlet.Limit"> <summary> <para> <para>Specifies the number of <code>ByteMatchSet</code> objects that you want AWS WAF to return for this request. If you have more <code>ByteMatchSets</code> objects than the number you specify for <code>Limit</code>, the response includes a <code>NextMarker</code> value that you can use to get another batch of <code>ByteMatchSet</code> objects.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAFR.GetWAFRByteMatchSetListCmdlet.NextMarker"> <summary> <para> <para>If you specify a value for <code>Limit</code> and you have more <code>ByteMatchSets</code> than the value of <code>Limit</code>, AWS WAF returns a <code>NextMarker</code> value in the response that allows you to list another group of <code>ByteMatchSets</code>. For the second and subsequent <code>ListByteMatchSets</code> requests, specify the value of <code>NextMarker</code> from the previous response to get information about another batch of <code>ByteMatchSets</code>.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, assign $null, for the first call, and the value of $AWSHistory.LastServiceResponse.NextMarker, for subsequent calls, to this parameter. </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.WAFR.GetWAFRChangeTokenCmdlet"> <summary> When you want to create, update, or delete AWS WAF objects, get a change token and include the change token in the create, update, or delete request. Change tokens ensure that your application doesn't submit conflicting requests to AWS WAF. <para> Each create, update, or delete request must use a unique change token. If your application submits a <code>GetChangeToken</code> request and then submits a second <code>GetChangeToken</code> request before submitting a create, update, or delete request, the second <code>GetChangeToken</code> request returns the same value as the first <code>GetChangeToken</code> request. </para><para> When you use a change token in a create, update, or delete request, the status of the change token changes to <code>PENDING</code>, which indicates that AWS WAF is propagating the change to all AWS WAF servers. Use <code>GetChangeTokenStatus</code> to determine the status of your change token. </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.WAFR.GetWAFRChangeTokenStatusCmdlet"> <summary> Returns the status of a <code>ChangeToken</code> that you got by calling <a>GetChangeToken</a>. <code>ChangeTokenStatus</code> is one of the following values: <ul><li><para><code>PROVISIONED</code>: You requested the change token by calling <code>GetChangeToken</code>, but you haven't used it yet in a call to create, update, or delete an AWS WAF object. </para></li><li><para><code>PENDING</code>: AWS WAF is propagating the create, update, or delete request to all AWS WAF servers. </para></li><li><para><code>INSYNC</code>: Propagation is complete. </para></li></ul> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAFR.GetWAFRChangeTokenStatusCmdlet.ChangeToken"> <summary> <para> <para>The change token for which you want to get the status. This change token was previously returned in the <code>GetChangeToken</code> response.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.WAFR.GetWAFRGeoMatchSetCmdlet"> <summary> Returns the <a>GeoMatchSet</a> that is specified by <code>GeoMatchSetId</code>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAFR.GetWAFRGeoMatchSetCmdlet.GeoMatchSetId"> <summary> <para> <para>The <code>GeoMatchSetId</code> of the <a>GeoMatchSet</a> that you want to get. <code>GeoMatchSetId</code> is returned by <a>CreateGeoMatchSet</a> and by <a>ListGeoMatchSets</a>.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.WAFR.GetWAFRGeoMatchSetListCmdlet"> <summary> Returns an array of <a>GeoMatchSetSummary</a> objects in the response.<br/><br/>This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAFR.GetWAFRGeoMatchSetListCmdlet.Limit"> <summary> <para> <para>Specifies the number of <code>GeoMatchSet</code> objects that you want AWS WAF to return for this request. If you have more <code>GeoMatchSet</code> objects than the number you specify for <code>Limit</code>, the response includes a <code>NextMarker</code> value that you can use to get another batch of <code>GeoMatchSet</code> objects.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAFR.GetWAFRGeoMatchSetListCmdlet.NextMarker"> <summary> <para> <para>If you specify a value for <code>Limit</code> and you have more <code>GeoMatchSet</code>s than the value of <code>Limit</code>, AWS WAF returns a <code>NextMarker</code> value in the response that allows you to list another group of <code>GeoMatchSet</code> objects. For the second and subsequent <code>ListGeoMatchSets</code> requests, specify the value of <code>NextMarker</code> from the previous response to get information about another batch of <code>GeoMatchSet</code> objects.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, assign $null, for the first call, and the value of $AWSHistory.LastServiceResponse.NextMarker, for subsequent calls, to this parameter. </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.WAFR.GetWAFRIPSetCmdlet"> <summary> Returns the <a>IPSet</a> that is specified by <code>IPSetId</code>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAFR.GetWAFRIPSetCmdlet.IPSetId"> <summary> <para> <para>The <code>IPSetId</code> of the <a>IPSet</a> that you want to get. <code>IPSetId</code> is returned by <a>CreateIPSet</a> and by <a>ListIPSets</a>.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.WAFR.GetWAFRIPSetListCmdlet"> <summary> Returns an array of <a>IPSetSummary</a> objects in the response.<br/><br/>This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAFR.GetWAFRIPSetListCmdlet.Limit"> <summary> <para> <para>Specifies the number of <code>IPSet</code> objects that you want AWS WAF to return for this request. If you have more <code>IPSet</code> objects than the number you specify for <code>Limit</code>, the response includes a <code>NextMarker</code> value that you can use to get another batch of <code>IPSet</code> objects.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAFR.GetWAFRIPSetListCmdlet.NextMarker"> <summary> <para> <para>AWS WAF returns a <code>NextMarker</code> value in the response that allows you to list another group of <code>IPSets</code>. For the second and subsequent <code>ListIPSets</code> requests, specify the value of <code>NextMarker</code> from the previous response to get information about another batch of <code>IPSets</code>.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, assign $null, for the first call, and the value of $AWSHistory.LastServiceResponse.NextMarker, for subsequent calls, to this parameter. </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.WAFR.GetWAFRLoggingConfigurationCmdlet"> <summary> Returns the <a>LoggingConfiguration</a> for the specified web ACL. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAFR.GetWAFRLoggingConfigurationCmdlet.ResourceArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the web ACL for which you want to get the <a>LoggingConfiguration</a>.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.WAFR.GetWAFRLoggingConfigurationListCmdlet"> <summary> Returns an array of <a>LoggingConfiguration</a> objects.<br/><br/>This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAFR.GetWAFRLoggingConfigurationListCmdlet.Limit"> <summary> <para> <para>Specifies the number of <code>LoggingConfigurations</code> that you want AWS WAF to return for this request. If you have more <code>LoggingConfigurations</code> than the number that you specify for <code>Limit</code>, the response includes a <code>NextMarker</code> value that you can use to get another batch of <code>LoggingConfigurations</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAFR.GetWAFRLoggingConfigurationListCmdlet.NextMarker"> <summary> <para> <para>If you specify a value for <code>Limit</code> and you have more <code>LoggingConfigurations</code> than the value of <code>Limit</code>, AWS WAF returns a <code>NextMarker</code> value in the response that allows you to list another group of <code>LoggingConfigurations</code>. For the second and subsequent <code>ListLoggingConfigurations</code> requests, specify the value of <code>NextMarker</code> from the previous response to get information about another batch of <code>ListLoggingConfigurations</code>.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, assign $null, for the first call, and the value of $AWSHistory.LastServiceResponse.NextMarker, for subsequent calls, to this parameter. </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.WAFR.GetWAFRPermissionPolicyCmdlet"> <summary> Returns the IAM policy attached to the RuleGroup. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAFR.GetWAFRPermissionPolicyCmdlet.ResourceArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the RuleGroup for which you want to get the policy.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.WAFR.GetWAFRRateBasedRuleCmdlet"> <summary> Returns the <a>RateBasedRule</a> that is specified by the <code>RuleId</code> that you included in the <code>GetRateBasedRule</code> request. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAFR.GetWAFRRateBasedRuleCmdlet.RuleId"> <summary> <para> <para>The <code>RuleId</code> of the <a>RateBasedRule</a> that you want to get. <code>RuleId</code> is returned by <a>CreateRateBasedRule</a> and by <a>ListRateBasedRules</a>.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.WAFR.GetWAFRRateBasedRuleListCmdlet"> <summary> Returns an array of <a>RuleSummary</a> objects.<br/><br/>This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAFR.GetWAFRRateBasedRuleListCmdlet.Limit"> <summary> <para> <para>Specifies the number of <code>Rules</code> that you want AWS WAF to return for this request. If you have more <code>Rules</code> than the number that you specify for <code>Limit</code>, the response includes a <code>NextMarker</code> value that you can use to get another batch of <code>Rules</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAFR.GetWAFRRateBasedRuleListCmdlet.NextMarker"> <summary> <para> <para>If you specify a value for <code>Limit</code> and you have more <code>Rules</code> than the value of <code>Limit</code>, AWS WAF returns a <code>NextMarker</code> value in the response that allows you to list another group of <code>Rules</code>. For the second and subsequent <code>ListRateBasedRules</code> requests, specify the value of <code>NextMarker</code> from the previous response to get information about another batch of <code>Rules</code>.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, assign $null, for the first call, and the value of $AWSHistory.LastServiceResponse.NextMarker, for subsequent calls, to this parameter. </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.WAFR.GetWAFRRateBasedRuleManagedKeyCmdlet"> <summary> Returns an array of IP addresses currently being blocked by the <a>RateBasedRule</a> that is specified by the <code>RuleId</code>. The maximum number of managed keys that will be blocked is 10,000. If more than 10,000 addresses exceed the rate limit, the 10,000 addresses with the highest rates will be blocked.<br/><br/>This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAFR.GetWAFRRateBasedRuleManagedKeyCmdlet.RuleId"> <summary> <para> <para>The <code>RuleId</code> of the <a>RateBasedRule</a> for which you want to get a list of <code>ManagedKeys</code>. <code>RuleId</code> is returned by <a>CreateRateBasedRule</a> and by <a>ListRateBasedRules</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAFR.GetWAFRRateBasedRuleManagedKeyCmdlet.NextMarker"> <summary> <para> <para>A null value and not currently used. Do not include this in your request.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, assign $null, for the first call, and the value of $AWSHistory.LastServiceResponse.NextMarker, for subsequent calls, to this parameter. </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.WAFR.GetWAFRRegexMatchSetCmdlet"> <summary> Returns the <a>RegexMatchSet</a> specified by <code>RegexMatchSetId</code>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAFR.GetWAFRRegexMatchSetCmdlet.RegexMatchSetId"> <summary> <para> <para>The <code>RegexMatchSetId</code> of the <a>RegexMatchSet</a> that you want to get. <code>RegexMatchSetId</code> is returned by <a>CreateRegexMatchSet</a> and by <a>ListRegexMatchSets</a>.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.WAFR.GetWAFRRegexMatchSetListCmdlet"> <summary> Returns an array of <a>RegexMatchSetSummary</a> objects.<br/><br/>This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAFR.GetWAFRRegexMatchSetListCmdlet.Limit"> <summary> <para> <para>Specifies the number of <code>RegexMatchSet</code> objects that you want AWS WAF to return for this request. If you have more <code>RegexMatchSet</code> objects than the number you specify for <code>Limit</code>, the response includes a <code>NextMarker</code> value that you can use to get another batch of <code>RegexMatchSet</code> objects.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAFR.GetWAFRRegexMatchSetListCmdlet.NextMarker"> <summary> <para> <para>If you specify a value for <code>Limit</code> and you have more <code>RegexMatchSet</code> objects than the value of <code>Limit</code>, AWS WAF returns a <code>NextMarker</code> value in the response that allows you to list another group of <code>ByteMatchSets</code>. For the second and subsequent <code>ListRegexMatchSets</code> requests, specify the value of <code>NextMarker</code> from the previous response to get information about another batch of <code>RegexMatchSet</code> objects.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, assign $null, for the first call, and the value of $AWSHistory.LastServiceResponse.NextMarker, for subsequent calls, to this parameter. </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.WAFR.GetWAFRRegexPatternSetCmdlet"> <summary> Returns the <a>RegexPatternSet</a> specified by <code>RegexPatternSetId</code>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAFR.GetWAFRRegexPatternSetCmdlet.RegexPatternSetId"> <summary> <para> <para>The <code>RegexPatternSetId</code> of the <a>RegexPatternSet</a> that you want to get. <code>RegexPatternSetId</code> is returned by <a>CreateRegexPatternSet</a> and by <a>ListRegexPatternSets</a>.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.WAFR.GetWAFRRegexPatternSetListCmdlet"> <summary> Returns an array of <a>RegexPatternSetSummary</a> objects.<br/><br/>This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAFR.GetWAFRRegexPatternSetListCmdlet.Limit"> <summary> <para> <para>Specifies the number of <code>RegexPatternSet</code> objects that you want AWS WAF to return for this request. If you have more <code>RegexPatternSet</code> objects than the number you specify for <code>Limit</code>, the response includes a <code>NextMarker</code> value that you can use to get another batch of <code>RegexPatternSet</code> objects.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAFR.GetWAFRRegexPatternSetListCmdlet.NextMarker"> <summary> <para> <para>If you specify a value for <code>Limit</code> and you have more <code>RegexPatternSet</code> objects than the value of <code>Limit</code>, AWS WAF returns a <code>NextMarker</code> value in the response that allows you to list another group of <code>RegexPatternSet</code> objects. For the second and subsequent <code>ListRegexPatternSets</code> requests, specify the value of <code>NextMarker</code> from the previous response to get information about another batch of <code>RegexPatternSet</code> objects.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, assign $null, for the first call, and the value of $AWSHistory.LastServiceResponse.NextMarker, for subsequent calls, to this parameter. </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.WAFR.GetWAFRResourceForWebACLListCmdlet"> <summary> Returns an array of resources associated with the specified web ACL. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAFR.GetWAFRResourceForWebACLListCmdlet.ResourceType"> <summary> <para> <para>The type of resource to list, either an application load balancer or Amazon API Gateway.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAFR.GetWAFRResourceForWebACLListCmdlet.WebACLId"> <summary> <para> <para>The unique identifier (ID) of the web ACL for which to list the associated resources.</para> </para> </summary> </member> <!-- Badly formed XML comment ignored for member "T:Amazon.PowerShell.Cmdlets.WAFR.GetWAFRResourceTagCmdlet" --> <member name="P:Amazon.PowerShell.Cmdlets.WAFR.GetWAFRResourceTagCmdlet.ResourceARN"> <summary> <para> The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAFR.GetWAFRResourceTagCmdlet.Limit"> <summary> <para> The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAFR.GetWAFRResourceTagCmdlet.NextMarker"> <summary> <para> The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.WAFR.GetWAFRRuleCmdlet"> <summary> Returns the <a>Rule</a> that is specified by the <code>RuleId</code> that you included in the <code>GetRule</code> request. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAFR.GetWAFRRuleCmdlet.RuleId"> <summary> <para> <para>The <code>RuleId</code> of the <a>Rule</a> that you want to get. <code>RuleId</code> is returned by <a>CreateRule</a> and by <a>ListRules</a>.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.WAFR.GetWAFRRuleGroupCmdlet"> <summary> Returns the <a>RuleGroup</a> that is specified by the <code>RuleGroupId</code> that you included in the <code>GetRuleGroup</code> request. <para> To view the rules in a rule group, use <a>ListActivatedRulesInRuleGroup</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAFR.GetWAFRRuleGroupCmdlet.RuleGroupId"> <summary> <para> <para>The <code>RuleGroupId</code> of the <a>RuleGroup</a> that you want to get. <code>RuleGroupId</code> is returned by <a>CreateRuleGroup</a> and by <a>ListRuleGroups</a>.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.WAFR.GetWAFRRuleGroupListCmdlet"> <summary> Returns an array of <a>RuleGroup</a> objects.<br/><br/>This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAFR.GetWAFRRuleGroupListCmdlet.Limit"> <summary> <para> <para>Specifies the number of <code>RuleGroups</code> that you want AWS WAF to return for this request. If you have more <code>RuleGroups</code> than the number that you specify for <code>Limit</code>, the response includes a <code>NextMarker</code> value that you can use to get another batch of <code>RuleGroups</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAFR.GetWAFRRuleGroupListCmdlet.NextMarker"> <summary> <para> <para>If you specify a value for <code>Limit</code> and you have more <code>RuleGroups</code> than the value of <code>Limit</code>, AWS WAF returns a <code>NextMarker</code> value in the response that allows you to list another group of <code>RuleGroups</code>. For the second and subsequent <code>ListRuleGroups</code> requests, specify the value of <code>NextMarker</code> from the previous response to get information about another batch of <code>RuleGroups</code>.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, assign $null, for the first call, and the value of $AWSHistory.LastServiceResponse.NextMarker, for subsequent calls, to this parameter. </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.WAFR.GetWAFRRuleListCmdlet"> <summary> Returns an array of <a>RuleSummary</a> objects.<br/><br/>This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAFR.GetWAFRRuleListCmdlet.Limit"> <summary> <para> <para>Specifies the number of <code>Rules</code> that you want AWS WAF to return for this request. If you have more <code>Rules</code> than the number that you specify for <code>Limit</code>, the response includes a <code>NextMarker</code> value that you can use to get another batch of <code>Rules</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAFR.GetWAFRRuleListCmdlet.NextMarker"> <summary> <para> <para>If you specify a value for <code>Limit</code> and you have more <code>Rules</code> than the value of <code>Limit</code>, AWS WAF returns a <code>NextMarker</code> value in the response that allows you to list another group of <code>Rules</code>. For the second and subsequent <code>ListRules</code> requests, specify the value of <code>NextMarker</code> from the previous response to get information about another batch of <code>Rules</code>.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, assign $null, for the first call, and the value of $AWSHistory.LastServiceResponse.NextMarker, for subsequent calls, to this parameter. </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.WAFR.GetWAFRSampledRequestListCmdlet"> <summary> Gets detailed information about a specified number of requests--a sample--that AWS WAF randomly selects from among the first 5,000 requests that your AWS resource received during a time range that you choose. You can specify a sample size of up to 500 requests, and you can specify any time range in the previous three hours. <para><code>GetSampledRequests</code> returns a time range, which is usually the time range that you specified. However, if your resource (such as a CloudFront distribution) received 5,000 requests before the specified time range elapsed, <code>GetSampledRequests</code> returns an updated time range. This new time range indicates the actual period during which AWS WAF selected the requests in the sample. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAFR.GetWAFRSampledRequestListCmdlet.TimeWindow_EndTime"> <summary> <para> <para>The end of the time range from which you want <code>GetSampledRequests</code> to return a sample of the requests that your AWS resource received. Specify the date and time in the following format: <code>"2016-09-27T14:50Z"</code>. You can specify any time range in the previous three hours.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAFR.GetWAFRSampledRequestListCmdlet.RuleId"> <summary> <para> <para><code>RuleId</code> is one of three values:</para><ul><li><para>The <code>RuleId</code> of the <code>Rule</code> or the <code>RuleGroupId</code> of the <code>RuleGroup</code> for which you want <code>GetSampledRequests</code> to return a sample of requests.</para></li><li><para><code>Default_Action</code>, which causes <code>GetSampledRequests</code> to return a sample of the requests that didn't match any of the rules in the specified <code>WebACL</code>.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAFR.GetWAFRSampledRequestListCmdlet.TimeWindow_StartTime"> <summary> <para> <para>The beginning of the time range from which you want <code>GetSampledRequests</code> to return a sample of the requests that your AWS resource received. Specify the date and time in the following format: <code>"2016-09-27T14:50Z"</code>. You can specify any time range in the previous three hours.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAFR.GetWAFRSampledRequestListCmdlet.WebAclId"> <summary> <para> <para>The <code>WebACLId</code> of the <code>WebACL</code> for which you want <code>GetSampledRequests</code> to return a sample of requests.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAFR.GetWAFRSampledRequestListCmdlet.MaxItem"> <summary> <para> <para>The number of requests that you want AWS WAF to return from among the first 5,000 requests that your AWS resource received during the time range. If your resource received fewer requests than the value of <code>MaxItems</code>, <code>GetSampledRequests</code> returns information about all of them. </para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.WAFR.GetWAFRSizeConstraintSetCmdlet"> <summary> Returns the <a>SizeConstraintSet</a> specified by <code>SizeConstraintSetId</code>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAFR.GetWAFRSizeConstraintSetCmdlet.SizeConstraintSetId"> <summary> <para> <para>The <code>SizeConstraintSetId</code> of the <a>SizeConstraintSet</a> that you want to get. <code>SizeConstraintSetId</code> is returned by <a>CreateSizeConstraintSet</a> and by <a>ListSizeConstraintSets</a>.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.WAFR.GetWAFRSizeConstraintSetListCmdlet"> <summary> Returns an array of <a>SizeConstraintSetSummary</a> objects.<br/><br/>This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAFR.GetWAFRSizeConstraintSetListCmdlet.Limit"> <summary> <para> <para>Specifies the number of <code>SizeConstraintSet</code> objects that you want AWS WAF to return for this request. If you have more <code>SizeConstraintSets</code> objects than the number you specify for <code>Limit</code>, the response includes a <code>NextMarker</code> value that you can use to get another batch of <code>SizeConstraintSet</code> objects.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAFR.GetWAFRSizeConstraintSetListCmdlet.NextMarker"> <summary> <para> <para>If you specify a value for <code>Limit</code> and you have more <code>SizeConstraintSets</code> than the value of <code>Limit</code>, AWS WAF returns a <code>NextMarker</code> value in the response that allows you to list another group of <code>SizeConstraintSets</code>. For the second and subsequent <code>ListSizeConstraintSets</code> requests, specify the value of <code>NextMarker</code> from the previous response to get information about another batch of <code>SizeConstraintSets</code>.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, assign $null, for the first call, and the value of $AWSHistory.LastServiceResponse.NextMarker, for subsequent calls, to this parameter. </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.WAFR.GetWAFRSqlInjectionMatchSetCmdlet"> <summary> Returns the <a>SqlInjectionMatchSet</a> that is specified by <code>SqlInjectionMatchSetId</code>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAFR.GetWAFRSqlInjectionMatchSetCmdlet.SqlInjectionMatchSetId"> <summary> <para> <para>The <code>SqlInjectionMatchSetId</code> of the <a>SqlInjectionMatchSet</a> that you want to get. <code>SqlInjectionMatchSetId</code> is returned by <a>CreateSqlInjectionMatchSet</a> and by <a>ListSqlInjectionMatchSets</a>.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.WAFR.GetWAFRSqlInjectionMatchSetListCmdlet"> <summary> Returns an array of <a>SqlInjectionMatchSet</a> objects.<br/><br/>This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAFR.GetWAFRSqlInjectionMatchSetListCmdlet.Limit"> <summary> <para> <para>Specifies the number of <a>SqlInjectionMatchSet</a> objects that you want AWS WAF to return for this request. If you have more <code>SqlInjectionMatchSet</code> objects than the number you specify for <code>Limit</code>, the response includes a <code>NextMarker</code> value that you can use to get another batch of <code>Rules</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAFR.GetWAFRSqlInjectionMatchSetListCmdlet.NextMarker"> <summary> <para> <para>If you specify a value for <code>Limit</code> and you have more <a>SqlInjectionMatchSet</a> objects than the value of <code>Limit</code>, AWS WAF returns a <code>NextMarker</code> value in the response that allows you to list another group of <code>SqlInjectionMatchSets</code>. For the second and subsequent <code>ListSqlInjectionMatchSets</code> requests, specify the value of <code>NextMarker</code> from the previous response to get information about another batch of <code>SqlInjectionMatchSets</code>.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, assign $null, for the first call, and the value of $AWSHistory.LastServiceResponse.NextMarker, for subsequent calls, to this parameter. </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.WAFR.GetWAFRSubscribedRuleGroupCmdlet"> <summary> Returns an array of <a>RuleGroup</a> objects that you are subscribed to.<br/><br/>This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAFR.GetWAFRSubscribedRuleGroupCmdlet.Limit"> <summary> <para> <para>Specifies the number of subscribed rule groups that you want AWS WAF to return for this request. If you have more objects than the number you specify for <code>Limit</code>, the response includes a <code>NextMarker</code> value that you can use to get another batch of objects.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAFR.GetWAFRSubscribedRuleGroupCmdlet.NextMarker"> <summary> <para> <para>If you specify a value for <code>Limit</code> and you have more <code>ByteMatchSets</code>subscribed rule groups than the value of <code>Limit</code>, AWS WAF returns a <code>NextMarker</code> value in the response that allows you to list another group of subscribed rule groups. For the second and subsequent <code>ListSubscribedRuleGroupsRequest</code> requests, specify the value of <code>NextMarker</code> from the previous response to get information about another batch of subscribed rule groups.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, assign $null, for the first call, and the value of $AWSHistory.LastServiceResponse.NextMarker, for subsequent calls, to this parameter. </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.WAFR.GetWAFRWebACLCmdlet"> <summary> Returns the <a>WebACL</a> that is specified by <code>WebACLId</code>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAFR.GetWAFRWebACLCmdlet.WebACLId"> <summary> <para> <para>The <code>WebACLId</code> of the <a>WebACL</a> that you want to get. <code>WebACLId</code> is returned by <a>CreateWebACL</a> and by <a>ListWebACLs</a>.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.WAFR.GetWAFRWebACLForResourceCmdlet"> <summary> Returns the web ACL for the specified resource, either an application load balancer or Amazon API Gateway stage. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAFR.GetWAFRWebACLForResourceCmdlet.ResourceArn"> <summary> <para> <para>The ARN (Amazon Resource Name) of the resource for which to get the web ACL, either an application load balancer or Amazon API Gateway stage.</para><para>The ARN should be in one of the following formats:</para><ul><li><para>For an Application Load Balancer: <code>arn:aws:elasticloadbalancing:<i>region</i>:<i>account-id</i>:loadbalancer/app/<i>load-balancer-name</i>/<i>load-balancer-id</i></code></para></li><li><para>For an Amazon API Gateway stage: <code>arn:aws:apigateway:<i>region</i>::/restapis/<i>api-id</i>/stages/<i>stage-name</i></code></para></li></ul> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.WAFR.GetWAFRWebACLListCmdlet"> <summary> Returns an array of <a>WebACLSummary</a> objects in the response.<br/><br/>This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAFR.GetWAFRWebACLListCmdlet.Limit"> <summary> <para> <para>Specifies the number of <code>WebACL</code> objects that you want AWS WAF to return for this request. If you have more <code>WebACL</code> objects than the number that you specify for <code>Limit</code>, the response includes a <code>NextMarker</code> value that you can use to get another batch of <code>WebACL</code> objects.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAFR.GetWAFRWebACLListCmdlet.NextMarker"> <summary> <para> <para>If you specify a value for <code>Limit</code> and you have more <code>WebACL</code> objects than the number that you specify for <code>Limit</code>, AWS WAF returns a <code>NextMarker</code> value in the response that allows you to list another group of <code>WebACL</code> objects. For the second and subsequent <code>ListWebACLs</code> requests, specify the value of <code>NextMarker</code> from the previous response to get information about another batch of <code>WebACL</code> objects.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, assign $null, for the first call, and the value of $AWSHistory.LastServiceResponse.NextMarker, for subsequent calls, to this parameter. </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.WAFR.GetWAFRXssMatchSetCmdlet"> <summary> Returns the <a>XssMatchSet</a> that is specified by <code>XssMatchSetId</code>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAFR.GetWAFRXssMatchSetCmdlet.XssMatchSetId"> <summary> <para> <para>The <code>XssMatchSetId</code> of the <a>XssMatchSet</a> that you want to get. <code>XssMatchSetId</code> is returned by <a>CreateXssMatchSet</a> and by <a>ListXssMatchSets</a>.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.WAFR.GetWAFRXssMatchSetListCmdlet"> <summary> Returns an array of <a>XssMatchSet</a> objects.<br/><br/>This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAFR.GetWAFRXssMatchSetListCmdlet.Limit"> <summary> <para> <para>Specifies the number of <a>XssMatchSet</a> objects that you want AWS WAF to return for this request. If you have more <code>XssMatchSet</code> objects than the number you specify for <code>Limit</code>, the response includes a <code>NextMarker</code> value that you can use to get another batch of <code>Rules</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAFR.GetWAFRXssMatchSetListCmdlet.NextMarker"> <summary> <para> <para>If you specify a value for <code>Limit</code> and you have more <a>XssMatchSet</a> objects than the value of <code>Limit</code>, AWS WAF returns a <code>NextMarker</code> value in the response that allows you to list another group of <code>XssMatchSets</code>. For the second and subsequent <code>ListXssMatchSets</code> requests, specify the value of <code>NextMarker</code> from the previous response to get information about another batch of <code>XssMatchSets</code>.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, assign $null, for the first call, and the value of $AWSHistory.LastServiceResponse.NextMarker, for subsequent calls, to this parameter. </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.WAFR.NewWAFRByteMatchSetCmdlet"> <summary> Creates a <code>ByteMatchSet</code>. You then use <a>UpdateByteMatchSet</a> to identify the part of a web request that you want AWS WAF to inspect, such as the values of the <code>User-Agent</code> header or the query string. For example, you can create a <code>ByteMatchSet</code> that matches any requests with <code>User-Agent</code> headers that contain the string <code>BadBot</code>. You can then configure AWS WAF to reject those requests. <para> To create and configure a <code>ByteMatchSet</code>, perform the following steps: </para><ol><li><para> Use <a>GetChangeToken</a> to get the change token that you provide in the <code>ChangeToken</code> parameter of a <code>CreateByteMatchSet</code> request. </para></li><li><para> Submit a <code>CreateByteMatchSet</code> request. </para></li><li><para> Use <code>GetChangeToken</code> to get the change token that you provide in the <code>ChangeToken</code> parameter of an <code>UpdateByteMatchSet</code> request. </para></li><li><para> Submit an <a>UpdateByteMatchSet</a> request to specify the part of the request that you want AWS WAF to inspect (for example, the header or the URI) and the value that you want AWS WAF to watch for. </para></li></ol><para> For more information about how to use the AWS WAF API to allow or block HTTP requests, see the <a href="https://docs.aws.amazon.com/waf/latest/developerguide/">AWS WAF Developer Guide</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAFR.NewWAFRByteMatchSetCmdlet.ChangeToken"> <summary> <para> <para>The value returned by the most recent call to <a>GetChangeToken</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAFR.NewWAFRByteMatchSetCmdlet.Name"> <summary> <para> <para>A friendly name or description of the <a>ByteMatchSet</a>. You can't change <code>Name</code> after you create a <code>ByteMatchSet</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAFR.NewWAFRByteMatchSetCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.WAFR.NewWAFRGeoMatchSetCmdlet"> <summary> Creates an <a>GeoMatchSet</a>, which you use to specify which web requests you want to allow or block based on the country that the requests originate from. For example, if you're receiving a lot of requests from one or more countries and you want to block the requests, you can create an <code>GeoMatchSet</code> that contains those countries and then configure AWS WAF to block the requests. <para> To create and configure a <code>GeoMatchSet</code>, perform the following steps: </para><ol><li><para> Use <a>GetChangeToken</a> to get the change token that you provide in the <code>ChangeToken</code> parameter of a <code>CreateGeoMatchSet</code> request. </para></li><li><para> Submit a <code>CreateGeoMatchSet</code> request. </para></li><li><para> Use <code>GetChangeToken</code> to get the change token that you provide in the <code>ChangeToken</code> parameter of an <a>UpdateGeoMatchSet</a> request. </para></li><li><para> Submit an <code>UpdateGeoMatchSetSet</code> request to specify the countries that you want AWS WAF to watch for. </para></li></ol><para> For more information about how to use the AWS WAF API to allow or block HTTP requests, see the <a href="https://docs.aws.amazon.com/waf/latest/developerguide/">AWS WAF Developer Guide</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAFR.NewWAFRGeoMatchSetCmdlet.ChangeToken"> <summary> <para> <para>The value returned by the most recent call to <a>GetChangeToken</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAFR.NewWAFRGeoMatchSetCmdlet.Name"> <summary> <para> <para>A friendly name or description of the <a>GeoMatchSet</a>. You can't change <code>Name</code> after you create the <code>GeoMatchSet</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAFR.NewWAFRGeoMatchSetCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.WAFR.NewWAFRIPSetCmdlet"> <summary> Creates an <a>IPSet</a>, which you use to specify which web requests that you want to allow or block based on the IP addresses that the requests originate from. For example, if you're receiving a lot of requests from one or more individual IP addresses or one or more ranges of IP addresses and you want to block the requests, you can create an <code>IPSet</code> that contains those IP addresses and then configure AWS WAF to block the requests. <para> To create and configure an <code>IPSet</code>, perform the following steps: </para><ol><li><para> Use <a>GetChangeToken</a> to get the change token that you provide in the <code>ChangeToken</code> parameter of a <code>CreateIPSet</code> request. </para></li><li><para> Submit a <code>CreateIPSet</code> request. </para></li><li><para> Use <code>GetChangeToken</code> to get the change token that you provide in the <code>ChangeToken</code> parameter of an <a>UpdateIPSet</a> request. </para></li><li><para> Submit an <code>UpdateIPSet</code> request to specify the IP addresses that you want AWS WAF to watch for. </para></li></ol><para> For more information about how to use the AWS WAF API to allow or block HTTP requests, see the <a href="https://docs.aws.amazon.com/waf/latest/developerguide/">AWS WAF Developer Guide</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAFR.NewWAFRIPSetCmdlet.ChangeToken"> <summary> <para> <para>The value returned by the most recent call to <a>GetChangeToken</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAFR.NewWAFRIPSetCmdlet.Name"> <summary> <para> <para>A friendly name or description of the <a>IPSet</a>. You can't change <code>Name</code> after you create the <code>IPSet</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAFR.NewWAFRIPSetCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.WAFR.NewWAFRRateBasedRuleCmdlet"> <summary> Creates a <a>RateBasedRule</a>. The <code>RateBasedRule</code> contains a <code>RateLimit</code>, which specifies the maximum number of requests that AWS WAF allows from a specified IP address in a five-minute period. The <code>RateBasedRule</code> also contains the <code>IPSet</code> objects, <code>ByteMatchSet</code> objects, and other predicates that identify the requests that you want to count or block if these requests exceed the <code>RateLimit</code>. <para> If you add more than one predicate to a <code>RateBasedRule</code>, a request not only must exceed the <code>RateLimit</code>, but it also must match all the specifications to be counted or blocked. For example, suppose you add the following to a <code>RateBasedRule</code>: </para><ul><li><para> An <code>IPSet</code> that matches the IP address <code>192.0.2.44/32</code></para></li><li><para> A <code>ByteMatchSet</code> that matches <code>BadBot</code> in the <code>User-Agent</code> header </para></li></ul><para> Further, you specify a <code>RateLimit</code> of 15,000. </para><para> You then add the <code>RateBasedRule</code> to a <code>WebACL</code> and specify that you want to block requests that meet the conditions in the rule. For a request to be blocked, it must come from the IP address 192.0.2.44 <i>and</i> the <code>User-Agent</code> header in the request must contain the value <code>BadBot</code>. Further, requests that match these two conditions must be received at a rate of more than 15,000 requests every five minutes. If both conditions are met and the rate is exceeded, AWS WAF blocks the requests. If the rate drops below 15,000 for a five-minute period, AWS WAF no longer blocks the requests. </para><para> As a second example, suppose you want to limit requests to a particular page on your site. To do this, you could add the following to a <code>RateBasedRule</code>: </para><ul><li><para> A <code>ByteMatchSet</code> with <code>FieldToMatch</code> of <code>URI</code></para></li><li><para> A <code>PositionalConstraint</code> of <code>STARTS_WITH</code></para></li><li><para> A <code>TargetString</code> of <code>login</code></para></li></ul><para> Further, you specify a <code>RateLimit</code> of 15,000. </para><para> By adding this <code>RateBasedRule</code> to a <code>WebACL</code>, you could limit requests to your login page without affecting the rest of your site. </para><para> To create and configure a <code>RateBasedRule</code>, perform the following steps: </para><ol><li><para> Create and update the predicates that you want to include in the rule. For more information, see <a>CreateByteMatchSet</a>, <a>CreateIPSet</a>, and <a>CreateSqlInjectionMatchSet</a>. </para></li><li><para> Use <a>GetChangeToken</a> to get the change token that you provide in the <code>ChangeToken</code> parameter of a <code>CreateRule</code> request. </para></li><li><para> Submit a <code>CreateRateBasedRule</code> request. </para></li><li><para> Use <code>GetChangeToken</code> to get the change token that you provide in the <code>ChangeToken</code> parameter of an <a>UpdateRule</a> request. </para></li><li><para> Submit an <code>UpdateRateBasedRule</code> request to specify the predicates that you want to include in the rule. </para></li><li><para> Create and update a <code>WebACL</code> that contains the <code>RateBasedRule</code>. For more information, see <a>CreateWebACL</a>. </para></li></ol><para> For more information about how to use the AWS WAF API to allow or block HTTP requests, see the <a href="https://docs.aws.amazon.com/waf/latest/developerguide/">AWS WAF Developer Guide</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAFR.NewWAFRRateBasedRuleCmdlet.ChangeToken"> <summary> <para> <para>The <code>ChangeToken</code> that you used to submit the <code>CreateRateBasedRule</code> request. You can also use this value to query the status of the request. For more information, see <a>GetChangeTokenStatus</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAFR.NewWAFRRateBasedRuleCmdlet.MetricName"> <summary> <para> <para>A friendly name or description for the metrics for this <code>RateBasedRule</code>. The name can contain only alphanumeric characters (A-Z, a-z, 0-9), with maximum length 128 and minimum length one. It can't contain whitespace or metric names reserved for AWS WAF, including "All" and "Default_Action." You can't change the name of the metric after you create the <code>RateBasedRule</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAFR.NewWAFRRateBasedRuleCmdlet.Name"> <summary> <para> <para>A friendly name or description of the <a>RateBasedRule</a>. You can't change the name of a <code>RateBasedRule</code> after you create it.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAFR.NewWAFRRateBasedRuleCmdlet.RateKey"> <summary> <para> <para>The field that AWS WAF uses to determine if requests are likely arriving from a single source and thus subject to rate monitoring. The only valid value for <code>RateKey</code> is <code>IP</code>. <code>IP</code> indicates that requests that arrive from the same IP address are subject to the <code>RateLimit</code> that is specified in the <code>RateBasedRule</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAFR.NewWAFRRateBasedRuleCmdlet.RateLimit"> <summary> <para> <para>The maximum number of requests, which have an identical value in the field that is specified by <code>RateKey</code>, allowed in a five-minute period. If the number of requests exceeds the <code>RateLimit</code> and the other predicates specified in the rule are also met, AWS WAF triggers the action that is specified for this rule.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAFR.NewWAFRRateBasedRuleCmdlet.Tag"> <summary> <para> The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAFR.NewWAFRRateBasedRuleCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.WAFR.NewWAFRRegexMatchSetCmdlet"> <summary> Creates a <a>RegexMatchSet</a>. You then use <a>UpdateRegexMatchSet</a> to identify the part of a web request that you want AWS WAF to inspect, such as the values of the <code>User-Agent</code> header or the query string. For example, you can create a <code>RegexMatchSet</code> that contains a <code>RegexMatchTuple</code> that looks for any requests with <code>User-Agent</code> headers that match a <code>RegexPatternSet</code> with pattern <code>B[a@]dB[o0]t</code>. You can then configure AWS WAF to reject those requests. <para> To create and configure a <code>RegexMatchSet</code>, perform the following steps: </para><ol><li><para> Use <a>GetChangeToken</a> to get the change token that you provide in the <code>ChangeToken</code> parameter of a <code>CreateRegexMatchSet</code> request. </para></li><li><para> Submit a <code>CreateRegexMatchSet</code> request. </para></li><li><para> Use <code>GetChangeToken</code> to get the change token that you provide in the <code>ChangeToken</code> parameter of an <code>UpdateRegexMatchSet</code> request. </para></li><li><para> Submit an <a>UpdateRegexMatchSet</a> request to specify the part of the request that you want AWS WAF to inspect (for example, the header or the URI) and the value, using a <code>RegexPatternSet</code>, that you want AWS WAF to watch for. </para></li></ol><para> For more information about how to use the AWS WAF API to allow or block HTTP requests, see the <a href="https://docs.aws.amazon.com/waf/latest/developerguide/">AWS WAF Developer Guide</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAFR.NewWAFRRegexMatchSetCmdlet.ChangeToken"> <summary> <para> <para>The value returned by the most recent call to <a>GetChangeToken</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAFR.NewWAFRRegexMatchSetCmdlet.Name"> <summary> <para> <para>A friendly name or description of the <a>RegexMatchSet</a>. You can't change <code>Name</code> after you create a <code>RegexMatchSet</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAFR.NewWAFRRegexMatchSetCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.WAFR.NewWAFRRegexPatternSetCmdlet"> <summary> Creates a <code>RegexPatternSet</code>. You then use <a>UpdateRegexPatternSet</a> to specify the regular expression (regex) pattern that you want AWS WAF to search for, such as <code>B[a@]dB[o0]t</code>. You can then configure AWS WAF to reject those requests. <para> To create and configure a <code>RegexPatternSet</code>, perform the following steps: </para><ol><li><para> Use <a>GetChangeToken</a> to get the change token that you provide in the <code>ChangeToken</code> parameter of a <code>CreateRegexPatternSet</code> request. </para></li><li><para> Submit a <code>CreateRegexPatternSet</code> request. </para></li><li><para> Use <code>GetChangeToken</code> to get the change token that you provide in the <code>ChangeToken</code> parameter of an <code>UpdateRegexPatternSet</code> request. </para></li><li><para> Submit an <a>UpdateRegexPatternSet</a> request to specify the string that you want AWS WAF to watch for. </para></li></ol><para> For more information about how to use the AWS WAF API to allow or block HTTP requests, see the <a href="https://docs.aws.amazon.com/waf/latest/developerguide/">AWS WAF Developer Guide</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAFR.NewWAFRRegexPatternSetCmdlet.ChangeToken"> <summary> <para> <para>The value returned by the most recent call to <a>GetChangeToken</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAFR.NewWAFRRegexPatternSetCmdlet.Name"> <summary> <para> <para>A friendly name or description of the <a>RegexPatternSet</a>. You can't change <code>Name</code> after you create a <code>RegexPatternSet</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAFR.NewWAFRRegexPatternSetCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.WAFR.NewWAFRRuleCmdlet"> <summary> Creates a <code>Rule</code>, which contains the <code>IPSet</code> objects, <code>ByteMatchSet</code> objects, and other predicates that identify the requests that you want to block. If you add more than one predicate to a <code>Rule</code>, a request must match all of the specifications to be allowed or blocked. For example, suppose that you add the following to a <code>Rule</code>: <ul><li><para> An <code>IPSet</code> that matches the IP address <code>192.0.2.44/32</code></para></li><li><para> A <code>ByteMatchSet</code> that matches <code>BadBot</code> in the <code>User-Agent</code> header </para></li></ul><para> You then add the <code>Rule</code> to a <code>WebACL</code> and specify that you want to blocks requests that satisfy the <code>Rule</code>. For a request to be blocked, it must come from the IP address 192.0.2.44 <i>and</i> the <code>User-Agent</code> header in the request must contain the value <code>BadBot</code>. </para><para> To create and configure a <code>Rule</code>, perform the following steps: </para><ol><li><para> Create and update the predicates that you want to include in the <code>Rule</code>. For more information, see <a>CreateByteMatchSet</a>, <a>CreateIPSet</a>, and <a>CreateSqlInjectionMatchSet</a>. </para></li><li><para> Use <a>GetChangeToken</a> to get the change token that you provide in the <code>ChangeToken</code> parameter of a <code>CreateRule</code> request. </para></li><li><para> Submit a <code>CreateRule</code> request. </para></li><li><para> Use <code>GetChangeToken</code> to get the change token that you provide in the <code>ChangeToken</code> parameter of an <a>UpdateRule</a> request. </para></li><li><para> Submit an <code>UpdateRule</code> request to specify the predicates that you want to include in the <code>Rule</code>. </para></li><li><para> Create and update a <code>WebACL</code> that contains the <code>Rule</code>. For more information, see <a>CreateWebACL</a>. </para></li></ol><para> For more information about how to use the AWS WAF API to allow or block HTTP requests, see the <a href="https://docs.aws.amazon.com/waf/latest/developerguide/">AWS WAF Developer Guide</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAFR.NewWAFRRuleCmdlet.ChangeToken"> <summary> <para> <para>The value returned by the most recent call to <a>GetChangeToken</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAFR.NewWAFRRuleCmdlet.MetricName"> <summary> <para> <para>A friendly name or description for the metrics for this <code>Rule</code>. The name can contain only alphanumeric characters (A-Z, a-z, 0-9), with maximum length 128 and minimum length one. It can't contain whitespace or metric names reserved for AWS WAF, including "All" and "Default_Action." You can't change the name of the metric after you create the <code>Rule</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAFR.NewWAFRRuleCmdlet.Name"> <summary> <para> <para>A friendly name or description of the <a>Rule</a>. You can't change the name of a <code>Rule</code> after you create it.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAFR.NewWAFRRuleCmdlet.Tag"> <summary> <para> The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.WAFR.NewWAFRRuleGroupCmdlet"> <summary> Creates a <code>RuleGroup</code>. A rule group is a collection of predefined rules that you add to a web ACL. You use <a>UpdateRuleGroup</a> to add rules to the rule group. <para> Rule groups are subject to the following limits: </para><ul><li><para> Three rule groups per account. You can request an increase to this limit by contacting customer support. </para></li><li><para> One rule group per web ACL. </para></li><li><para> Ten rules per rule group. </para></li></ul><para> For more information about how to use the AWS WAF API to allow or block HTTP requests, see the <a href="https://docs.aws.amazon.com/waf/latest/developerguide/">AWS WAF Developer Guide</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAFR.NewWAFRRuleGroupCmdlet.ChangeToken"> <summary> <para> <para>The value returned by the most recent call to <a>GetChangeToken</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAFR.NewWAFRRuleGroupCmdlet.MetricName"> <summary> <para> <para>A friendly name or description for the metrics for this <code>RuleGroup</code>. The name can contain only alphanumeric characters (A-Z, a-z, 0-9), with maximum length 128 and minimum length one. It can't contain whitespace or metric names reserved for AWS WAF, including "All" and "Default_Action." You can't change the name of the metric after you create the <code>RuleGroup</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAFR.NewWAFRRuleGroupCmdlet.Name"> <summary> <para> <para>A friendly name or description of the <a>RuleGroup</a>. You can't change <code>Name</code> after you create a <code>RuleGroup</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAFR.NewWAFRRuleGroupCmdlet.Tag"> <summary> <para> The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAFR.NewWAFRRuleGroupCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.WAFR.NewWAFRSizeConstraintSetCmdlet"> <summary> Creates a <code>SizeConstraintSet</code>. You then use <a>UpdateSizeConstraintSet</a> to identify the part of a web request that you want AWS WAF to check for length, such as the length of the <code>User-Agent</code> header or the length of the query string. For example, you can create a <code>SizeConstraintSet</code> that matches any requests that have a query string that is longer than 100 bytes. You can then configure AWS WAF to reject those requests. <para> To create and configure a <code>SizeConstraintSet</code>, perform the following steps: </para><ol><li><para> Use <a>GetChangeToken</a> to get the change token that you provide in the <code>ChangeToken</code> parameter of a <code>CreateSizeConstraintSet</code> request. </para></li><li><para> Submit a <code>CreateSizeConstraintSet</code> request. </para></li><li><para> Use <code>GetChangeToken</code> to get the change token that you provide in the <code>ChangeToken</code> parameter of an <code>UpdateSizeConstraintSet</code> request. </para></li><li><para> Submit an <a>UpdateSizeConstraintSet</a> request to specify the part of the request that you want AWS WAF to inspect (for example, the header or the URI) and the value that you want AWS WAF to watch for. </para></li></ol><para> For more information about how to use the AWS WAF API to allow or block HTTP requests, see the <a href="https://docs.aws.amazon.com/waf/latest/developerguide/">AWS WAF Developer Guide</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAFR.NewWAFRSizeConstraintSetCmdlet.ChangeToken"> <summary> <para> <para>The value returned by the most recent call to <a>GetChangeToken</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAFR.NewWAFRSizeConstraintSetCmdlet.Name"> <summary> <para> <para>A friendly name or description of the <a>SizeConstraintSet</a>. You can't change <code>Name</code> after you create a <code>SizeConstraintSet</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAFR.NewWAFRSizeConstraintSetCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.WAFR.NewWAFRSqlInjectionMatchSetCmdlet"> <summary> Creates a <a>SqlInjectionMatchSet</a>, which you use to allow, block, or count requests that contain snippets of SQL code in a specified part of web requests. AWS WAF searches for character sequences that are likely to be malicious strings. <para> To create and configure a <code>SqlInjectionMatchSet</code>, perform the following steps: </para><ol><li><para> Use <a>GetChangeToken</a> to get the change token that you provide in the <code>ChangeToken</code> parameter of a <code>CreateSqlInjectionMatchSet</code> request. </para></li><li><para> Submit a <code>CreateSqlInjectionMatchSet</code> request. </para></li><li><para> Use <code>GetChangeToken</code> to get the change token that you provide in the <code>ChangeToken</code> parameter of an <a>UpdateSqlInjectionMatchSet</a> request. </para></li><li><para> Submit an <a>UpdateSqlInjectionMatchSet</a> request to specify the parts of web requests in which you want to allow, block, or count malicious SQL code. </para></li></ol><para> For more information about how to use the AWS WAF API to allow or block HTTP requests, see the <a href="https://docs.aws.amazon.com/waf/latest/developerguide/">AWS WAF Developer Guide</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAFR.NewWAFRSqlInjectionMatchSetCmdlet.ChangeToken"> <summary> <para> <para>The value returned by the most recent call to <a>GetChangeToken</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAFR.NewWAFRSqlInjectionMatchSetCmdlet.Name"> <summary> <para> <para>A friendly name or description for the <a>SqlInjectionMatchSet</a> that you're creating. You can't change <code>Name</code> after you create the <code>SqlInjectionMatchSet</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAFR.NewWAFRSqlInjectionMatchSetCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.WAFR.NewWAFRWebACLCmdlet"> <summary> Creates a <code>WebACL</code>, which contains the <code>Rules</code> that identify the CloudFront web requests that you want to allow, block, or count. AWS WAF evaluates <code>Rules</code> in order based on the value of <code>Priority</code> for each <code>Rule</code>. <para> You also specify a default action, either <code>ALLOW</code> or <code>BLOCK</code>. If a web request doesn't match any of the <code>Rules</code> in a <code>WebACL</code>, AWS WAF responds to the request with the default action. </para><para> To create and configure a <code>WebACL</code>, perform the following steps: </para><ol><li><para> Create and update the <code>ByteMatchSet</code> objects and other predicates that you want to include in <code>Rules</code>. For more information, see <a>CreateByteMatchSet</a>, <a>UpdateByteMatchSet</a>, <a>CreateIPSet</a>, <a>UpdateIPSet</a>, <a>CreateSqlInjectionMatchSet</a>, and <a>UpdateSqlInjectionMatchSet</a>. </para></li><li><para> Create and update the <code>Rules</code> that you want to include in the <code>WebACL</code>. For more information, see <a>CreateRule</a> and <a>UpdateRule</a>. </para></li><li><para> Use <a>GetChangeToken</a> to get the change token that you provide in the <code>ChangeToken</code> parameter of a <code>CreateWebACL</code> request. </para></li><li><para> Submit a <code>CreateWebACL</code> request. </para></li><li><para> Use <code>GetChangeToken</code> to get the change token that you provide in the <code>ChangeToken</code> parameter of an <a>UpdateWebACL</a> request. </para></li><li><para> Submit an <a>UpdateWebACL</a> request to specify the <code>Rules</code> that you want to include in the <code>WebACL</code>, to specify the default action, and to associate the <code>WebACL</code> with a CloudFront distribution. </para></li></ol><para> For more information about how to use the AWS WAF API, see the <a href="https://docs.aws.amazon.com/waf/latest/developerguide/">AWS WAF Developer Guide</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAFR.NewWAFRWebACLCmdlet.ChangeToken"> <summary> <para> <para>The value returned by the most recent call to <a>GetChangeToken</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAFR.NewWAFRWebACLCmdlet.MetricName"> <summary> <para> <para>A friendly name or description for the metrics for this <code>WebACL</code>.The name can contain only alphanumeric characters (A-Z, a-z, 0-9), with maximum length 128 and minimum length one. It can't contain whitespace or metric names reserved for AWS WAF, including "All" and "Default_Action." You can't change <code>MetricName</code> after you create the <code>WebACL</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAFR.NewWAFRWebACLCmdlet.Name"> <summary> <para> <para>A friendly name or description of the <a>WebACL</a>. You can't change <code>Name</code> after you create the <code>WebACL</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAFR.NewWAFRWebACLCmdlet.Tag"> <summary> <para> The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAFR.NewWAFRWebACLCmdlet.DefaultAction_Type"> <summary> <para> <para>Specifies how you want AWS WAF to respond to requests that match the settings in a <code>Rule</code>. Valid settings include the following:</para><ul><li><para><code>ALLOW</code>: AWS WAF allows requests</para></li><li><para><code>BLOCK</code>: AWS WAF blocks requests</para></li><li><para><code>COUNT</code>: AWS WAF increments a counter of the requests that match all of the conditions in the rule. AWS WAF then continues to inspect the web request based on the remaining rules in the web ACL. You can't specify <code>COUNT</code> for the default action for a <code>WebACL</code>.</para></li></ul> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.WAFR.NewWAFRXssMatchSetCmdlet"> <summary> Creates an <a>XssMatchSet</a>, which you use to allow, block, or count requests that contain cross-site scripting attacks in the specified part of web requests. AWS WAF searches for character sequences that are likely to be malicious strings. <para> To create and configure an <code>XssMatchSet</code>, perform the following steps: </para><ol><li><para> Use <a>GetChangeToken</a> to get the change token that you provide in the <code>ChangeToken</code> parameter of a <code>CreateXssMatchSet</code> request. </para></li><li><para> Submit a <code>CreateXssMatchSet</code> request. </para></li><li><para> Use <code>GetChangeToken</code> to get the change token that you provide in the <code>ChangeToken</code> parameter of an <a>UpdateXssMatchSet</a> request. </para></li><li><para> Submit an <a>UpdateXssMatchSet</a> request to specify the parts of web requests in which you want to allow, block, or count cross-site scripting attacks. </para></li></ol><para> For more information about how to use the AWS WAF API to allow or block HTTP requests, see the <a href="https://docs.aws.amazon.com/waf/latest/developerguide/">AWS WAF Developer Guide</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAFR.NewWAFRXssMatchSetCmdlet.ChangeToken"> <summary> <para> <para>The value returned by the most recent call to <a>GetChangeToken</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAFR.NewWAFRXssMatchSetCmdlet.Name"> <summary> <para> <para>A friendly name or description for the <a>XssMatchSet</a> that you're creating. You can't change <code>Name</code> after you create the <code>XssMatchSet</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAFR.NewWAFRXssMatchSetCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.WAFR.RegisterWAFRWebACLCmdlet"> <summary> Associates a web ACL with a resource, either an application load balancer or Amazon API Gateway stage. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAFR.RegisterWAFRWebACLCmdlet.ResourceArn"> <summary> <para> <para>The ARN (Amazon Resource Name) of the resource to be protected, either an application load balancer or Amazon API Gateway stage. </para><para>The ARN should be in one of the following formats:</para><ul><li><para>For an Application Load Balancer: <code>arn:aws:elasticloadbalancing:<i>region</i>:<i>account-id</i>:loadbalancer/app/<i>load-balancer-name</i>/<i>load-balancer-id</i></code></para></li><li><para>For an Amazon API Gateway stage: <code>arn:aws:apigateway:<i>region</i>::/restapis/<i>api-id</i>/stages/<i>stage-name</i></code></para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAFR.RegisterWAFRWebACLCmdlet.WebACLId"> <summary> <para> <para>A unique identifier (ID) for the web ACL. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAFR.RegisterWAFRWebACLCmdlet.PassThru"> <summary> Returns the value passed to the WebACLId parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAFR.RegisterWAFRWebACLCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.WAFR.RemoveWAFRByteMatchSetCmdlet"> <summary> Permanently deletes a <a>ByteMatchSet</a>. You can't delete a <code>ByteMatchSet</code> if it's still used in any <code>Rules</code> or if it still includes any <a>ByteMatchTuple</a> objects (any filters). <para> If you just want to remove a <code>ByteMatchSet</code> from a <code>Rule</code>, use <a>UpdateRule</a>. </para><para> To permanently delete a <code>ByteMatchSet</code>, perform the following steps: </para><ol><li><para> Update the <code>ByteMatchSet</code> to remove filters, if any. For more information, see <a>UpdateByteMatchSet</a>. </para></li><li><para> Use <a>GetChangeToken</a> to get the change token that you provide in the <code>ChangeToken</code> parameter of a <code>DeleteByteMatchSet</code> request. </para></li><li><para> Submit a <code>DeleteByteMatchSet</code> request. </para></li></ol> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAFR.RemoveWAFRByteMatchSetCmdlet.ByteMatchSetId"> <summary> <para> <para>The <code>ByteMatchSetId</code> of the <a>ByteMatchSet</a> that you want to delete. <code>ByteMatchSetId</code> is returned by <a>CreateByteMatchSet</a> and by <a>ListByteMatchSets</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAFR.RemoveWAFRByteMatchSetCmdlet.ChangeToken"> <summary> <para> <para>The value returned by the most recent call to <a>GetChangeToken</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAFR.RemoveWAFRByteMatchSetCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.WAFR.RemoveWAFRGeoMatchSetCmdlet"> <summary> Permanently deletes a <a>GeoMatchSet</a>. You can't delete a <code>GeoMatchSet</code> if it's still used in any <code>Rules</code> or if it still includes any countries. <para> If you just want to remove a <code>GeoMatchSet</code> from a <code>Rule</code>, use <a>UpdateRule</a>. </para><para> To permanently delete a <code>GeoMatchSet</code> from AWS WAF, perform the following steps: </para><ol><li><para> Update the <code>GeoMatchSet</code> to remove any countries. For more information, see <a>UpdateGeoMatchSet</a>. </para></li><li><para> Use <a>GetChangeToken</a> to get the change token that you provide in the <code>ChangeToken</code> parameter of a <code>DeleteGeoMatchSet</code> request. </para></li><li><para> Submit a <code>DeleteGeoMatchSet</code> request. </para></li></ol> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAFR.RemoveWAFRGeoMatchSetCmdlet.ChangeToken"> <summary> <para> <para>The value returned by the most recent call to <a>GetChangeToken</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAFR.RemoveWAFRGeoMatchSetCmdlet.GeoMatchSetId"> <summary> <para> <para>The <code>GeoMatchSetID</code> of the <a>GeoMatchSet</a> that you want to delete. <code>GeoMatchSetId</code> is returned by <a>CreateGeoMatchSet</a> and by <a>ListGeoMatchSets</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAFR.RemoveWAFRGeoMatchSetCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.WAFR.RemoveWAFRIPSetCmdlet"> <summary> Permanently deletes an <a>IPSet</a>. You can't delete an <code>IPSet</code> if it's still used in any <code>Rules</code> or if it still includes any IP addresses. <para> If you just want to remove an <code>IPSet</code> from a <code>Rule</code>, use <a>UpdateRule</a>. </para><para> To permanently delete an <code>IPSet</code> from AWS WAF, perform the following steps: </para><ol><li><para> Update the <code>IPSet</code> to remove IP address ranges, if any. For more information, see <a>UpdateIPSet</a>. </para></li><li><para> Use <a>GetChangeToken</a> to get the change token that you provide in the <code>ChangeToken</code> parameter of a <code>DeleteIPSet</code> request. </para></li><li><para> Submit a <code>DeleteIPSet</code> request. </para></li></ol> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAFR.RemoveWAFRIPSetCmdlet.ChangeToken"> <summary> <para> <para>The value returned by the most recent call to <a>GetChangeToken</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAFR.RemoveWAFRIPSetCmdlet.IPSetId"> <summary> <para> <para>The <code>IPSetId</code> of the <a>IPSet</a> that you want to delete. <code>IPSetId</code> is returned by <a>CreateIPSet</a> and by <a>ListIPSets</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAFR.RemoveWAFRIPSetCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.WAFR.RemoveWAFRLoggingConfigurationCmdlet"> <summary> Permanently deletes the <a>LoggingConfiguration</a> from the specified web ACL. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAFR.RemoveWAFRLoggingConfigurationCmdlet.ResourceArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the web ACL from which you want to delete the <a>LoggingConfiguration</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAFR.RemoveWAFRLoggingConfigurationCmdlet.PassThru"> <summary> Returns the value passed to the ResourceArn parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAFR.RemoveWAFRLoggingConfigurationCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.WAFR.RemoveWAFRPermissionPolicyCmdlet"> <summary> Permanently deletes an IAM policy from the specified RuleGroup. <para> The user making the request must be the owner of the RuleGroup. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAFR.RemoveWAFRPermissionPolicyCmdlet.ResourceArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the RuleGroup from which you want to delete the policy.</para><para>The user making the request must be the owner of the RuleGroup.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAFR.RemoveWAFRPermissionPolicyCmdlet.PassThru"> <summary> Returns the value passed to the ResourceArn parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAFR.RemoveWAFRPermissionPolicyCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.WAFR.RemoveWAFRRateBasedRuleCmdlet"> <summary> Permanently deletes a <a>RateBasedRule</a>. You can't delete a rule if it's still used in any <code>WebACL</code> objects or if it still includes any predicates, such as <code>ByteMatchSet</code> objects. <para> If you just want to remove a rule from a <code>WebACL</code>, use <a>UpdateWebACL</a>. </para><para> To permanently delete a <code>RateBasedRule</code> from AWS WAF, perform the following steps: </para><ol><li><para> Update the <code>RateBasedRule</code> to remove predicates, if any. For more information, see <a>UpdateRateBasedRule</a>. </para></li><li><para> Use <a>GetChangeToken</a> to get the change token that you provide in the <code>ChangeToken</code> parameter of a <code>DeleteRateBasedRule</code> request. </para></li><li><para> Submit a <code>DeleteRateBasedRule</code> request. </para></li></ol> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAFR.RemoveWAFRRateBasedRuleCmdlet.ChangeToken"> <summary> <para> <para>The value returned by the most recent call to <a>GetChangeToken</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAFR.RemoveWAFRRateBasedRuleCmdlet.RuleId"> <summary> <para> <para>The <code>RuleId</code> of the <a>RateBasedRule</a> that you want to delete. <code>RuleId</code> is returned by <a>CreateRateBasedRule</a> and by <a>ListRateBasedRules</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAFR.RemoveWAFRRateBasedRuleCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.WAFR.RemoveWAFRRegexMatchSetCmdlet"> <summary> Permanently deletes a <a>RegexMatchSet</a>. You can't delete a <code>RegexMatchSet</code> if it's still used in any <code>Rules</code> or if it still includes any <code>RegexMatchTuples</code> objects (any filters). <para> If you just want to remove a <code>RegexMatchSet</code> from a <code>Rule</code>, use <a>UpdateRule</a>. </para><para> To permanently delete a <code>RegexMatchSet</code>, perform the following steps: </para><ol><li><para> Update the <code>RegexMatchSet</code> to remove filters, if any. For more information, see <a>UpdateRegexMatchSet</a>. </para></li><li><para> Use <a>GetChangeToken</a> to get the change token that you provide in the <code>ChangeToken</code> parameter of a <code>DeleteRegexMatchSet</code> request. </para></li><li><para> Submit a <code>DeleteRegexMatchSet</code> request. </para></li></ol> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAFR.RemoveWAFRRegexMatchSetCmdlet.ChangeToken"> <summary> <para> <para>The value returned by the most recent call to <a>GetChangeToken</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAFR.RemoveWAFRRegexMatchSetCmdlet.RegexMatchSetId"> <summary> <para> <para>The <code>RegexMatchSetId</code> of the <a>RegexMatchSet</a> that you want to delete. <code>RegexMatchSetId</code> is returned by <a>CreateRegexMatchSet</a> and by <a>ListRegexMatchSets</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAFR.RemoveWAFRRegexMatchSetCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.WAFR.RemoveWAFRRegexPatternSetCmdlet"> <summary> Permanently deletes a <a>RegexPatternSet</a>. You can't delete a <code>RegexPatternSet</code> if it's still used in any <code>RegexMatchSet</code> or if the <code>RegexPatternSet</code> is not empty. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAFR.RemoveWAFRRegexPatternSetCmdlet.ChangeToken"> <summary> <para> <para>The value returned by the most recent call to <a>GetChangeToken</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAFR.RemoveWAFRRegexPatternSetCmdlet.RegexPatternSetId"> <summary> <para> <para>The <code>RegexPatternSetId</code> of the <a>RegexPatternSet</a> that you want to delete. <code>RegexPatternSetId</code> is returned by <a>CreateRegexPatternSet</a> and by <a>ListRegexPatternSets</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAFR.RemoveWAFRRegexPatternSetCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <!-- Badly formed XML comment ignored for member "T:Amazon.PowerShell.Cmdlets.WAFR.RemoveWAFRResourceTagCmdlet" --> <member name="P:Amazon.PowerShell.Cmdlets.WAFR.RemoveWAFRResourceTagCmdlet.ResourceARN"> <summary> <para> The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAFR.RemoveWAFRResourceTagCmdlet.TagKey"> <summary> <para> The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAFR.RemoveWAFRResourceTagCmdlet.PassThru"> <summary> Returns the value passed to the ResourceARN parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAFR.RemoveWAFRResourceTagCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.WAFR.RemoveWAFRRuleCmdlet"> <summary> Permanently deletes a <a>Rule</a>. You can't delete a <code>Rule</code> if it's still used in any <code>WebACL</code> objects or if it still includes any predicates, such as <code>ByteMatchSet</code> objects. <para> If you just want to remove a <code>Rule</code> from a <code>WebACL</code>, use <a>UpdateWebACL</a>. </para><para> To permanently delete a <code>Rule</code> from AWS WAF, perform the following steps: </para><ol><li><para> Update the <code>Rule</code> to remove predicates, if any. For more information, see <a>UpdateRule</a>. </para></li><li><para> Use <a>GetChangeToken</a> to get the change token that you provide in the <code>ChangeToken</code> parameter of a <code>DeleteRule</code> request. </para></li><li><para> Submit a <code>DeleteRule</code> request. </para></li></ol> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAFR.RemoveWAFRRuleCmdlet.ChangeToken"> <summary> <para> <para>The value returned by the most recent call to <a>GetChangeToken</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAFR.RemoveWAFRRuleCmdlet.RuleId"> <summary> <para> <para>The <code>RuleId</code> of the <a>Rule</a> that you want to delete. <code>RuleId</code> is returned by <a>CreateRule</a> and by <a>ListRules</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAFR.RemoveWAFRRuleCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.WAFR.RemoveWAFRRuleGroupCmdlet"> <summary> Permanently deletes a <a>RuleGroup</a>. You can't delete a <code>RuleGroup</code> if it's still used in any <code>WebACL</code> objects or if it still includes any rules. <para> If you just want to remove a <code>RuleGroup</code> from a <code>WebACL</code>, use <a>UpdateWebACL</a>. </para><para> To permanently delete a <code>RuleGroup</code> from AWS WAF, perform the following steps: </para><ol><li><para> Update the <code>RuleGroup</code> to remove rules, if any. For more information, see <a>UpdateRuleGroup</a>. </para></li><li><para> Use <a>GetChangeToken</a> to get the change token that you provide in the <code>ChangeToken</code> parameter of a <code>DeleteRuleGroup</code> request. </para></li><li><para> Submit a <code>DeleteRuleGroup</code> request. </para></li></ol> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAFR.RemoveWAFRRuleGroupCmdlet.ChangeToken"> <summary> <para> <para>The value returned by the most recent call to <a>GetChangeToken</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAFR.RemoveWAFRRuleGroupCmdlet.RuleGroupId"> <summary> <para> <para>The <code>RuleGroupId</code> of the <a>RuleGroup</a> that you want to delete. <code>RuleGroupId</code> is returned by <a>CreateRuleGroup</a> and by <a>ListRuleGroups</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAFR.RemoveWAFRRuleGroupCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.WAFR.RemoveWAFRSizeConstraintSetCmdlet"> <summary> Permanently deletes a <a>SizeConstraintSet</a>. You can't delete a <code>SizeConstraintSet</code> if it's still used in any <code>Rules</code> or if it still includes any <a>SizeConstraint</a> objects (any filters). <para> If you just want to remove a <code>SizeConstraintSet</code> from a <code>Rule</code>, use <a>UpdateRule</a>. </para><para> To permanently delete a <code>SizeConstraintSet</code>, perform the following steps: </para><ol><li><para> Update the <code>SizeConstraintSet</code> to remove filters, if any. For more information, see <a>UpdateSizeConstraintSet</a>. </para></li><li><para> Use <a>GetChangeToken</a> to get the change token that you provide in the <code>ChangeToken</code> parameter of a <code>DeleteSizeConstraintSet</code> request. </para></li><li><para> Submit a <code>DeleteSizeConstraintSet</code> request. </para></li></ol> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAFR.RemoveWAFRSizeConstraintSetCmdlet.ChangeToken"> <summary> <para> <para>The value returned by the most recent call to <a>GetChangeToken</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAFR.RemoveWAFRSizeConstraintSetCmdlet.SizeConstraintSetId"> <summary> <para> <para>The <code>SizeConstraintSetId</code> of the <a>SizeConstraintSet</a> that you want to delete. <code>SizeConstraintSetId</code> is returned by <a>CreateSizeConstraintSet</a> and by <a>ListSizeConstraintSets</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAFR.RemoveWAFRSizeConstraintSetCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.WAFR.RemoveWAFRSqlInjectionMatchSetCmdlet"> <summary> Permanently deletes a <a>SqlInjectionMatchSet</a>. You can't delete a <code>SqlInjectionMatchSet</code> if it's still used in any <code>Rules</code> or if it still contains any <a>SqlInjectionMatchTuple</a> objects. <para> If you just want to remove a <code>SqlInjectionMatchSet</code> from a <code>Rule</code>, use <a>UpdateRule</a>. </para><para> To permanently delete a <code>SqlInjectionMatchSet</code> from AWS WAF, perform the following steps: </para><ol><li><para> Update the <code>SqlInjectionMatchSet</code> to remove filters, if any. For more information, see <a>UpdateSqlInjectionMatchSet</a>. </para></li><li><para> Use <a>GetChangeToken</a> to get the change token that you provide in the <code>ChangeToken</code> parameter of a <code>DeleteSqlInjectionMatchSet</code> request. </para></li><li><para> Submit a <code>DeleteSqlInjectionMatchSet</code> request. </para></li></ol> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAFR.RemoveWAFRSqlInjectionMatchSetCmdlet.ChangeToken"> <summary> <para> <para>The value returned by the most recent call to <a>GetChangeToken</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAFR.RemoveWAFRSqlInjectionMatchSetCmdlet.SqlInjectionMatchSetId"> <summary> <para> <para>The <code>SqlInjectionMatchSetId</code> of the <a>SqlInjectionMatchSet</a> that you want to delete. <code>SqlInjectionMatchSetId</code> is returned by <a>CreateSqlInjectionMatchSet</a> and by <a>ListSqlInjectionMatchSets</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAFR.RemoveWAFRSqlInjectionMatchSetCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.WAFR.RemoveWAFRWebACLCmdlet"> <summary> Permanently deletes a <a>WebACL</a>. You can't delete a <code>WebACL</code> if it still contains any <code>Rules</code>. <para> To delete a <code>WebACL</code>, perform the following steps: </para><ol><li><para> Update the <code>WebACL</code> to remove <code>Rules</code>, if any. For more information, see <a>UpdateWebACL</a>. </para></li><li><para> Use <a>GetChangeToken</a> to get the change token that you provide in the <code>ChangeToken</code> parameter of a <code>DeleteWebACL</code> request. </para></li><li><para> Submit a <code>DeleteWebACL</code> request. </para></li></ol> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAFR.RemoveWAFRWebACLCmdlet.ChangeToken"> <summary> <para> <para>The value returned by the most recent call to <a>GetChangeToken</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAFR.RemoveWAFRWebACLCmdlet.WebACLId"> <summary> <para> <para>The <code>WebACLId</code> of the <a>WebACL</a> that you want to delete. <code>WebACLId</code> is returned by <a>CreateWebACL</a> and by <a>ListWebACLs</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAFR.RemoveWAFRWebACLCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.WAFR.RemoveWAFRXssMatchSetCmdlet"> <summary> Permanently deletes an <a>XssMatchSet</a>. You can't delete an <code>XssMatchSet</code> if it's still used in any <code>Rules</code> or if it still contains any <a>XssMatchTuple</a> objects. <para> If you just want to remove an <code>XssMatchSet</code> from a <code>Rule</code>, use <a>UpdateRule</a>. </para><para> To permanently delete an <code>XssMatchSet</code> from AWS WAF, perform the following steps: </para><ol><li><para> Update the <code>XssMatchSet</code> to remove filters, if any. For more information, see <a>UpdateXssMatchSet</a>. </para></li><li><para> Use <a>GetChangeToken</a> to get the change token that you provide in the <code>ChangeToken</code> parameter of a <code>DeleteXssMatchSet</code> request. </para></li><li><para> Submit a <code>DeleteXssMatchSet</code> request. </para></li></ol> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAFR.RemoveWAFRXssMatchSetCmdlet.ChangeToken"> <summary> <para> <para>The value returned by the most recent call to <a>GetChangeToken</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAFR.RemoveWAFRXssMatchSetCmdlet.XssMatchSetId"> <summary> <para> <para>The <code>XssMatchSetId</code> of the <a>XssMatchSet</a> that you want to delete. <code>XssMatchSetId</code> is returned by <a>CreateXssMatchSet</a> and by <a>ListXssMatchSets</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAFR.RemoveWAFRXssMatchSetCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.WAFR.UnregisterWAFRWebACLCmdlet"> <summary> Removes a web ACL from the specified resource, either an application load balancer or Amazon API Gateway stage. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAFR.UnregisterWAFRWebACLCmdlet.ResourceArn"> <summary> <para> <para>The ARN (Amazon Resource Name) of the resource from which the web ACL is being removed, either an application load balancer or Amazon API Gateway stage.</para><para>The ARN should be in one of the following formats:</para><ul><li><para>For an Application Load Balancer: <code>arn:aws:elasticloadbalancing:<i>region</i>:<i>account-id</i>:loadbalancer/app/<i>load-balancer-name</i>/<i>load-balancer-id</i></code></para></li><li><para>For an Amazon API Gateway stage: <code>arn:aws:apigateway:<i>region</i>::/restapis/<i>api-id</i>/stages/<i>stage-name</i></code></para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAFR.UnregisterWAFRWebACLCmdlet.PassThru"> <summary> Returns the value passed to the ResourceArn parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAFR.UnregisterWAFRWebACLCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.WAFR.UpdateWAFRByteMatchSetCmdlet"> <summary> Inserts or deletes <a>ByteMatchTuple</a> objects (filters) in a <a>ByteMatchSet</a>. For each <code>ByteMatchTuple</code> object, you specify the following values: <ul><li><para> Whether to insert or delete the object from the array. If you want to change a <code>ByteMatchSetUpdate</code> object, you delete the existing object and add a new one. </para></li><li><para> The part of a web request that you want AWS WAF to inspect, such as a query string or the value of the <code>User-Agent</code> header. </para></li><li><para> The bytes (typically a string that corresponds with ASCII characters) that you want AWS WAF to look for. For more information, including how you specify the values for the AWS WAF API and the AWS CLI or SDKs, see <code>TargetString</code> in the <a>ByteMatchTuple</a> data type. </para></li><li><para> Where to look, such as at the beginning or the end of a query string. </para></li><li><para> Whether to perform any conversions on the request, such as converting it to lowercase, before inspecting it for the specified string. </para></li></ul><para> For example, you can add a <code>ByteMatchSetUpdate</code> object that matches web requests in which <code>User-Agent</code> headers contain the string <code>BadBot</code>. You can then configure AWS WAF to block those requests. </para><para> To create and configure a <code>ByteMatchSet</code>, perform the following steps: </para><ol><li><para> Create a <code>ByteMatchSet.</code> For more information, see <a>CreateByteMatchSet</a>. </para></li><li><para> Use <a>GetChangeToken</a> to get the change token that you provide in the <code>ChangeToken</code> parameter of an <code>UpdateByteMatchSet</code> request. </para></li><li><para> Submit an <code>UpdateByteMatchSet</code> request to specify the part of the request that you want AWS WAF to inspect (for example, the header or the URI) and the value that you want AWS WAF to watch for. </para></li></ol><para> For more information about how to use the AWS WAF API to allow or block HTTP requests, see the <a href="https://docs.aws.amazon.com/waf/latest/developerguide/">AWS WAF Developer Guide</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAFR.UpdateWAFRByteMatchSetCmdlet.ByteMatchSetId"> <summary> <para> <para>The <code>ByteMatchSetId</code> of the <a>ByteMatchSet</a> that you want to update. <code>ByteMatchSetId</code> is returned by <a>CreateByteMatchSet</a> and by <a>ListByteMatchSets</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAFR.UpdateWAFRByteMatchSetCmdlet.ChangeToken"> <summary> <para> <para>The value returned by the most recent call to <a>GetChangeToken</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAFR.UpdateWAFRByteMatchSetCmdlet.Update"> <summary> <para> <para>An array of <code>ByteMatchSetUpdate</code> objects that you want to insert into or delete from a <a>ByteMatchSet</a>. For more information, see the applicable data types:</para><ul><li><para><a>ByteMatchSetUpdate</a>: Contains <code>Action</code> and <code>ByteMatchTuple</code></para></li><li><para><a>ByteMatchTuple</a>: Contains <code>FieldToMatch</code>, <code>PositionalConstraint</code>, <code>TargetString</code>, and <code>TextTransformation</code></para></li><li><para><a>FieldToMatch</a>: Contains <code>Data</code> and <code>Type</code></para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAFR.UpdateWAFRByteMatchSetCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.WAFR.UpdateWAFRGeoMatchSetCmdlet"> <summary> Inserts or deletes <a>GeoMatchConstraint</a> objects in an <code>GeoMatchSet</code>. For each <code>GeoMatchConstraint</code> object, you specify the following values: <ul><li><para> Whether to insert or delete the object from the array. If you want to change an <code>GeoMatchConstraint</code> object, you delete the existing object and add a new one. </para></li><li><para> The <code>Type</code>. The only valid value for <code>Type</code> is <code>Country</code>. </para></li><li><para> The <code>Value</code>, which is a two character code for the country to add to the <code>GeoMatchConstraint</code> object. Valid codes are listed in <a>GeoMatchConstraint$Value</a>. </para></li></ul><para> To create and configure an <code>GeoMatchSet</code>, perform the following steps: </para><ol><li><para> Submit a <a>CreateGeoMatchSet</a> request. </para></li><li><para> Use <a>GetChangeToken</a> to get the change token that you provide in the <code>ChangeToken</code> parameter of an <a>UpdateGeoMatchSet</a> request. </para></li><li><para> Submit an <code>UpdateGeoMatchSet</code> request to specify the country that you want AWS WAF to watch for. </para></li></ol><para> When you update an <code>GeoMatchSet</code>, you specify the country that you want to add and/or the country that you want to delete. If you want to change a country, you delete the existing country and add the new one. </para><para> For more information about how to use the AWS WAF API to allow or block HTTP requests, see the <a href="https://docs.aws.amazon.com/waf/latest/developerguide/">AWS WAF Developer Guide</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAFR.UpdateWAFRGeoMatchSetCmdlet.ChangeToken"> <summary> <para> <para>The value returned by the most recent call to <a>GetChangeToken</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAFR.UpdateWAFRGeoMatchSetCmdlet.GeoMatchSetId"> <summary> <para> <para>The <code>GeoMatchSetId</code> of the <a>GeoMatchSet</a> that you want to update. <code>GeoMatchSetId</code> is returned by <a>CreateGeoMatchSet</a> and by <a>ListGeoMatchSets</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAFR.UpdateWAFRGeoMatchSetCmdlet.Update"> <summary> <para> <para>An array of <code>GeoMatchSetUpdate</code> objects that you want to insert into or delete from an <a>GeoMatchSet</a>. For more information, see the applicable data types:</para><ul><li><para><a>GeoMatchSetUpdate</a>: Contains <code>Action</code> and <code>GeoMatchConstraint</code></para></li><li><para><a>GeoMatchConstraint</a>: Contains <code>Type</code> and <code>Value</code></para><para>You can have only one <code>Type</code> and <code>Value</code> per <code>GeoMatchConstraint</code>. To add multiple countries, include multiple <code>GeoMatchSetUpdate</code> objects in your request.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAFR.UpdateWAFRGeoMatchSetCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.WAFR.UpdateWAFRIPSetCmdlet"> <summary> Inserts or deletes <a>IPSetDescriptor</a> objects in an <code>IPSet</code>. For each <code>IPSetDescriptor</code> object, you specify the following values: <ul><li><para> Whether to insert or delete the object from the array. If you want to change an <code>IPSetDescriptor</code> object, you delete the existing object and add a new one. </para></li><li><para> The IP address version, <code>IPv4</code> or <code>IPv6</code>. </para></li><li><para> The IP address in CIDR notation, for example, <code>192.0.2.0/24</code> (for the range of IP addresses from <code>192.0.2.0</code> to <code>192.0.2.255</code>) or <code>192.0.2.44/32</code> (for the individual IP address <code>192.0.2.44</code>). </para></li></ul><para> AWS WAF supports IPv4 address ranges: /8 and any range between /16 through /32. AWS WAF supports IPv6 address ranges: /24, /32, /48, /56, /64, and /128. For more information about CIDR notation, see the Wikipedia entry <a href="https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing">Classless Inter-Domain Routing</a>. </para><para> IPv6 addresses can be represented using any of the following formats: </para><ul><li><para> 1111:0000:0000:0000:0000:0000:0000:0111/128 </para></li><li><para> 1111:0:0:0:0:0:0:0111/128 </para></li><li><para> 1111::0111/128 </para></li><li><para> 1111::111/128 </para></li></ul><para> You use an <code>IPSet</code> to specify which web requests you want to allow or block based on the IP addresses that the requests originated from. For example, if you're receiving a lot of requests from one or a small number of IP addresses and you want to block the requests, you can create an <code>IPSet</code> that specifies those IP addresses, and then configure AWS WAF to block the requests. </para><para> To create and configure an <code>IPSet</code>, perform the following steps: </para><ol><li><para> Submit a <a>CreateIPSet</a> request. </para></li><li><para> Use <a>GetChangeToken</a> to get the change token that you provide in the <code>ChangeToken</code> parameter of an <a>UpdateIPSet</a> request. </para></li><li><para> Submit an <code>UpdateIPSet</code> request to specify the IP addresses that you want AWS WAF to watch for. </para></li></ol><para> When you update an <code>IPSet</code>, you specify the IP addresses that you want to add and/or the IP addresses that you want to delete. If you want to change an IP address, you delete the existing IP address and add the new one. </para><para> You can insert a maximum of 1000 addresses in a single request. </para><para> For more information about how to use the AWS WAF API to allow or block HTTP requests, see the <a href="https://docs.aws.amazon.com/waf/latest/developerguide/">AWS WAF Developer Guide</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAFR.UpdateWAFRIPSetCmdlet.ChangeToken"> <summary> <para> <para>The value returned by the most recent call to <a>GetChangeToken</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAFR.UpdateWAFRIPSetCmdlet.IPSetId"> <summary> <para> <para>The <code>IPSetId</code> of the <a>IPSet</a> that you want to update. <code>IPSetId</code> is returned by <a>CreateIPSet</a> and by <a>ListIPSets</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAFR.UpdateWAFRIPSetCmdlet.Update"> <summary> <para> <para>An array of <code>IPSetUpdate</code> objects that you want to insert into or delete from an <a>IPSet</a>. For more information, see the applicable data types:</para><ul><li><para><a>IPSetUpdate</a>: Contains <code>Action</code> and <code>IPSetDescriptor</code></para></li><li><para><a>IPSetDescriptor</a>: Contains <code>Type</code> and <code>Value</code></para></li></ul><para>You can insert a maximum of 1000 addresses in a single request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAFR.UpdateWAFRIPSetCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.WAFR.UpdateWAFRRateBasedRuleCmdlet"> <summary> Inserts or deletes <a>Predicate</a> objects in a rule and updates the <code>RateLimit</code> in the rule. <para> Each <code>Predicate</code> object identifies a predicate, such as a <a>ByteMatchSet</a> or an <a>IPSet</a>, that specifies the web requests that you want to block or count. The <code>RateLimit</code> specifies the number of requests every five minutes that triggers the rule. </para><para> If you add more than one predicate to a <code>RateBasedRule</code>, a request must match all the predicates and exceed the <code>RateLimit</code> to be counted or blocked. For example, suppose you add the following to a <code>RateBasedRule</code>: </para><ul><li><para> An <code>IPSet</code> that matches the IP address <code>192.0.2.44/32</code></para></li><li><para> A <code>ByteMatchSet</code> that matches <code>BadBot</code> in the <code>User-Agent</code> header </para></li></ul><para> Further, you specify a <code>RateLimit</code> of 15,000. </para><para> You then add the <code>RateBasedRule</code> to a <code>WebACL</code> and specify that you want to block requests that satisfy the rule. For a request to be blocked, it must come from the IP address 192.0.2.44 <i>and</i> the <code>User-Agent</code> header in the request must contain the value <code>BadBot</code>. Further, requests that match these two conditions much be received at a rate of more than 15,000 every five minutes. If the rate drops below this limit, AWS WAF no longer blocks the requests. </para><para> As a second example, suppose you want to limit requests to a particular page on your site. To do this, you could add the following to a <code>RateBasedRule</code>: </para><ul><li><para> A <code>ByteMatchSet</code> with <code>FieldToMatch</code> of <code>URI</code></para></li><li><para> A <code>PositionalConstraint</code> of <code>STARTS_WITH</code></para></li><li><para> A <code>TargetString</code> of <code>login</code></para></li></ul><para> Further, you specify a <code>RateLimit</code> of 15,000. </para><para> By adding this <code>RateBasedRule</code> to a <code>WebACL</code>, you could limit requests to your login page without affecting the rest of your site. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAFR.UpdateWAFRRateBasedRuleCmdlet.ChangeToken"> <summary> <para> <para>The value returned by the most recent call to <a>GetChangeToken</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAFR.UpdateWAFRRateBasedRuleCmdlet.RateLimit"> <summary> <para> <para>The maximum number of requests, which have an identical value in the field specified by the <code>RateKey</code>, allowed in a five-minute period. If the number of requests exceeds the <code>RateLimit</code> and the other predicates specified in the rule are also met, AWS WAF triggers the action that is specified for this rule.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAFR.UpdateWAFRRateBasedRuleCmdlet.RuleId"> <summary> <para> <para>The <code>RuleId</code> of the <code>RateBasedRule</code> that you want to update. <code>RuleId</code> is returned by <code>CreateRateBasedRule</code> and by <a>ListRateBasedRules</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAFR.UpdateWAFRRateBasedRuleCmdlet.Update"> <summary> <para> <para>An array of <code>RuleUpdate</code> objects that you want to insert into or delete from a <a>RateBasedRule</a>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAFR.UpdateWAFRRateBasedRuleCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.WAFR.UpdateWAFRRegexMatchSetCmdlet"> <summary> Inserts or deletes <a>RegexMatchTuple</a> objects (filters) in a <a>RegexMatchSet</a>. For each <code>RegexMatchSetUpdate</code> object, you specify the following values: <ul><li><para> Whether to insert or delete the object from the array. If you want to change a <code>RegexMatchSetUpdate</code> object, you delete the existing object and add a new one. </para></li><li><para> The part of a web request that you want AWS WAF to inspectupdate, such as a query string or the value of the <code>User-Agent</code> header. </para></li><li><para> The identifier of the pattern (a regular expression) that you want AWS WAF to look for. For more information, see <a>RegexPatternSet</a>. </para></li><li><para> Whether to perform any conversions on the request, such as converting it to lowercase, before inspecting it for the specified string. </para></li></ul><para> For example, you can create a <code>RegexPatternSet</code> that matches any requests with <code>User-Agent</code> headers that contain the string <code>B[a@]dB[o0]t</code>. You can then configure AWS WAF to reject those requests. </para><para> To create and configure a <code>RegexMatchSet</code>, perform the following steps: </para><ol><li><para> Create a <code>RegexMatchSet.</code> For more information, see <a>CreateRegexMatchSet</a>. </para></li><li><para> Use <a>GetChangeToken</a> to get the change token that you provide in the <code>ChangeToken</code> parameter of an <code>UpdateRegexMatchSet</code> request. </para></li><li><para> Submit an <code>UpdateRegexMatchSet</code> request to specify the part of the request that you want AWS WAF to inspect (for example, the header or the URI) and the identifier of the <code>RegexPatternSet</code> that contain the regular expression patters you want AWS WAF to watch for. </para></li></ol><para> For more information about how to use the AWS WAF API to allow or block HTTP requests, see the <a href="https://docs.aws.amazon.com/waf/latest/developerguide/">AWS WAF Developer Guide</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAFR.UpdateWAFRRegexMatchSetCmdlet.ChangeToken"> <summary> <para> <para>The value returned by the most recent call to <a>GetChangeToken</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAFR.UpdateWAFRRegexMatchSetCmdlet.RegexMatchSetId"> <summary> <para> <para>The <code>RegexMatchSetId</code> of the <a>RegexMatchSet</a> that you want to update. <code>RegexMatchSetId</code> is returned by <a>CreateRegexMatchSet</a> and by <a>ListRegexMatchSets</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAFR.UpdateWAFRRegexMatchSetCmdlet.Update"> <summary> <para> <para>An array of <code>RegexMatchSetUpdate</code> objects that you want to insert into or delete from a <a>RegexMatchSet</a>. For more information, see <a>RegexMatchTuple</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAFR.UpdateWAFRRegexMatchSetCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.WAFR.UpdateWAFRRegexPatternSetCmdlet"> <summary> Inserts or deletes <code>RegexPatternString</code> objects in a <a>RegexPatternSet</a>. For each <code>RegexPatternString</code> object, you specify the following values: <ul><li><para> Whether to insert or delete the <code>RegexPatternString</code>. </para></li><li><para> The regular expression pattern that you want to insert or delete. For more information, see <a>RegexPatternSet</a>. </para></li></ul><para> For example, you can create a <code>RegexPatternString</code> such as <code>B[a@]dB[o0]t</code>. AWS WAF will match this <code>RegexPatternString</code> to: </para><ul><li><para> BadBot </para></li><li><para> BadB0t </para></li><li><para> B@dBot </para></li><li><para> B@dB0t </para></li></ul><para> To create and configure a <code>RegexPatternSet</code>, perform the following steps: </para><ol><li><para> Create a <code>RegexPatternSet.</code> For more information, see <a>CreateRegexPatternSet</a>. </para></li><li><para> Use <a>GetChangeToken</a> to get the change token that you provide in the <code>ChangeToken</code> parameter of an <code>UpdateRegexPatternSet</code> request. </para></li><li><para> Submit an <code>UpdateRegexPatternSet</code> request to specify the regular expression pattern that you want AWS WAF to watch for. </para></li></ol><para> For more information about how to use the AWS WAF API to allow or block HTTP requests, see the <a href="https://docs.aws.amazon.com/waf/latest/developerguide/">AWS WAF Developer Guide</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAFR.UpdateWAFRRegexPatternSetCmdlet.ChangeToken"> <summary> <para> <para>The value returned by the most recent call to <a>GetChangeToken</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAFR.UpdateWAFRRegexPatternSetCmdlet.RegexPatternSetId"> <summary> <para> <para>The <code>RegexPatternSetId</code> of the <a>RegexPatternSet</a> that you want to update. <code>RegexPatternSetId</code> is returned by <a>CreateRegexPatternSet</a> and by <a>ListRegexPatternSets</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAFR.UpdateWAFRRegexPatternSetCmdlet.Update"> <summary> <para> <para>An array of <code>RegexPatternSetUpdate</code> objects that you want to insert into or delete from a <a>RegexPatternSet</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAFR.UpdateWAFRRegexPatternSetCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.WAFR.UpdateWAFRRuleCmdlet"> <summary> Inserts or deletes <a>Predicate</a> objects in a <code>Rule</code>. Each <code>Predicate</code> object identifies a predicate, such as a <a>ByteMatchSet</a> or an <a>IPSet</a>, that specifies the web requests that you want to allow, block, or count. If you add more than one predicate to a <code>Rule</code>, a request must match all of the specifications to be allowed, blocked, or counted. For example, suppose that you add the following to a <code>Rule</code>: <ul><li><para> A <code>ByteMatchSet</code> that matches the value <code>BadBot</code> in the <code>User-Agent</code> header </para></li><li><para> An <code>IPSet</code> that matches the IP address <code>192.0.2.44</code></para></li></ul><para> You then add the <code>Rule</code> to a <code>WebACL</code> and specify that you want to block requests that satisfy the <code>Rule</code>. For a request to be blocked, the <code>User-Agent</code> header in the request must contain the value <code>BadBot</code><i>and</i> the request must originate from the IP address 192.0.2.44. </para><para> To create and configure a <code>Rule</code>, perform the following steps: </para><ol><li><para> Create and update the predicates that you want to include in the <code>Rule</code>. </para></li><li><para> Create the <code>Rule</code>. See <a>CreateRule</a>. </para></li><li><para> Use <code>GetChangeToken</code> to get the change token that you provide in the <code>ChangeToken</code> parameter of an <a>UpdateRule</a> request. </para></li><li><para> Submit an <code>UpdateRule</code> request to add predicates to the <code>Rule</code>. </para></li><li><para> Create and update a <code>WebACL</code> that contains the <code>Rule</code>. See <a>CreateWebACL</a>. </para></li></ol><para> If you want to replace one <code>ByteMatchSet</code> or <code>IPSet</code> with another, you delete the existing one and add the new one. </para><para> For more information about how to use the AWS WAF API to allow or block HTTP requests, see the <a href="https://docs.aws.amazon.com/waf/latest/developerguide/">AWS WAF Developer Guide</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAFR.UpdateWAFRRuleCmdlet.ChangeToken"> <summary> <para> <para>The value returned by the most recent call to <a>GetChangeToken</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAFR.UpdateWAFRRuleCmdlet.RuleId"> <summary> <para> <para>The <code>RuleId</code> of the <code>Rule</code> that you want to update. <code>RuleId</code> is returned by <code>CreateRule</code> and by <a>ListRules</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAFR.UpdateWAFRRuleCmdlet.Update"> <summary> <para> <para>An array of <code>RuleUpdate</code> objects that you want to insert into or delete from a <a>Rule</a>. For more information, see the applicable data types:</para><ul><li><para><a>RuleUpdate</a>: Contains <code>Action</code> and <code>Predicate</code></para></li><li><para><a>Predicate</a>: Contains <code>DataId</code>, <code>Negated</code>, and <code>Type</code></para></li><li><para><a>FieldToMatch</a>: Contains <code>Data</code> and <code>Type</code></para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAFR.UpdateWAFRRuleCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.WAFR.UpdateWAFRRuleGroupCmdlet"> <summary> Inserts or deletes <a>ActivatedRule</a> objects in a <code>RuleGroup</code>. <para> You can only insert <code>REGULAR</code> rules into a rule group. </para><para> You can have a maximum of ten rules per rule group. </para><para> To create and configure a <code>RuleGroup</code>, perform the following steps: </para><ol><li><para> Create and update the <code>Rules</code> that you want to include in the <code>RuleGroup</code>. See <a>CreateRule</a>. </para></li><li><para> Use <code>GetChangeToken</code> to get the change token that you provide in the <code>ChangeToken</code> parameter of an <a>UpdateRuleGroup</a> request. </para></li><li><para> Submit an <code>UpdateRuleGroup</code> request to add <code>Rules</code> to the <code>RuleGroup</code>. </para></li><li><para> Create and update a <code>WebACL</code> that contains the <code>RuleGroup</code>. See <a>CreateWebACL</a>. </para></li></ol><para> If you want to replace one <code>Rule</code> with another, you delete the existing one and add the new one. </para><para> For more information about how to use the AWS WAF API to allow or block HTTP requests, see the <a href="https://docs.aws.amazon.com/waf/latest/developerguide/">AWS WAF Developer Guide</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAFR.UpdateWAFRRuleGroupCmdlet.ChangeToken"> <summary> <para> <para>The value returned by the most recent call to <a>GetChangeToken</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAFR.UpdateWAFRRuleGroupCmdlet.RuleGroupId"> <summary> <para> <para>The <code>RuleGroupId</code> of the <a>RuleGroup</a> that you want to update. <code>RuleGroupId</code> is returned by <a>CreateRuleGroup</a> and by <a>ListRuleGroups</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAFR.UpdateWAFRRuleGroupCmdlet.Update"> <summary> <para> <para>An array of <code>RuleGroupUpdate</code> objects that you want to insert into or delete from a <a>RuleGroup</a>.</para><para>You can only insert <code>REGULAR</code> rules into a rule group.</para><para><code>ActivatedRule|OverrideAction</code> applies only when updating or adding a <code>RuleGroup</code> to a <code>WebACL</code>. In this case you do not use <code>ActivatedRule|Action</code>. For all other update requests, <code>ActivatedRule|Action</code> is used instead of <code>ActivatedRule|OverrideAction</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAFR.UpdateWAFRRuleGroupCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.WAFR.UpdateWAFRSizeConstraintSetCmdlet"> <summary> Inserts or deletes <a>SizeConstraint</a> objects (filters) in a <a>SizeConstraintSet</a>. For each <code>SizeConstraint</code> object, you specify the following values: <ul><li><para> Whether to insert or delete the object from the array. If you want to change a <code>SizeConstraintSetUpdate</code> object, you delete the existing object and add a new one. </para></li><li><para> The part of a web request that you want AWS WAF to evaluate, such as the length of a query string or the length of the <code>User-Agent</code> header. </para></li><li><para> Whether to perform any transformations on the request, such as converting it to lowercase, before checking its length. Note that transformations of the request body are not supported because the AWS resource forwards only the first <code>8192</code> bytes of your request to AWS WAF. </para><para> You can only specify a single type of TextTransformation. </para></li><li><para> A <code>ComparisonOperator</code> used for evaluating the selected part of the request against the specified <code>Size</code>, such as equals, greater than, less than, and so on. </para></li><li><para> The length, in bytes, that you want AWS WAF to watch for in selected part of the request. The length is computed after applying the transformation. </para></li></ul><para> For example, you can add a <code>SizeConstraintSetUpdate</code> object that matches web requests in which the length of the <code>User-Agent</code> header is greater than 100 bytes. You can then configure AWS WAF to block those requests. </para><para> To create and configure a <code>SizeConstraintSet</code>, perform the following steps: </para><ol><li><para> Create a <code>SizeConstraintSet.</code> For more information, see <a>CreateSizeConstraintSet</a>. </para></li><li><para> Use <a>GetChangeToken</a> to get the change token that you provide in the <code>ChangeToken</code> parameter of an <code>UpdateSizeConstraintSet</code> request. </para></li><li><para> Submit an <code>UpdateSizeConstraintSet</code> request to specify the part of the request that you want AWS WAF to inspect (for example, the header or the URI) and the value that you want AWS WAF to watch for. </para></li></ol><para> For more information about how to use the AWS WAF API to allow or block HTTP requests, see the <a href="https://docs.aws.amazon.com/waf/latest/developerguide/">AWS WAF Developer Guide</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAFR.UpdateWAFRSizeConstraintSetCmdlet.ChangeToken"> <summary> <para> <para>The value returned by the most recent call to <a>GetChangeToken</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAFR.UpdateWAFRSizeConstraintSetCmdlet.SizeConstraintSetId"> <summary> <para> <para>The <code>SizeConstraintSetId</code> of the <a>SizeConstraintSet</a> that you want to update. <code>SizeConstraintSetId</code> is returned by <a>CreateSizeConstraintSet</a> and by <a>ListSizeConstraintSets</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAFR.UpdateWAFRSizeConstraintSetCmdlet.Update"> <summary> <para> <para>An array of <code>SizeConstraintSetUpdate</code> objects that you want to insert into or delete from a <a>SizeConstraintSet</a>. For more information, see the applicable data types:</para><ul><li><para><a>SizeConstraintSetUpdate</a>: Contains <code>Action</code> and <code>SizeConstraint</code></para></li><li><para><a>SizeConstraint</a>: Contains <code>FieldToMatch</code>, <code>TextTransformation</code>, <code>ComparisonOperator</code>, and <code>Size</code></para></li><li><para><a>FieldToMatch</a>: Contains <code>Data</code> and <code>Type</code></para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAFR.UpdateWAFRSizeConstraintSetCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.WAFR.UpdateWAFRSqlInjectionMatchSetCmdlet"> <summary> Inserts or deletes <a>SqlInjectionMatchTuple</a> objects (filters) in a <a>SqlInjectionMatchSet</a>. For each <code>SqlInjectionMatchTuple</code> object, you specify the following values: <ul><li><para><code>Action</code>: Whether to insert the object into or delete the object from the array. To change a <code>SqlInjectionMatchTuple</code>, you delete the existing object and add a new one. </para></li><li><para><code>FieldToMatch</code>: The part of web requests that you want AWS WAF to inspect and, if you want AWS WAF to inspect a header or custom query parameter, the name of the header or parameter. </para></li><li><para><code>TextTransformation</code>: Which text transformation, if any, to perform on the web request before inspecting the request for snippets of malicious SQL code. </para><para> You can only specify a single type of TextTransformation. </para></li></ul><para> You use <code>SqlInjectionMatchSet</code> objects to specify which CloudFront requests that you want to allow, block, or count. For example, if you're receiving requests that contain snippets of SQL code in the query string and you want to block the requests, you can create a <code>SqlInjectionMatchSet</code> with the applicable settings, and then configure AWS WAF to block the requests. </para><para> To create and configure a <code>SqlInjectionMatchSet</code>, perform the following steps: </para><ol><li><para> Submit a <a>CreateSqlInjectionMatchSet</a> request. </para></li><li><para> Use <a>GetChangeToken</a> to get the change token that you provide in the <code>ChangeToken</code> parameter of an <a>UpdateIPSet</a> request. </para></li><li><para> Submit an <code>UpdateSqlInjectionMatchSet</code> request to specify the parts of web requests that you want AWS WAF to inspect for snippets of SQL code. </para></li></ol><para> For more information about how to use the AWS WAF API to allow or block HTTP requests, see the <a href="https://docs.aws.amazon.com/waf/latest/developerguide/">AWS WAF Developer Guide</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAFR.UpdateWAFRSqlInjectionMatchSetCmdlet.ChangeToken"> <summary> <para> <para>The value returned by the most recent call to <a>GetChangeToken</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAFR.UpdateWAFRSqlInjectionMatchSetCmdlet.SqlInjectionMatchSetId"> <summary> <para> <para>The <code>SqlInjectionMatchSetId</code> of the <code>SqlInjectionMatchSet</code> that you want to update. <code>SqlInjectionMatchSetId</code> is returned by <a>CreateSqlInjectionMatchSet</a> and by <a>ListSqlInjectionMatchSets</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAFR.UpdateWAFRSqlInjectionMatchSetCmdlet.Update"> <summary> <para> <para>An array of <code>SqlInjectionMatchSetUpdate</code> objects that you want to insert into or delete from a <a>SqlInjectionMatchSet</a>. For more information, see the applicable data types:</para><ul><li><para><a>SqlInjectionMatchSetUpdate</a>: Contains <code>Action</code> and <code>SqlInjectionMatchTuple</code></para></li><li><para><a>SqlInjectionMatchTuple</a>: Contains <code>FieldToMatch</code> and <code>TextTransformation</code></para></li><li><para><a>FieldToMatch</a>: Contains <code>Data</code> and <code>Type</code></para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAFR.UpdateWAFRSqlInjectionMatchSetCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.WAFR.UpdateWAFRWebACLCmdlet"> <summary> Inserts or deletes <a>ActivatedRule</a> objects in a <code>WebACL</code>. Each <code>Rule</code> identifies web requests that you want to allow, block, or count. When you update a <code>WebACL</code>, you specify the following values: <ul><li><para> A default action for the <code>WebACL</code>, either <code>ALLOW</code> or <code>BLOCK</code>. AWS WAF performs the default action if a request doesn't match the criteria in any of the <code>Rules</code> in a <code>WebACL</code>. </para></li><li><para> The <code>Rules</code> that you want to add or delete. If you want to replace one <code>Rule</code> with another, you delete the existing <code>Rule</code> and add the new one. </para></li><li><para> For each <code>Rule</code>, whether you want AWS WAF to allow requests, block requests, or count requests that match the conditions in the <code>Rule</code>. </para></li><li><para> The order in which you want AWS WAF to evaluate the <code>Rules</code> in a <code>WebACL</code>. If you add more than one <code>Rule</code> to a <code>WebACL</code>, AWS WAF evaluates each request against the <code>Rules</code> in order based on the value of <code>Priority</code>. (The <code>Rule</code> that has the lowest value for <code>Priority</code> is evaluated first.) When a web request matches all the predicates (such as <code>ByteMatchSets</code> and <code>IPSets</code>) in a <code>Rule</code>, AWS WAF immediately takes the corresponding action, allow or block, and doesn't evaluate the request against the remaining <code>Rules</code> in the <code>WebACL</code>, if any. </para></li></ul><para> To create and configure a <code>WebACL</code>, perform the following steps: </para><ol><li><para> Create and update the predicates that you want to include in <code>Rules</code>. For more information, see <a>CreateByteMatchSet</a>, <a>UpdateByteMatchSet</a>, <a>CreateIPSet</a>, <a>UpdateIPSet</a>, <a>CreateSqlInjectionMatchSet</a>, and <a>UpdateSqlInjectionMatchSet</a>. </para></li><li><para> Create and update the <code>Rules</code> that you want to include in the <code>WebACL</code>. For more information, see <a>CreateRule</a> and <a>UpdateRule</a>. </para></li><li><para> Create a <code>WebACL</code>. See <a>CreateWebACL</a>. </para></li><li><para> Use <code>GetChangeToken</code> to get the change token that you provide in the <code>ChangeToken</code> parameter of an <a>UpdateWebACL</a> request. </para></li><li><para> Submit an <code>UpdateWebACL</code> request to specify the <code>Rules</code> that you want to include in the <code>WebACL</code>, to specify the default action, and to associate the <code>WebACL</code> with a CloudFront distribution. </para><para> The <code>ActivatedRule</code> can be a rule group. If you specify a rule group as your <code>ActivatedRule</code>, you can exclude specific rules from that rule group. </para><para> If you already have a rule group associated with a web ACL and want to submit an <code>UpdateWebACL</code> 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 <a>ActivatedRule$ExcludedRules</a>. </para></li></ol><para> 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 <a>UpdateWebACL</a> request will fail because the request tries to add a REGULAR rule (the default rule type) with the specified ID, which does not exist. </para><para> For more information about how to use the AWS WAF API to allow or block HTTP requests, see the <a href="https://docs.aws.amazon.com/waf/latest/developerguide/">AWS WAF Developer Guide</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAFR.UpdateWAFRWebACLCmdlet.ChangeToken"> <summary> <para> <para>The value returned by the most recent call to <a>GetChangeToken</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAFR.UpdateWAFRWebACLCmdlet.DefaultAction_Type"> <summary> <para> <para>Specifies how you want AWS WAF to respond to requests that match the settings in a <code>Rule</code>. Valid settings include the following:</para><ul><li><para><code>ALLOW</code>: AWS WAF allows requests</para></li><li><para><code>BLOCK</code>: AWS WAF blocks requests</para></li><li><para><code>COUNT</code>: AWS WAF increments a counter of the requests that match all of the conditions in the rule. AWS WAF then continues to inspect the web request based on the remaining rules in the web ACL. You can't specify <code>COUNT</code> for the default action for a <code>WebACL</code>.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAFR.UpdateWAFRWebACLCmdlet.Update"> <summary> <para> <para>An array of updates to make to the <a>WebACL</a>.</para><para>An array of <code>WebACLUpdate</code> objects that you want to insert into or delete from a <a>WebACL</a>. For more information, see the applicable data types:</para><ul><li><para><a>WebACLUpdate</a>: Contains <code>Action</code> and <code>ActivatedRule</code></para></li><li><para><a>ActivatedRule</a>: Contains <code>Action</code>, <code>OverrideAction</code>, <code>Priority</code>, <code>RuleId</code>, and <code>Type</code>. <code>ActivatedRule|OverrideAction</code> applies only when updating or adding a <code>RuleGroup</code> to a <code>WebACL</code>. In this case, you do not use <code>ActivatedRule|Action</code>. For all other update requests, <code>ActivatedRule|Action</code> is used instead of <code>ActivatedRule|OverrideAction</code>. </para></li><li><para><a>WafAction</a>: Contains <code>Type</code></para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAFR.UpdateWAFRWebACLCmdlet.WebACLId"> <summary> <para> <para>The <code>WebACLId</code> of the <a>WebACL</a> that you want to update. <code>WebACLId</code> is returned by <a>CreateWebACL</a> and by <a>ListWebACLs</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAFR.UpdateWAFRWebACLCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.WAFR.UpdateWAFRXssMatchSetCmdlet"> <summary> Inserts or deletes <a>XssMatchTuple</a> objects (filters) in an <a>XssMatchSet</a>. For each <code>XssMatchTuple</code> object, you specify the following values: <ul><li><para><code>Action</code>: Whether to insert the object into or delete the object from the array. To change an <code>XssMatchTuple</code>, you delete the existing object and add a new one. </para></li><li><para><code>FieldToMatch</code>: The part of web requests that you want AWS WAF to inspect and, if you want AWS WAF to inspect a header or custom query parameter, the name of the header or parameter. </para></li><li><para><code>TextTransformation</code>: Which text transformation, if any, to perform on the web request before inspecting the request for cross-site scripting attacks. </para><para> You can only specify a single type of TextTransformation. </para></li></ul><para> You use <code>XssMatchSet</code> objects to specify which CloudFront requests that you want to allow, block, or count. For example, if you're receiving requests that contain cross-site scripting attacks in the request body and you want to block the requests, you can create an <code>XssMatchSet</code> with the applicable settings, and then configure AWS WAF to block the requests. </para><para> To create and configure an <code>XssMatchSet</code>, perform the following steps: </para><ol><li><para> Submit a <a>CreateXssMatchSet</a> request. </para></li><li><para> Use <a>GetChangeToken</a> to get the change token that you provide in the <code>ChangeToken</code> parameter of an <a>UpdateIPSet</a> request. </para></li><li><para> Submit an <code>UpdateXssMatchSet</code> request to specify the parts of web requests that you want AWS WAF to inspect for cross-site scripting attacks. </para></li></ol><para> For more information about how to use the AWS WAF API to allow or block HTTP requests, see the <a href="https://docs.aws.amazon.com/waf/latest/developerguide/">AWS WAF Developer Guide</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAFR.UpdateWAFRXssMatchSetCmdlet.ChangeToken"> <summary> <para> <para>The value returned by the most recent call to <a>GetChangeToken</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAFR.UpdateWAFRXssMatchSetCmdlet.Update"> <summary> <para> <para>An array of <code>XssMatchSetUpdate</code> objects that you want to insert into or delete from an <a>XssMatchSet</a>. For more information, see the applicable data types:</para><ul><li><para><a>XssMatchSetUpdate</a>: Contains <code>Action</code> and <code>XssMatchTuple</code></para></li><li><para><a>XssMatchTuple</a>: Contains <code>FieldToMatch</code> and <code>TextTransformation</code></para></li><li><para><a>FieldToMatch</a>: Contains <code>Data</code> and <code>Type</code></para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAFR.UpdateWAFRXssMatchSetCmdlet.XssMatchSetId"> <summary> <para> <para>The <code>XssMatchSetId</code> of the <code>XssMatchSet</code> that you want to update. <code>XssMatchSetId</code> is returned by <a>CreateXssMatchSet</a> and by <a>ListXssMatchSets</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAFR.UpdateWAFRXssMatchSetCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.WAFR.WriteWAFRLoggingConfigurationCmdlet"> <summary> Associates a <a>LoggingConfiguration</a> with a specified web ACL. <para> You can access information about all traffic that AWS WAF inspects using the following steps: </para><ol><li><para> Create an Amazon Kinesis Data Firehose. </para><para> Create the data firehose with a PUT source and in the region that you are operating. However, if you are capturing logs for Amazon CloudFront, always create the firehose in US East (N. Virginia). </para><note><para> Do not create the data firehose using a <code>Kinesis stream</code> as your source. </para></note></li><li><para> Associate that firehose to your web ACL using a <code>PutLoggingConfiguration</code> request. </para></li></ol><para> When you successfully enable logging using a <code>PutLoggingConfiguration</code> request, AWS WAF will create a service linked role with the necessary permissions to write logs to the Amazon Kinesis Data Firehose. For more information, see <a href="https://docs.aws.amazon.com/waf/latest/developerguide/logging.html">Logging Web ACL Traffic Information</a> in the <i>AWS WAF Developer Guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAFR.WriteWAFRLoggingConfigurationCmdlet.LoggingConfiguration_LogDestinationConfig"> <summary> <para> <para>An array of Amazon Kinesis Data Firehose ARNs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAFR.WriteWAFRLoggingConfigurationCmdlet.LoggingConfiguration_RedactedField"> <summary> <para> <para>The parts of the request that you want redacted from the logs. For example, if you redact the cookie field, the cookie field in the firehose will be <code>xxx</code>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAFR.WriteWAFRLoggingConfigurationCmdlet.LoggingConfiguration_ResourceArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the web ACL that you want to associate with <code>LogDestinationConfigs</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAFR.WriteWAFRLoggingConfigurationCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.WAFR.WriteWAFRPermissionPolicyCmdlet"> <summary> Attaches a IAM policy to the specified resource. The only supported use for this action is to share a RuleGroup across accounts. <para> The <code>PutPermissionPolicy</code> is subject to the following restrictions: </para><ul><li><para> You can attach only one policy with each <code>PutPermissionPolicy</code> request. </para></li><li><para> The policy must include an <code>Effect</code>, <code>Action</code> and <code>Principal</code>. </para></li><li><para><code>Effect</code> must specify <code>Allow</code>. </para></li><li><para> The <code>Action</code> in the policy must be <code>waf:UpdateWebACL</code>, <code>waf-regional:UpdateWebACL</code>, <code>waf:GetRuleGroup</code> and <code>waf-regional:GetRuleGroup</code> . Any extra or wildcard actions in the policy will be rejected. </para></li><li><para> The policy cannot include a <code>Resource</code> parameter. </para></li><li><para> The ARN in the request must be a valid WAF RuleGroup ARN and the RuleGroup must exist in the same region. </para></li><li><para> The user making the request must be the owner of the RuleGroup. </para></li><li><para> Your policy must be composed using IAM Policy version 2012-10-17. </para></li></ul><para> For more information, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html">IAM Policies</a>. </para><para> An example of a valid policy parameter is shown in the Examples section below. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAFR.WriteWAFRPermissionPolicyCmdlet.Policy"> <summary> <para> <para>The policy to attach to the specified RuleGroup.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAFR.WriteWAFRPermissionPolicyCmdlet.ResourceArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the RuleGroup to which you want to attach the policy.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAFR.WriteWAFRPermissionPolicyCmdlet.PassThru"> <summary> Returns the value passed to the Policy parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAFR.WriteWAFRPermissionPolicyCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> </members> </doc> |