AWS.Tools.WAFV2.XML
|
<?xml version="1.0"?>
<doc> <assembly> <name>AWS.Tools.WAFV2</name> </assembly> <members> <member name="T:Amazon.PowerShell.Cmdlets.WAF2.AddWAF2ResourceTagCmdlet"> <summary> <note><para> This is the latest version of <b>AWS WAF</b>, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the <a href="https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html">AWS WAF Developer Guide</a>. </para></note><para> Associates tags with the specified AWS resource. Tags are key:value pairs that you can use to categorize and manage your resources, for purposes like billing. For example, you might set the tag key to "customer" and the value to the customer name or ID. You can specify one or more tags to add to each AWS resource, up to 50 tags for a resource. </para><para> You can tag the AWS resources that you manage through AWS WAF: web ACLs, rule groups, IP sets, and regex pattern sets. You can't manage or view tags through the AWS WAF console. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.AddWAF2ResourceTagCmdlet.ResourceARN"> <summary> <para> <para>The Amazon Resource Name (ARN) of the resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.AddWAF2ResourceTagCmdlet.Tag"> <summary> <para> <para>An array of key:value pairs to associate with the resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.AddWAF2ResourceTagCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.WAFV2.Model.TagResourceResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.AddWAF2ResourceTagCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ResourceARN parameter. The -PassThru parameter is deprecated, use -Select '^ResourceARN' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.AddWAF2ResourceTagCmdlet.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.WAF2.AddWAF2WebACLToResourceCmdlet"> <summary> <note><para> This is the latest version of <b>AWS WAF</b>, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the <a href="https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html">AWS WAF Developer Guide</a>. </para></note><para> Associates a Web ACL with a regional application resource, to protect the resource. A regional application can be an Application Load Balancer (ALB) or an API Gateway stage. </para><para> For AWS CloudFront, don't use this call. Instead, use your CloudFront distribution configuration. To associate a Web ACL, in the CloudFront call <code>UpdateDistribution</code>, set the web ACL ID to the Amazon Resource Name (ARN) of the Web ACL. For information, see <a href="https://docs.aws.amazon.com/cloudfront/latest/APIReference/API_UpdateDistribution.html">UpdateDistribution</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.AddWAF2WebACLToResourceCmdlet.ResourceArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the resource to associate with the web ACL. </para><para>The ARN must 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.WAF2.AddWAF2WebACLToResourceCmdlet.WebACLArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the Web ACL that you want to associate with the resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.AddWAF2WebACLToResourceCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.WAFV2.Model.AssociateWebACLResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.AddWAF2WebACLToResourceCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the WebACLArn parameter. The -PassThru parameter is deprecated, use -Select '^WebACLArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.AddWAF2WebACLToResourceCmdlet.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.WAF2.GetWAF2AvailableManagedRuleGroupListCmdlet"> <summary> <note><para> This is the latest version of <b>AWS WAF</b>, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the <a href="https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html">AWS WAF Developer Guide</a>. </para></note><para> Retrieves an array of managed rule groups that are available for you to use. This list includes all AWS Managed Rules rule groups and the AWS Marketplace managed rule groups that you're subscribed to. </para><br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.GetWAF2AvailableManagedRuleGroupListCmdlet.Scope"> <summary> <para> <para>Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB) or an API Gateway stage. </para><para>To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows: </para><ul><li><para>CLI - Specify the Region when you use the CloudFront scope: <code>--scope=CLOUDFRONT --region=us-east-1</code>. </para></li><li><para>API and SDKs - For all calls, use the Region endpoint us-east-1. </para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.GetWAF2AvailableManagedRuleGroupListCmdlet.Limit"> <summary> <para> <para>The maximum number of objects that you want AWS WAF to return for this request. If more objects are available, in the response, AWS WAF provides a <code>NextMarker</code> value that you can use in a subsequent call to get the next batch of objects.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.GetWAF2AvailableManagedRuleGroupListCmdlet.NextMarker"> <summary> <para> <para>When you request a list of objects with a <code>Limit</code> setting, if the number of objects that are still available for retrieval exceeds the limit, AWS WAF returns a <code>NextMarker</code> value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next 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, use '-NextMarker $null' for the first call and '-NextMarker $AWSHistory.LastServiceResponse.NextMarker' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.GetWAF2AvailableManagedRuleGroupListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ManagedRuleGroups'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.WAFV2.Model.ListAvailableManagedRuleGroupsResponse). Specifying the name of a property of type Amazon.WAFV2.Model.ListAvailableManagedRuleGroupsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.GetWAF2AvailableManagedRuleGroupListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Scope parameter. The -PassThru parameter is deprecated, use -Select '^Scope' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.GetWAF2AvailableManagedRuleGroupListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextMarker as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.WAF2.GetWAF2IPSetCmdlet"> <summary> <note><para> This is the latest version of <b>AWS WAF</b>, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the <a href="https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html">AWS WAF Developer Guide</a>. </para></note><para> Retrieves the specified <a>IPSet</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.GetWAF2IPSetCmdlet.Id"> <summary> <para> <para>A unique identifier for the set. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.GetWAF2IPSetCmdlet.Name"> <summary> <para> <para>The name of the IP set. You cannot change the name of an <code>IPSet</code> after you create it.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.GetWAF2IPSetCmdlet.Scope"> <summary> <para> <para>Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB) or an API Gateway stage. </para><para>To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows: </para><ul><li><para>CLI - Specify the Region when you use the CloudFront scope: <code>--scope=CLOUDFRONT --region=us-east-1</code>. </para></li><li><para>API and SDKs - For all calls, use the Region endpoint us-east-1. </para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.GetWAF2IPSetCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.WAFV2.Model.GetIPSetResponse). Specifying the name of a property of type Amazon.WAFV2.Model.GetIPSetResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.GetWAF2IPSetCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Id parameter. The -PassThru parameter is deprecated, use -Select '^Id' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.WAF2.GetWAF2IPSetListCmdlet"> <summary> <note><para> This is the latest version of <b>AWS WAF</b>, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the <a href="https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html">AWS WAF Developer Guide</a>. </para></note><para> Retrieves an array of <a>IPSetSummary</a> objects for the IP sets that you manage. </para><br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.GetWAF2IPSetListCmdlet.Scope"> <summary> <para> <para>Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB) or an API Gateway stage. </para><para>To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows: </para><ul><li><para>CLI - Specify the Region when you use the CloudFront scope: <code>--scope=CLOUDFRONT --region=us-east-1</code>. </para></li><li><para>API and SDKs - For all calls, use the Region endpoint us-east-1. </para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.GetWAF2IPSetListCmdlet.Limit"> <summary> <para> <para>The maximum number of objects that you want AWS WAF to return for this request. If more objects are available, in the response, AWS WAF provides a <code>NextMarker</code> value that you can use in a subsequent call to get the next batch of objects.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.GetWAF2IPSetListCmdlet.NextMarker"> <summary> <para> <para>When you request a list of objects with a <code>Limit</code> setting, if the number of objects that are still available for retrieval exceeds the limit, AWS WAF returns a <code>NextMarker</code> value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next 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, use '-NextMarker $null' for the first call and '-NextMarker $AWSHistory.LastServiceResponse.NextMarker' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.GetWAF2IPSetListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'IPSets'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.WAFV2.Model.ListIPSetsResponse). Specifying the name of a property of type Amazon.WAFV2.Model.ListIPSetsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.GetWAF2IPSetListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Scope parameter. The -PassThru parameter is deprecated, use -Select '^Scope' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.GetWAF2IPSetListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextMarker as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.WAF2.GetWAF2LoggingConfigurationCmdlet"> <summary> <note><para> This is the latest version of <b>AWS WAF</b>, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the <a href="https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html">AWS WAF Developer Guide</a>. </para></note><para> Returns the <a>LoggingConfiguration</a> for the specified web ACL. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.GetWAF2LoggingConfigurationCmdlet.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="P:Amazon.PowerShell.Cmdlets.WAF2.GetWAF2LoggingConfigurationCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'LoggingConfiguration'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.WAFV2.Model.GetLoggingConfigurationResponse). Specifying the name of a property of type Amazon.WAFV2.Model.GetLoggingConfigurationResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.GetWAF2LoggingConfigurationCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ResourceArn parameter. The -PassThru parameter is deprecated, use -Select '^ResourceArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.WAF2.GetWAF2LoggingConfigurationListCmdlet"> <summary> <note><para> This is the latest version of <b>AWS WAF</b>, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the <a href="https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html">AWS WAF Developer Guide</a>. </para></note><para> Retrieves an array of your <a>LoggingConfiguration</a> objects. </para><br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.GetWAF2LoggingConfigurationListCmdlet.Scope"> <summary> <para> <para>Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB) or an API Gateway stage. </para><para>To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows: </para><ul><li><para>CLI - Specify the Region when you use the CloudFront scope: <code>--scope=CLOUDFRONT --region=us-east-1</code>. </para></li><li><para>API and SDKs - For all calls, use the Region endpoint us-east-1. </para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.GetWAF2LoggingConfigurationListCmdlet.Limit"> <summary> <para> <para>The maximum number of objects that you want AWS WAF to return for this request. If more objects are available, in the response, AWS WAF provides a <code>NextMarker</code> value that you can use in a subsequent call to get the next batch of objects.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.GetWAF2LoggingConfigurationListCmdlet.NextMarker"> <summary> <para> <para>When you request a list of objects with a <code>Limit</code> setting, if the number of objects that are still available for retrieval exceeds the limit, AWS WAF returns a <code>NextMarker</code> value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next 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, use '-NextMarker $null' for the first call and '-NextMarker $AWSHistory.LastServiceResponse.NextMarker' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.GetWAF2LoggingConfigurationListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'LoggingConfigurations'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.WAFV2.Model.ListLoggingConfigurationsResponse). Specifying the name of a property of type Amazon.WAFV2.Model.ListLoggingConfigurationsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.GetWAF2LoggingConfigurationListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Scope parameter. The -PassThru parameter is deprecated, use -Select '^Scope' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.GetWAF2LoggingConfigurationListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextMarker as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.WAF2.GetWAF2ManagedRuleGroupCmdlet"> <summary> <note><para> This is the latest version of <b>AWS WAF</b>, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the <a href="https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html">AWS WAF Developer Guide</a>. </para></note><para> Provides high-level information for a managed rule group, including descriptions of the rules. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.GetWAF2ManagedRuleGroupCmdlet.Name"> <summary> <para> <para>The name of the managed rule group. You use this, along with the vendor name, to identify the rule group.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.GetWAF2ManagedRuleGroupCmdlet.Scope"> <summary> <para> <para>Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB) or an API Gateway stage. </para><para>To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows: </para><ul><li><para>CLI - Specify the Region when you use the CloudFront scope: <code>--scope=CLOUDFRONT --region=us-east-1</code>. </para></li><li><para>API and SDKs - For all calls, use the Region endpoint us-east-1. </para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.GetWAF2ManagedRuleGroupCmdlet.VendorName"> <summary> <para> <para>The name of the managed rule group vendor. You use this, along with the rule group name, to identify the rule group.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.GetWAF2ManagedRuleGroupCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.WAFV2.Model.DescribeManagedRuleGroupResponse). Specifying the name of a property of type Amazon.WAFV2.Model.DescribeManagedRuleGroupResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.GetWAF2ManagedRuleGroupCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Name parameter. The -PassThru parameter is deprecated, use -Select '^Name' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.WAF2.GetWAF2PermissionPolicyCmdlet"> <summary> Returns the IAM policy that is attached to the specified rule group. <para> You must be the owner of the rule group to perform this operation. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.GetWAF2PermissionPolicyCmdlet.ResourceArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the rule group for which you want to get the policy.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.GetWAF2PermissionPolicyCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Policy'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.WAFV2.Model.GetPermissionPolicyResponse). Specifying the name of a property of type Amazon.WAFV2.Model.GetPermissionPolicyResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.GetWAF2PermissionPolicyCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ResourceArn parameter. The -PassThru parameter is deprecated, use -Select '^ResourceArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.WAF2.GetWAF2RateBasedStatementManagedKeyCmdlet"> <summary> <note><para> This is the latest version of <b>AWS WAF</b>, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the <a href="https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html">AWS WAF Developer Guide</a>. </para></note><para> Retrieves the keys that are currently blocked by a rate-based rule. The maximum number of managed keys that can be blocked for a single rate-based rule is 10,000. If more than 10,000 addresses exceed the rate limit, those with the highest rates are blocked. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.GetWAF2RateBasedStatementManagedKeyCmdlet.RuleName"> <summary> <para> <para>The name of the rate-based rule to get the keys for.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.GetWAF2RateBasedStatementManagedKeyCmdlet.Scope"> <summary> <para> <para>Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB) or an API Gateway stage. </para><para>To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows: </para><ul><li><para>CLI - Specify the Region when you use the CloudFront scope: <code>--scope=CLOUDFRONT --region=us-east-1</code>. </para></li><li><para>API and SDKs - For all calls, use the Region endpoint us-east-1. </para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.GetWAF2RateBasedStatementManagedKeyCmdlet.WebACLId"> <summary> <para> <para>The unique identifier for the Web ACL. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.GetWAF2RateBasedStatementManagedKeyCmdlet.WebACLName"> <summary> <para> <para>The name of the Web ACL. You cannot change the name of a Web ACL after you create it.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.GetWAF2RateBasedStatementManagedKeyCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.WAFV2.Model.GetRateBasedStatementManagedKeysResponse). Specifying the name of a property of type Amazon.WAFV2.Model.GetRateBasedStatementManagedKeysResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.GetWAF2RateBasedStatementManagedKeyCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the RuleName parameter. The -PassThru parameter is deprecated, use -Select '^RuleName' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.WAF2.GetWAF2RegexPatternSetCmdlet"> <summary> <note><para> This is the latest version of <b>AWS WAF</b>, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the <a href="https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html">AWS WAF Developer Guide</a>. </para></note><para> Retrieves the specified <a>RegexPatternSet</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.GetWAF2RegexPatternSetCmdlet.Id"> <summary> <para> <para>A unique identifier for the set. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.GetWAF2RegexPatternSetCmdlet.Name"> <summary> <para> <para>The name of the set. You cannot change the name after you create the set.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.GetWAF2RegexPatternSetCmdlet.Scope"> <summary> <para> <para>Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB) or an API Gateway stage. </para><para>To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows: </para><ul><li><para>CLI - Specify the Region when you use the CloudFront scope: <code>--scope=CLOUDFRONT --region=us-east-1</code>. </para></li><li><para>API and SDKs - For all calls, use the Region endpoint us-east-1. </para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.GetWAF2RegexPatternSetCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.WAFV2.Model.GetRegexPatternSetResponse). Specifying the name of a property of type Amazon.WAFV2.Model.GetRegexPatternSetResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.GetWAF2RegexPatternSetCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Id parameter. The -PassThru parameter is deprecated, use -Select '^Id' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.WAF2.GetWAF2RegexPatternSetListCmdlet"> <summary> <note><para> This is the latest version of <b>AWS WAF</b>, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the <a href="https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html">AWS WAF Developer Guide</a>. </para></note><para> Retrieves an array of <a>RegexPatternSetSummary</a> objects for the regex pattern sets that you manage. </para><br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.GetWAF2RegexPatternSetListCmdlet.Scope"> <summary> <para> <para>Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB) or an API Gateway stage. </para><para>To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows: </para><ul><li><para>CLI - Specify the Region when you use the CloudFront scope: <code>--scope=CLOUDFRONT --region=us-east-1</code>. </para></li><li><para>API and SDKs - For all calls, use the Region endpoint us-east-1. </para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.GetWAF2RegexPatternSetListCmdlet.Limit"> <summary> <para> <para>The maximum number of objects that you want AWS WAF to return for this request. If more objects are available, in the response, AWS WAF provides a <code>NextMarker</code> value that you can use in a subsequent call to get the next batch of objects.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.GetWAF2RegexPatternSetListCmdlet.NextMarker"> <summary> <para> <para>When you request a list of objects with a <code>Limit</code> setting, if the number of objects that are still available for retrieval exceeds the limit, AWS WAF returns a <code>NextMarker</code> value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next 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, use '-NextMarker $null' for the first call and '-NextMarker $AWSHistory.LastServiceResponse.NextMarker' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.GetWAF2RegexPatternSetListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'RegexPatternSets'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.WAFV2.Model.ListRegexPatternSetsResponse). Specifying the name of a property of type Amazon.WAFV2.Model.ListRegexPatternSetsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.GetWAF2RegexPatternSetListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Scope parameter. The -PassThru parameter is deprecated, use -Select '^Scope' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.GetWAF2RegexPatternSetListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextMarker as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.WAF2.GetWAF2ResourcesForWebACLListCmdlet"> <summary> <note><para> This is the latest version of <b>AWS WAF</b>, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the <a href="https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html">AWS WAF Developer Guide</a>. </para></note><para> Retrieves an array of the Amazon Resource Names (ARNs) for the regional resources that are associated with the specified web ACL. If you want the list of AWS CloudFront resources, use the AWS CloudFront call <code>ListDistributionsByWebACLId</code>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.GetWAF2ResourcesForWebACLListCmdlet.ResourceType"> <summary> <para> <para>Used for web ACLs that are scoped for regional applications. A regional application can be an Application Load Balancer (ALB) or an API Gateway stage. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.GetWAF2ResourcesForWebACLListCmdlet.WebACLArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the Web ACL.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.GetWAF2ResourcesForWebACLListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ResourceArns'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.WAFV2.Model.ListResourcesForWebACLResponse). Specifying the name of a property of type Amazon.WAFV2.Model.ListResourcesForWebACLResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.GetWAF2ResourcesForWebACLListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the WebACLArn parameter. The -PassThru parameter is deprecated, use -Select '^WebACLArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.WAF2.GetWAF2ResourceTagCmdlet"> <summary> <note><para> This is the latest version of <b>AWS WAF</b>, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the <a href="https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html">AWS WAF Developer Guide</a>. </para></note><para> Retrieves the <a>TagInfoForResource</a> for the specified resource. Tags are key:value pairs that you can use to categorize and manage your resources, for purposes like billing. For example, you might set the tag key to "customer" and the value to the customer name or ID. You can specify one or more tags to add to each AWS resource, up to 50 tags for a resource. </para><para> You can tag the AWS resources that you manage through AWS WAF: web ACLs, rule groups, IP sets, and regex pattern sets. You can't manage or view tags through the AWS WAF console. </para><br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.GetWAF2ResourceTagCmdlet.ResourceARN"> <summary> <para> <para>The Amazon Resource Name (ARN) of the resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.GetWAF2ResourceTagCmdlet.Limit"> <summary> <para> <para>The maximum number of objects that you want AWS WAF to return for this request. If more objects are available, in the response, AWS WAF provides a <code>NextMarker</code> value that you can use in a subsequent call to get the next batch of objects.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.GetWAF2ResourceTagCmdlet.NextMarker"> <summary> <para> <para>When you request a list of objects with a <code>Limit</code> setting, if the number of objects that are still available for retrieval exceeds the limit, AWS WAF returns a <code>NextMarker</code> value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next 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, use '-NextMarker $null' for the first call and '-NextMarker $AWSHistory.LastServiceResponse.NextMarker' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.GetWAF2ResourceTagCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'TagInfoForResource'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.WAFV2.Model.ListTagsForResourceResponse). Specifying the name of a property of type Amazon.WAFV2.Model.ListTagsForResourceResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.GetWAF2ResourceTagCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ResourceARN parameter. The -PassThru parameter is deprecated, use -Select '^ResourceARN' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.GetWAF2ResourceTagCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextMarker as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.WAF2.GetWAF2RuleGroupCmdlet"> <summary> <note><para> This is the latest version of <b>AWS WAF</b>, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the <a href="https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html">AWS WAF Developer Guide</a>. </para></note><para> Retrieves the specified <a>RuleGroup</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.GetWAF2RuleGroupCmdlet.Id"> <summary> <para> <para>A unique identifier for the rule group. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.GetWAF2RuleGroupCmdlet.Name"> <summary> <para> <para>The name of the rule group. You cannot change the name of a rule group after you create it.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.GetWAF2RuleGroupCmdlet.Scope"> <summary> <para> <para>Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB) or an API Gateway stage. </para><para>To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows: </para><ul><li><para>CLI - Specify the Region when you use the CloudFront scope: <code>--scope=CLOUDFRONT --region=us-east-1</code>. </para></li><li><para>API and SDKs - For all calls, use the Region endpoint us-east-1. </para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.GetWAF2RuleGroupCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.WAFV2.Model.GetRuleGroupResponse). Specifying the name of a property of type Amazon.WAFV2.Model.GetRuleGroupResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.GetWAF2RuleGroupCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Id parameter. The -PassThru parameter is deprecated, use -Select '^Id' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.WAF2.GetWAF2RuleGroupListCmdlet"> <summary> <note><para> This is the latest version of <b>AWS WAF</b>, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the <a href="https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html">AWS WAF Developer Guide</a>. </para></note><para> Retrieves an array of <a>RuleGroupSummary</a> objects for the rule groups that you manage. </para><br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.GetWAF2RuleGroupListCmdlet.Scope"> <summary> <para> <para>Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB) or an API Gateway stage. </para><para>To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows: </para><ul><li><para>CLI - Specify the Region when you use the CloudFront scope: <code>--scope=CLOUDFRONT --region=us-east-1</code>. </para></li><li><para>API and SDKs - For all calls, use the Region endpoint us-east-1. </para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.GetWAF2RuleGroupListCmdlet.Limit"> <summary> <para> <para>The maximum number of objects that you want AWS WAF to return for this request. If more objects are available, in the response, AWS WAF provides a <code>NextMarker</code> value that you can use in a subsequent call to get the next batch of objects.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.GetWAF2RuleGroupListCmdlet.NextMarker"> <summary> <para> <para>When you request a list of objects with a <code>Limit</code> setting, if the number of objects that are still available for retrieval exceeds the limit, AWS WAF returns a <code>NextMarker</code> value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next 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, use '-NextMarker $null' for the first call and '-NextMarker $AWSHistory.LastServiceResponse.NextMarker' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.GetWAF2RuleGroupListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'RuleGroups'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.WAFV2.Model.ListRuleGroupsResponse). Specifying the name of a property of type Amazon.WAFV2.Model.ListRuleGroupsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.GetWAF2RuleGroupListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Scope parameter. The -PassThru parameter is deprecated, use -Select '^Scope' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.GetWAF2RuleGroupListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextMarker as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.WAF2.GetWAF2SampledRequestCmdlet"> <summary> <note><para> This is the latest version of <b>AWS WAF</b>, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the <a href="https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html">AWS WAF Developer Guide</a>. </para></note><para> 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><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.WAF2.GetWAF2SampledRequestCmdlet.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. You must specify the times in Coordinated Universal Time (UTC) format. UTC format includes the special designator, <code>Z</code>. For example, <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.WAF2.GetWAF2SampledRequestCmdlet.RuleMetricName"> <summary> <para> <para>The metric name assigned to the <code>Rule</code> or <code>RuleGroup</code> for which you want a sample of requests.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.GetWAF2SampledRequestCmdlet.Scope"> <summary> <para> <para>Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB) or an API Gateway stage. </para><para>To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows: </para><ul><li><para>CLI - Specify the Region when you use the CloudFront scope: <code>--scope=CLOUDFRONT --region=us-east-1</code>. </para></li><li><para>API and SDKs - For all calls, use the Region endpoint us-east-1. </para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.GetWAF2SampledRequestCmdlet.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. You must specify the times in Coordinated Universal Time (UTC) format. UTC format includes the special designator, <code>Z</code>. For example, <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.WAF2.GetWAF2SampledRequestCmdlet.WebAclArn"> <summary> <para> <para>The Amazon resource name (ARN) of the <code>WebACL</code> for which you want a sample of requests.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.GetWAF2SampledRequestCmdlet.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="P:Amazon.PowerShell.Cmdlets.WAF2.GetWAF2SampledRequestCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.WAFV2.Model.GetSampledRequestsResponse). Specifying the name of a property of type Amazon.WAFV2.Model.GetSampledRequestsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.GetWAF2SampledRequestCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the RuleMetricName parameter. The -PassThru parameter is deprecated, use -Select '^RuleMetricName' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.WAF2.GetWAF2WebACLCmdlet"> <summary> <note><para> This is the latest version of <b>AWS WAF</b>, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the <a href="https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html">AWS WAF Developer Guide</a>. </para></note><para> Retrieves the specified <a>WebACL</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.GetWAF2WebACLCmdlet.Id"> <summary> <para> <para>The unique identifier for the Web ACL. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.GetWAF2WebACLCmdlet.Name"> <summary> <para> <para>The name of the Web ACL. You cannot change the name of a Web ACL after you create it.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.GetWAF2WebACLCmdlet.Scope"> <summary> <para> <para>Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB) or an API Gateway stage. </para><para>To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows: </para><ul><li><para>CLI - Specify the Region when you use the CloudFront scope: <code>--scope=CLOUDFRONT --region=us-east-1</code>. </para></li><li><para>API and SDKs - For all calls, use the Region endpoint us-east-1. </para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.GetWAF2WebACLCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.WAFV2.Model.GetWebACLResponse). Specifying the name of a property of type Amazon.WAFV2.Model.GetWebACLResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.GetWAF2WebACLCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Id parameter. The -PassThru parameter is deprecated, use -Select '^Id' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.WAF2.GetWAF2WebACLForResourceCmdlet"> <summary> <note><para> This is the latest version of <b>AWS WAF</b>, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the <a href="https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html">AWS WAF Developer Guide</a>. </para></note><para> Retrieves the <a>WebACL</a> for the specified resource. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.GetWAF2WebACLForResourceCmdlet.ResourceArn"> <summary> <para> <para>The ARN (Amazon Resource Name) of the resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.GetWAF2WebACLForResourceCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'WebACL'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.WAFV2.Model.GetWebACLForResourceResponse). Specifying the name of a property of type Amazon.WAFV2.Model.GetWebACLForResourceResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.GetWAF2WebACLForResourceCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ResourceArn parameter. The -PassThru parameter is deprecated, use -Select '^ResourceArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.WAF2.GetWAF2WebACLsListCmdlet"> <summary> <note><para> This is the latest version of <b>AWS WAF</b>, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the <a href="https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html">AWS WAF Developer Guide</a>. </para></note><para> Retrieves an array of <a>WebACLSummary</a> objects for the web ACLs that you manage. </para><br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.GetWAF2WebACLsListCmdlet.Scope"> <summary> <para> <para>Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB) or an API Gateway stage. </para><para>To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows: </para><ul><li><para>CLI - Specify the Region when you use the CloudFront scope: <code>--scope=CLOUDFRONT --region=us-east-1</code>. </para></li><li><para>API and SDKs - For all calls, use the Region endpoint us-east-1. </para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.GetWAF2WebACLsListCmdlet.Limit"> <summary> <para> <para>The maximum number of objects that you want AWS WAF to return for this request. If more objects are available, in the response, AWS WAF provides a <code>NextMarker</code> value that you can use in a subsequent call to get the next batch of objects.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.GetWAF2WebACLsListCmdlet.NextMarker"> <summary> <para> <para>When you request a list of objects with a <code>Limit</code> setting, if the number of objects that are still available for retrieval exceeds the limit, AWS WAF returns a <code>NextMarker</code> value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next 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, use '-NextMarker $null' for the first call and '-NextMarker $AWSHistory.LastServiceResponse.NextMarker' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.GetWAF2WebACLsListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'WebACLs'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.WAFV2.Model.ListWebACLsResponse). Specifying the name of a property of type Amazon.WAFV2.Model.ListWebACLsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.GetWAF2WebACLsListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Scope parameter. The -PassThru parameter is deprecated, use -Select '^Scope' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.GetWAF2WebACLsListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextMarker as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.WAF2.NewWAF2IPSetCmdlet"> <summary> <note><para> This is the latest version of <b>AWS WAF</b>, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the <a href="https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html">AWS WAF Developer Guide</a>. </para></note><para> Creates an <a>IPSet</a>, which you use to identify web requests that originate from specific IP addresses or ranges of IP addresses. For example, if you're receiving a lot of requests from a ranges of IP addresses, you can configure AWS WAF to block them using an IPSet that lists those IP addresses. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.NewWAF2IPSetCmdlet.Address"> <summary> <para> <para>Contains an array of strings that specify one or more IP addresses or blocks of IP addresses in Classless Inter-Domain Routing (CIDR) notation. AWS WAF supports all address ranges for IP versions IPv4 and IPv6. </para><para>Examples: </para><ul><li><para>To configure AWS WAF to allow, block, or count requests that originated from the IP address 192.0.2.44, specify <code>192.0.2.44/32</code>.</para></li><li><para>To configure AWS WAF to allow, block, or count requests that originated from IP addresses from 192.0.2.0 to 192.0.2.255, specify <code>192.0.2.0/24</code>.</para></li><li><para>To configure AWS WAF to allow, block, or count requests that originated from the IP address 1111:0000:0000:0000:0000:0000:0000:0111, specify <code>1111:0000:0000:0000:0000:0000:0000:0111/128</code>.</para></li><li><para>To configure AWS WAF to allow, block, or count requests that originated from IP addresses 1111:0000:0000:0000:0000:0000:0000:0000 to 1111:0000:0000:0000:ffff:ffff:ffff:ffff, specify <code>1111:0000:0000:0000:0000:0000:0000:0000/64</code>.</para></li></ul><para>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> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.NewWAF2IPSetCmdlet.Description"> <summary> <para> <para>A description of the IP set that helps with identification. You cannot change the description of an IP set after you create it.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.NewWAF2IPSetCmdlet.IPAddressVersion"> <summary> <para> <para>Specify IPV4 or IPV6. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.NewWAF2IPSetCmdlet.Name"> <summary> <para> <para>The name of the IP set. You cannot change the name of an <code>IPSet</code> after you create it.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.NewWAF2IPSetCmdlet.Scope"> <summary> <para> <para>Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB) or an API Gateway stage. </para><para>To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows: </para><ul><li><para>CLI - Specify the Region when you use the CloudFront scope: <code>--scope=CLOUDFRONT --region=us-east-1</code>. </para></li><li><para>API and SDKs - For all calls, use the Region endpoint us-east-1. </para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.NewWAF2IPSetCmdlet.Tag"> <summary> <para> <para>An array of key:value pairs to associate with the resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.NewWAF2IPSetCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Summary'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.WAFV2.Model.CreateIPSetResponse). Specifying the name of a property of type Amazon.WAFV2.Model.CreateIPSetResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.NewWAF2IPSetCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Name parameter. The -PassThru parameter is deprecated, use -Select '^Name' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.NewWAF2IPSetCmdlet.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.WAF2.NewWAF2RegexPatternSetCmdlet"> <summary> <note><para> This is the latest version of <b>AWS WAF</b>, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the <a href="https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html">AWS WAF Developer Guide</a>. </para></note><para> Creates a <a>RegexPatternSet</a>, which you reference in a <a>RegexPatternSetReferenceStatement</a>, to have AWS WAF inspect a web request component for the specified patterns. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.NewWAF2RegexPatternSetCmdlet.Description"> <summary> <para> <para>A description of the set that helps with identification. You cannot change the description of a set after you create it.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.NewWAF2RegexPatternSetCmdlet.Name"> <summary> <para> <para>The name of the set. You cannot change the name after you create the set.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.NewWAF2RegexPatternSetCmdlet.RegularExpressionList"> <summary> <para> <para>Array of regular expression strings. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.NewWAF2RegexPatternSetCmdlet.Scope"> <summary> <para> <para>Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB) or an API Gateway stage. </para><para>To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows: </para><ul><li><para>CLI - Specify the Region when you use the CloudFront scope: <code>--scope=CLOUDFRONT --region=us-east-1</code>. </para></li><li><para>API and SDKs - For all calls, use the Region endpoint us-east-1. </para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.NewWAF2RegexPatternSetCmdlet.Tag"> <summary> <para> <para>An array of key:value pairs to associate with the resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.NewWAF2RegexPatternSetCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Summary'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.WAFV2.Model.CreateRegexPatternSetResponse). Specifying the name of a property of type Amazon.WAFV2.Model.CreateRegexPatternSetResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.NewWAF2RegexPatternSetCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Name parameter. The -PassThru parameter is deprecated, use -Select '^Name' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.NewWAF2RegexPatternSetCmdlet.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.WAF2.NewWAF2RuleGroupCmdlet"> <summary> <note><para> This is the latest version of <b>AWS WAF</b>, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the <a href="https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html">AWS WAF Developer Guide</a>. </para></note><para> Creates a <a>RuleGroup</a> per the specifications provided. </para><para> A rule group defines a collection of rules to inspect and control web requests that you can use in a <a>WebACL</a>. When you create a rule group, you define an immutable capacity limit. If you update a rule group, you must stay within the capacity. This allows others to reuse the rule group with confidence in its capacity requirements. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.NewWAF2RuleGroupCmdlet.Capacity"> <summary> <para> <para>The web ACL capacity units (WCUs) required for this rule group.</para><para>When you create your own rule group, you define this, and you cannot change it after creation. When you add or modify the rules in a rule group, AWS WAF enforces this limit. You can check the capacity for a set of rules using <a>CheckCapacity</a>.</para><para>AWS WAF uses WCUs to calculate and control the operating resources that are used to run your rules, rule groups, and web ACLs. AWS WAF calculates capacity differently for each rule type, to reflect the relative cost of each rule. Simple rules that cost little to run use fewer WCUs than more complex rules that use more processing power. Rule group capacity is fixed at creation, which helps users plan their web ACL WCU usage when they use a rule group. The WCU limit for web ACLs is 1,500. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.NewWAF2RuleGroupCmdlet.VisibilityConfig_CloudWatchMetricsEnabled"> <summary> <para> <para>A boolean indicating whether the associated resource sends metrics to CloudWatch. For the list of available metrics, see <a href="https://docs.aws.amazon.com/waf/latest/developerguide/monitoring-cloudwatch.html#waf-metrics">AWS WAF Metrics</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.NewWAF2RuleGroupCmdlet.Description"> <summary> <para> <para>A description of the rule group that helps with identification. You cannot change the description of a rule group after you create it.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.NewWAF2RuleGroupCmdlet.VisibilityConfig_MetricName"> <summary> <para> <para>A name of the CloudWatch metric. The name can contain only the characters: A-Z, a-z, 0-9, - (hyphen), and _ (underscore). The name can be from one to 128 characters long. It can't contain whitespace or metric names reserved for AWS WAF, for example "All" and "Default_Action." </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.NewWAF2RuleGroupCmdlet.Name"> <summary> <para> <para>The name of the rule group. You cannot change the name of a rule group after you create it.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.NewWAF2RuleGroupCmdlet.Rule"> <summary> <para> <para>The <a>Rule</a> statements used to identify the web requests that you want to allow, block, or count. Each rule includes one top-level statement that AWS WAF uses to identify matching web requests, and parameters that govern how AWS WAF handles them. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.NewWAF2RuleGroupCmdlet.VisibilityConfig_SampledRequestsEnabled"> <summary> <para> <para>A boolean indicating whether AWS WAF should store a sampling of the web requests that match the rules. You can view the sampled requests through the AWS WAF console. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.NewWAF2RuleGroupCmdlet.Scope"> <summary> <para> <para>Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB) or an API Gateway stage. </para><para>To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows: </para><ul><li><para>CLI - Specify the Region when you use the CloudFront scope: <code>--scope=CLOUDFRONT --region=us-east-1</code>. </para></li><li><para>API and SDKs - For all calls, use the Region endpoint us-east-1. </para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.NewWAF2RuleGroupCmdlet.Tag"> <summary> <para> <para>An array of key:value pairs to associate with the resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.NewWAF2RuleGroupCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Summary'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.WAFV2.Model.CreateRuleGroupResponse). Specifying the name of a property of type Amazon.WAFV2.Model.CreateRuleGroupResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.NewWAF2RuleGroupCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Name parameter. The -PassThru parameter is deprecated, use -Select '^Name' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.NewWAF2RuleGroupCmdlet.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.WAF2.NewWAF2WebACLCmdlet"> <summary> <note><para> This is the latest version of <b>AWS WAF</b>, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the <a href="https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html">AWS WAF Developer Guide</a>. </para></note><para> Creates a <a>WebACL</a> per the specifications provided. </para><para> A Web ACL defines a collection of rules to use to inspect and control web requests. Each rule has an action defined (allow, block, or count) for requests that match the statement of the rule. In the Web ACL, you assign a default action to take (allow, block) for any request that does not match any of the rules. The rules in a Web ACL can be a combination of the types <a>Rule</a>, <a>RuleGroup</a>, and managed rule group. You can associate a Web ACL with one or more AWS resources to protect. The resources can be Amazon CloudFront, an Amazon API Gateway API, or an Application Load Balancer. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.NewWAF2WebACLCmdlet.DefaultAction_Allow"> <summary> <para> <para>Specifies that AWS WAF should allow requests by default.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.NewWAF2WebACLCmdlet.DefaultAction_Block"> <summary> <para> <para>Specifies that AWS WAF should block requests by default. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.NewWAF2WebACLCmdlet.VisibilityConfig_CloudWatchMetricsEnabled"> <summary> <para> <para>A boolean indicating whether the associated resource sends metrics to CloudWatch. For the list of available metrics, see <a href="https://docs.aws.amazon.com/waf/latest/developerguide/monitoring-cloudwatch.html#waf-metrics">AWS WAF Metrics</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.NewWAF2WebACLCmdlet.Description"> <summary> <para> <para>A description of the Web ACL that helps with identification. You cannot change the description of a Web ACL after you create it.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.NewWAF2WebACLCmdlet.VisibilityConfig_MetricName"> <summary> <para> <para>A name of the CloudWatch metric. The name can contain only the characters: A-Z, a-z, 0-9, - (hyphen), and _ (underscore). The name can be from one to 128 characters long. It can't contain whitespace or metric names reserved for AWS WAF, for example "All" and "Default_Action." </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.NewWAF2WebACLCmdlet.Name"> <summary> <para> <para>The name of the Web ACL. You cannot change the name of a Web ACL after you create it.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.NewWAF2WebACLCmdlet.Rule"> <summary> <para> <para>The <a>Rule</a> statements used to identify the web requests that you want to allow, block, or count. Each rule includes one top-level statement that AWS WAF uses to identify matching web requests, and parameters that govern how AWS WAF handles them. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.NewWAF2WebACLCmdlet.VisibilityConfig_SampledRequestsEnabled"> <summary> <para> <para>A boolean indicating whether AWS WAF should store a sampling of the web requests that match the rules. You can view the sampled requests through the AWS WAF console. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.NewWAF2WebACLCmdlet.Scope"> <summary> <para> <para>Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB) or an API Gateway stage. </para><para>To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows: </para><ul><li><para>CLI - Specify the Region when you use the CloudFront scope: <code>--scope=CLOUDFRONT --region=us-east-1</code>. </para></li><li><para>API and SDKs - For all calls, use the Region endpoint us-east-1. </para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.NewWAF2WebACLCmdlet.Tag"> <summary> <para> <para>An array of key:value pairs to associate with the resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.NewWAF2WebACLCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Summary'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.WAFV2.Model.CreateWebACLResponse). Specifying the name of a property of type Amazon.WAFV2.Model.CreateWebACLResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.NewWAF2WebACLCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Name parameter. The -PassThru parameter is deprecated, use -Select '^Name' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.NewWAF2WebACLCmdlet.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.WAF2.RemoveWAF2FirewallManagerRuleGroupCmdlet"> <summary> Deletes all rule groups that are managed by AWS Firewall Manager for the specified web ACL. <para> You can only use this if <code>ManagedByFirewallManager</code> is false in the specified <a>WebACL</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.RemoveWAF2FirewallManagerRuleGroupCmdlet.WebACLArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the web ACL.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.RemoveWAF2FirewallManagerRuleGroupCmdlet.WebACLLockToken"> <summary> <para> <para>A token used for optimistic locking. AWS WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. AWS WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a <code>WAFOptimisticLockException</code>. If this happens, perform another get, and use the new token returned by that operation. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.RemoveWAF2FirewallManagerRuleGroupCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'NextWebACLLockToken'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.WAFV2.Model.DeleteFirewallManagerRuleGroupsResponse). Specifying the name of a property of type Amazon.WAFV2.Model.DeleteFirewallManagerRuleGroupsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.RemoveWAF2FirewallManagerRuleGroupCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the WebACLArn parameter. The -PassThru parameter is deprecated, use -Select '^WebACLArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.RemoveWAF2FirewallManagerRuleGroupCmdlet.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.WAF2.RemoveWAF2IPSetCmdlet"> <summary> <note><para> This is the latest version of <b>AWS WAF</b>, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the <a href="https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html">AWS WAF Developer Guide</a>. </para></note><para> Deletes the specified <a>IPSet</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.RemoveWAF2IPSetCmdlet.Id"> <summary> <para> <para>A unique identifier for the set. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.RemoveWAF2IPSetCmdlet.LockToken"> <summary> <para> <para>A token used for optimistic locking. AWS WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. AWS WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a <code>WAFOptimisticLockException</code>. If this happens, perform another get, and use the new token returned by that operation. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.RemoveWAF2IPSetCmdlet.Name"> <summary> <para> <para>The name of the IP set. You cannot change the name of an <code>IPSet</code> after you create it.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.RemoveWAF2IPSetCmdlet.Scope"> <summary> <para> <para>Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB) or an API Gateway stage. </para><para>To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows: </para><ul><li><para>CLI - Specify the Region when you use the CloudFront scope: <code>--scope=CLOUDFRONT --region=us-east-1</code>. </para></li><li><para>API and SDKs - For all calls, use the Region endpoint us-east-1. </para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.RemoveWAF2IPSetCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.WAFV2.Model.DeleteIPSetResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.RemoveWAF2IPSetCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Id parameter. The -PassThru parameter is deprecated, use -Select '^Id' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.RemoveWAF2IPSetCmdlet.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.WAF2.RemoveWAF2LoggingConfigurationCmdlet"> <summary> <note><para> This is the latest version of <b>AWS WAF</b>, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the <a href="https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html">AWS WAF Developer Guide</a>. </para></note><para> Deletes the <a>LoggingConfiguration</a> from the specified web ACL. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.RemoveWAF2LoggingConfigurationCmdlet.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.WAF2.RemoveWAF2LoggingConfigurationCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.WAFV2.Model.DeleteLoggingConfigurationResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.RemoveWAF2LoggingConfigurationCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ResourceArn parameter. The -PassThru parameter is deprecated, use -Select '^ResourceArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.RemoveWAF2LoggingConfigurationCmdlet.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.WAF2.RemoveWAF2PermissionPolicyCmdlet"> <summary> Permanently deletes an IAM policy from the specified rule group. <para> You must be the owner of the rule group to perform this operation. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.RemoveWAF2PermissionPolicyCmdlet.ResourceArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the rule group from which you want to delete the policy.</para><para>You must be the owner of the rule group to perform this operation.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.RemoveWAF2PermissionPolicyCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.WAFV2.Model.DeletePermissionPolicyResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.RemoveWAF2PermissionPolicyCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ResourceArn parameter. The -PassThru parameter is deprecated, use -Select '^ResourceArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.RemoveWAF2PermissionPolicyCmdlet.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.WAF2.RemoveWAF2RegexPatternSetCmdlet"> <summary> <note><para> This is the latest version of <b>AWS WAF</b>, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the <a href="https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html">AWS WAF Developer Guide</a>. </para></note><para> Deletes the specified <a>RegexPatternSet</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.RemoveWAF2RegexPatternSetCmdlet.Id"> <summary> <para> <para>A unique identifier for the set. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.RemoveWAF2RegexPatternSetCmdlet.LockToken"> <summary> <para> <para>A token used for optimistic locking. AWS WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. AWS WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a <code>WAFOptimisticLockException</code>. If this happens, perform another get, and use the new token returned by that operation. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.RemoveWAF2RegexPatternSetCmdlet.Name"> <summary> <para> <para>The name of the set. You cannot change the name after you create the set.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.RemoveWAF2RegexPatternSetCmdlet.Scope"> <summary> <para> <para>Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB) or an API Gateway stage. </para><para>To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows: </para><ul><li><para>CLI - Specify the Region when you use the CloudFront scope: <code>--scope=CLOUDFRONT --region=us-east-1</code>. </para></li><li><para>API and SDKs - For all calls, use the Region endpoint us-east-1. </para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.RemoveWAF2RegexPatternSetCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.WAFV2.Model.DeleteRegexPatternSetResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.RemoveWAF2RegexPatternSetCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Id parameter. The -PassThru parameter is deprecated, use -Select '^Id' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.RemoveWAF2RegexPatternSetCmdlet.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.WAF2.RemoveWAF2ResourceTagCmdlet"> <summary> <note><para> This is the latest version of <b>AWS WAF</b>, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the <a href="https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html">AWS WAF Developer Guide</a>. </para></note><para> Disassociates tags from an AWS resource. Tags are key:value pairs that you can associate with AWS resources. For example, the tag key might be "customer" and the tag value might be "companyA." You can specify one or more tags to add to each container. You can add up to 50 tags to each AWS resource. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.RemoveWAF2ResourceTagCmdlet.ResourceARN"> <summary> <para> <para>The Amazon Resource Name (ARN) of the resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.RemoveWAF2ResourceTagCmdlet.TagKey"> <summary> <para> <para>An array of keys identifying the tags to disassociate from the resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.RemoveWAF2ResourceTagCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.WAFV2.Model.UntagResourceResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.RemoveWAF2ResourceTagCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ResourceARN parameter. The -PassThru parameter is deprecated, use -Select '^ResourceARN' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.RemoveWAF2ResourceTagCmdlet.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.WAF2.RemoveWAF2RuleGroupCmdlet"> <summary> <note><para> This is the latest version of <b>AWS WAF</b>, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the <a href="https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html">AWS WAF Developer Guide</a>. </para></note><para> Deletes the specified <a>RuleGroup</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.RemoveWAF2RuleGroupCmdlet.Id"> <summary> <para> <para>A unique identifier for the rule group. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.RemoveWAF2RuleGroupCmdlet.LockToken"> <summary> <para> <para>A token used for optimistic locking. AWS WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. AWS WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a <code>WAFOptimisticLockException</code>. If this happens, perform another get, and use the new token returned by that operation. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.RemoveWAF2RuleGroupCmdlet.Name"> <summary> <para> <para>The name of the rule group. You cannot change the name of a rule group after you create it.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.RemoveWAF2RuleGroupCmdlet.Scope"> <summary> <para> <para>Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB) or an API Gateway stage. </para><para>To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows: </para><ul><li><para>CLI - Specify the Region when you use the CloudFront scope: <code>--scope=CLOUDFRONT --region=us-east-1</code>. </para></li><li><para>API and SDKs - For all calls, use the Region endpoint us-east-1. </para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.RemoveWAF2RuleGroupCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.WAFV2.Model.DeleteRuleGroupResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.RemoveWAF2RuleGroupCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Id parameter. The -PassThru parameter is deprecated, use -Select '^Id' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.RemoveWAF2RuleGroupCmdlet.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.WAF2.RemoveWAF2WebACLCmdlet"> <summary> <note><para> This is the latest version of <b>AWS WAF</b>, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the <a href="https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html">AWS WAF Developer Guide</a>. </para></note><para> Deletes the specified <a>WebACL</a>. </para><para> You can only use this if <code>ManagedByFirewallManager</code> is false in the specified <a>WebACL</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.RemoveWAF2WebACLCmdlet.Id"> <summary> <para> <para>The unique identifier for the Web ACL. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.RemoveWAF2WebACLCmdlet.LockToken"> <summary> <para> <para>A token used for optimistic locking. AWS WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. AWS WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a <code>WAFOptimisticLockException</code>. If this happens, perform another get, and use the new token returned by that operation. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.RemoveWAF2WebACLCmdlet.Name"> <summary> <para> <para>The name of the Web ACL. You cannot change the name of a Web ACL after you create it.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.RemoveWAF2WebACLCmdlet.Scope"> <summary> <para> <para>Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB) or an API Gateway stage. </para><para>To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows: </para><ul><li><para>CLI - Specify the Region when you use the CloudFront scope: <code>--scope=CLOUDFRONT --region=us-east-1</code>. </para></li><li><para>API and SDKs - For all calls, use the Region endpoint us-east-1. </para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.RemoveWAF2WebACLCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.WAFV2.Model.DeleteWebACLResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.RemoveWAF2WebACLCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Id parameter. The -PassThru parameter is deprecated, use -Select '^Id' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.RemoveWAF2WebACLCmdlet.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.WAF2.RemoveWAF2WebACLFromResourceCmdlet"> <summary> <note><para> This is the latest version of <b>AWS WAF</b>, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the <a href="https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html">AWS WAF Developer Guide</a>. </para></note><para> Disassociates a Web ACL from a regional application resource. A regional application can be an Application Load Balancer (ALB) or an API Gateway stage. </para><para> For AWS CloudFront, don't use this call. Instead, use your CloudFront distribution configuration. To disassociate a Web ACL, provide an empty web ACL ID in the CloudFront call <code>UpdateDistribution</code>. For information, see <a href="https://docs.aws.amazon.com/cloudfront/latest/APIReference/API_UpdateDistribution.html">UpdateDistribution</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.RemoveWAF2WebACLFromResourceCmdlet.ResourceArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the resource to disassociate from the web ACL. </para><para>The ARN must 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.WAF2.RemoveWAF2WebACLFromResourceCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.WAFV2.Model.DisassociateWebACLResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.RemoveWAF2WebACLFromResourceCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ResourceArn parameter. The -PassThru parameter is deprecated, use -Select '^ResourceArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.RemoveWAF2WebACLFromResourceCmdlet.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.WAF2.TestWAF2CapacityCmdlet"> <summary> <note><para> This is the latest version of <b>AWS WAF</b>, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the <a href="https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html">AWS WAF Developer Guide</a>. </para></note><para> Returns the web ACL capacity unit (WCU) requirements for a specified scope and set of rules. You can use this to check the capacity requirements for the rules you want to use in a <a>RuleGroup</a> or <a>WebACL</a>. </para><para> AWS WAF uses WCUs to calculate and control the operating resources that are used to run your rules, rule groups, and web ACLs. AWS WAF calculates capacity differently for each rule type, to reflect the relative cost of each rule. Simple rules that cost little to run use fewer WCUs than more complex rules that use more processing power. Rule group capacity is fixed at creation, which helps users plan their web ACL WCU usage when they use a rule group. The WCU limit for web ACLs is 1,500. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.TestWAF2CapacityCmdlet.Rule"> <summary> <para> <para>An array of <a>Rule</a> that you're configuring to use in a rule group or web ACL. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.TestWAF2CapacityCmdlet.Scope"> <summary> <para> <para>Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB) or an API Gateway stage. </para><para>To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows: </para><ul><li><para>CLI - Specify the Region when you use the CloudFront scope: <code>--scope=CLOUDFRONT --region=us-east-1</code>. </para></li><li><para>API and SDKs - For all calls, use the Region endpoint us-east-1. </para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.TestWAF2CapacityCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Capacity'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.WAFV2.Model.CheckCapacityResponse). Specifying the name of a property of type Amazon.WAFV2.Model.CheckCapacityResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.TestWAF2CapacityCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Scope parameter. The -PassThru parameter is deprecated, use -Select '^Scope' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.WAF2.UpdateWAF2IPSetCmdlet"> <summary> <note><para> This is the latest version of <b>AWS WAF</b>, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the <a href="https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html">AWS WAF Developer Guide</a>. </para></note><para> Updates the specified <a>IPSet</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.UpdateWAF2IPSetCmdlet.Address"> <summary> <para> <para>Contains an array of strings that specify one or more IP addresses or blocks of IP addresses in Classless Inter-Domain Routing (CIDR) notation. AWS WAF supports all address ranges for IP versions IPv4 and IPv6. </para><para>Examples: </para><ul><li><para>To configure AWS WAF to allow, block, or count requests that originated from the IP address 192.0.2.44, specify <code>192.0.2.44/32</code>.</para></li><li><para>To configure AWS WAF to allow, block, or count requests that originated from IP addresses from 192.0.2.0 to 192.0.2.255, specify <code>192.0.2.0/24</code>.</para></li><li><para>To configure AWS WAF to allow, block, or count requests that originated from the IP address 1111:0000:0000:0000:0000:0000:0000:0111, specify <code>1111:0000:0000:0000:0000:0000:0000:0111/128</code>.</para></li><li><para>To configure AWS WAF to allow, block, or count requests that originated from IP addresses 1111:0000:0000:0000:0000:0000:0000:0000 to 1111:0000:0000:0000:ffff:ffff:ffff:ffff, specify <code>1111:0000:0000:0000:0000:0000:0000:0000/64</code>.</para></li></ul><para>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> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.UpdateWAF2IPSetCmdlet.Description"> <summary> <para> <para>A description of the IP set that helps with identification. You cannot change the description of an IP set after you create it.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.UpdateWAF2IPSetCmdlet.Id"> <summary> <para> <para>A unique identifier for the set. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.UpdateWAF2IPSetCmdlet.LockToken"> <summary> <para> <para>A token used for optimistic locking. AWS WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. AWS WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a <code>WAFOptimisticLockException</code>. If this happens, perform another get, and use the new token returned by that operation. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.UpdateWAF2IPSetCmdlet.Name"> <summary> <para> <para>The name of the IP set. You cannot change the name of an <code>IPSet</code> after you create it.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.UpdateWAF2IPSetCmdlet.Scope"> <summary> <para> <para>Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB) or an API Gateway stage. </para><para>To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows: </para><ul><li><para>CLI - Specify the Region when you use the CloudFront scope: <code>--scope=CLOUDFRONT --region=us-east-1</code>. </para></li><li><para>API and SDKs - For all calls, use the Region endpoint us-east-1. </para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.UpdateWAF2IPSetCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'NextLockToken'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.WAFV2.Model.UpdateIPSetResponse). Specifying the name of a property of type Amazon.WAFV2.Model.UpdateIPSetResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.UpdateWAF2IPSetCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Id parameter. The -PassThru parameter is deprecated, use -Select '^Id' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.UpdateWAF2IPSetCmdlet.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.WAF2.UpdateWAF2RegexPatternSetCmdlet"> <summary> <note><para> This is the latest version of <b>AWS WAF</b>, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the <a href="https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html">AWS WAF Developer Guide</a>. </para></note><para> Updates the specified <a>RegexPatternSet</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.UpdateWAF2RegexPatternSetCmdlet.Description"> <summary> <para> <para>A description of the set that helps with identification. You cannot change the description of a set after you create it.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.UpdateWAF2RegexPatternSetCmdlet.Id"> <summary> <para> <para>A unique identifier for the set. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.UpdateWAF2RegexPatternSetCmdlet.LockToken"> <summary> <para> <para>A token used for optimistic locking. AWS WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. AWS WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a <code>WAFOptimisticLockException</code>. If this happens, perform another get, and use the new token returned by that operation. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.UpdateWAF2RegexPatternSetCmdlet.Name"> <summary> <para> <para>The name of the set. You cannot change the name after you create the set.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.UpdateWAF2RegexPatternSetCmdlet.RegularExpressionList"> <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.WAF2.UpdateWAF2RegexPatternSetCmdlet.Scope"> <summary> <para> <para>Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB) or an API Gateway stage. </para><para>To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows: </para><ul><li><para>CLI - Specify the Region when you use the CloudFront scope: <code>--scope=CLOUDFRONT --region=us-east-1</code>. </para></li><li><para>API and SDKs - For all calls, use the Region endpoint us-east-1. </para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.UpdateWAF2RegexPatternSetCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'NextLockToken'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.WAFV2.Model.UpdateRegexPatternSetResponse). Specifying the name of a property of type Amazon.WAFV2.Model.UpdateRegexPatternSetResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.UpdateWAF2RegexPatternSetCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Id parameter. The -PassThru parameter is deprecated, use -Select '^Id' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.UpdateWAF2RegexPatternSetCmdlet.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.WAF2.UpdateWAF2RuleGroupCmdlet"> <summary> <note><para> This is the latest version of <b>AWS WAF</b>, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the <a href="https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html">AWS WAF Developer Guide</a>. </para></note><para> Updates the specified <a>RuleGroup</a>. </para><para> A rule group defines a collection of rules to inspect and control web requests that you can use in a <a>WebACL</a>. When you create a rule group, you define an immutable capacity limit. If you update a rule group, you must stay within the capacity. This allows others to reuse the rule group with confidence in its capacity requirements. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.UpdateWAF2RuleGroupCmdlet.VisibilityConfig_CloudWatchMetricsEnabled"> <summary> <para> <para>A boolean indicating whether the associated resource sends metrics to CloudWatch. For the list of available metrics, see <a href="https://docs.aws.amazon.com/waf/latest/developerguide/monitoring-cloudwatch.html#waf-metrics">AWS WAF Metrics</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.UpdateWAF2RuleGroupCmdlet.Description"> <summary> <para> <para>A description of the rule group that helps with identification. You cannot change the description of a rule group after you create it.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.UpdateWAF2RuleGroupCmdlet.Id"> <summary> <para> <para>A unique identifier for the rule group. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.UpdateWAF2RuleGroupCmdlet.LockToken"> <summary> <para> <para>A token used for optimistic locking. AWS WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. AWS WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a <code>WAFOptimisticLockException</code>. If this happens, perform another get, and use the new token returned by that operation. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.UpdateWAF2RuleGroupCmdlet.VisibilityConfig_MetricName"> <summary> <para> <para>A name of the CloudWatch metric. The name can contain only the characters: A-Z, a-z, 0-9, - (hyphen), and _ (underscore). The name can be from one to 128 characters long. It can't contain whitespace or metric names reserved for AWS WAF, for example "All" and "Default_Action." </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.UpdateWAF2RuleGroupCmdlet.Name"> <summary> <para> <para>The name of the rule group. You cannot change the name of a rule group after you create it.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.UpdateWAF2RuleGroupCmdlet.Rule"> <summary> <para> <para>The <a>Rule</a> statements used to identify the web requests that you want to allow, block, or count. Each rule includes one top-level statement that AWS WAF uses to identify matching web requests, and parameters that govern how AWS WAF handles them. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.UpdateWAF2RuleGroupCmdlet.VisibilityConfig_SampledRequestsEnabled"> <summary> <para> <para>A boolean indicating whether AWS WAF should store a sampling of the web requests that match the rules. You can view the sampled requests through the AWS WAF console. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.UpdateWAF2RuleGroupCmdlet.Scope"> <summary> <para> <para>Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB) or an API Gateway stage. </para><para>To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows: </para><ul><li><para>CLI - Specify the Region when you use the CloudFront scope: <code>--scope=CLOUDFRONT --region=us-east-1</code>. </para></li><li><para>API and SDKs - For all calls, use the Region endpoint us-east-1. </para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.UpdateWAF2RuleGroupCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'NextLockToken'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.WAFV2.Model.UpdateRuleGroupResponse). Specifying the name of a property of type Amazon.WAFV2.Model.UpdateRuleGroupResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.UpdateWAF2RuleGroupCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Id parameter. The -PassThru parameter is deprecated, use -Select '^Id' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.UpdateWAF2RuleGroupCmdlet.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.WAF2.UpdateWAF2WebACLCmdlet"> <summary> <note><para> This is the latest version of <b>AWS WAF</b>, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the <a href="https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html">AWS WAF Developer Guide</a>. </para></note><para> Updates the specified <a>WebACL</a>. </para><para> A Web ACL defines a collection of rules to use to inspect and control web requests. Each rule has an action defined (allow, block, or count) for requests that match the statement of the rule. In the Web ACL, you assign a default action to take (allow, block) for any request that does not match any of the rules. The rules in a Web ACL can be a combination of the types <a>Rule</a>, <a>RuleGroup</a>, and managed rule group. You can associate a Web ACL with one or more AWS resources to protect. The resources can be Amazon CloudFront, an Amazon API Gateway API, or an Application Load Balancer. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.UpdateWAF2WebACLCmdlet.DefaultAction_Allow"> <summary> <para> <para>Specifies that AWS WAF should allow requests by default.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.UpdateWAF2WebACLCmdlet.DefaultAction_Block"> <summary> <para> <para>Specifies that AWS WAF should block requests by default. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.UpdateWAF2WebACLCmdlet.VisibilityConfig_CloudWatchMetricsEnabled"> <summary> <para> <para>A boolean indicating whether the associated resource sends metrics to CloudWatch. For the list of available metrics, see <a href="https://docs.aws.amazon.com/waf/latest/developerguide/monitoring-cloudwatch.html#waf-metrics">AWS WAF Metrics</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.UpdateWAF2WebACLCmdlet.Description"> <summary> <para> <para>A description of the Web ACL that helps with identification. You cannot change the description of a Web ACL after you create it.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.UpdateWAF2WebACLCmdlet.Id"> <summary> <para> <para>The unique identifier for the Web ACL. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.UpdateWAF2WebACLCmdlet.LockToken"> <summary> <para> <para>A token used for optimistic locking. AWS WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. AWS WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a <code>WAFOptimisticLockException</code>. If this happens, perform another get, and use the new token returned by that operation. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.UpdateWAF2WebACLCmdlet.VisibilityConfig_MetricName"> <summary> <para> <para>A name of the CloudWatch metric. The name can contain only the characters: A-Z, a-z, 0-9, - (hyphen), and _ (underscore). The name can be from one to 128 characters long. It can't contain whitespace or metric names reserved for AWS WAF, for example "All" and "Default_Action." </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.UpdateWAF2WebACLCmdlet.Name"> <summary> <para> <para>The name of the Web ACL. You cannot change the name of a Web ACL after you create it.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.UpdateWAF2WebACLCmdlet.Rule"> <summary> <para> <para>The <a>Rule</a> statements used to identify the web requests that you want to allow, block, or count. Each rule includes one top-level statement that AWS WAF uses to identify matching web requests, and parameters that govern how AWS WAF handles them. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.UpdateWAF2WebACLCmdlet.VisibilityConfig_SampledRequestsEnabled"> <summary> <para> <para>A boolean indicating whether AWS WAF should store a sampling of the web requests that match the rules. You can view the sampled requests through the AWS WAF console. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.UpdateWAF2WebACLCmdlet.Scope"> <summary> <para> <para>Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB) or an API Gateway stage. </para><para>To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows: </para><ul><li><para>CLI - Specify the Region when you use the CloudFront scope: <code>--scope=CLOUDFRONT --region=us-east-1</code>. </para></li><li><para>API and SDKs - For all calls, use the Region endpoint us-east-1. </para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.UpdateWAF2WebACLCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'NextLockToken'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.WAFV2.Model.UpdateWebACLResponse). Specifying the name of a property of type Amazon.WAFV2.Model.UpdateWebACLResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.UpdateWAF2WebACLCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Id parameter. The -PassThru parameter is deprecated, use -Select '^Id' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.UpdateWAF2WebACLCmdlet.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.WAF2.WriteWAF2LoggingConfigurationCmdlet"> <summary> <note><para> This is the latest version of <b>AWS WAF</b>, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the <a href="https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html">AWS WAF Developer Guide</a>. </para></note><para> Enables the specified <a>LoggingConfiguration</a>, to start logging from a web ACL, according to the configuration provided. </para><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. If you are capturing logs for Amazon CloudFront, always create the firehose in US East (N. Virginia). </para><para> Give the data firehose a name that starts with the prefix <code>aws-waf-logs-</code>. For example, <code>aws-waf-logs-us-east-2-analytics</code>. </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.WAF2.WriteWAF2LoggingConfigurationCmdlet.LoggingConfiguration_LogDestinationConfig"> <summary> <para> <para>The Amazon Kinesis Data Firehose Amazon Resource Name (ARNs) that you want to associate with the web ACL.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.WriteWAF2LoggingConfigurationCmdlet.LoggingConfiguration_ManagedByFirewallManager"> <summary> <para> <para>Indicates whether the logging configuration was created by AWS Firewall Manager, as part of an AWS WAF policy configuration. If true, only Firewall Manager can modify or delete the configuration. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.WriteWAF2LoggingConfigurationCmdlet.LoggingConfiguration_RedactedField"> <summary> <para> <para>The parts of the request that you want to keep out of the logs. For example, if you redact the <code>HEADER</code> field, the <code>HEADER</code> field in the firehose will be <code>xxx</code>. </para><note><para>You must use one of the following values: <code>URI</code>, <code>QUERY_STRING</code>, <code>HEADER</code>, or <code>METHOD</code>.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.WriteWAF2LoggingConfigurationCmdlet.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.WAF2.WriteWAF2LoggingConfigurationCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'LoggingConfiguration'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.WAFV2.Model.PutLoggingConfigurationResponse). Specifying the name of a property of type Amazon.WAFV2.Model.PutLoggingConfigurationResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.WriteWAF2LoggingConfigurationCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the LoggingConfiguration_ResourceArn parameter. The -PassThru parameter is deprecated, use -Select '^LoggingConfiguration_ResourceArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.WriteWAF2LoggingConfigurationCmdlet.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.WAF2.WriteWAF2PermissionPolicyCmdlet"> <summary> Attaches an IAM policy to the specified resource. Use this to share a rule group across accounts. <para> You must be the owner of the rule group to perform this operation. </para><para> This action 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 ARN in the request must be a valid WAF <a>RuleGroup</a> ARN and the rule group must exist in the same region. </para></li><li><para> The user making the request must be the owner of the rule group. </para></li></ul> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.WriteWAF2PermissionPolicyCmdlet.Policy"> <summary> <para> <para>The policy to attach to the specified rule group. </para><para>The policy specifications must conform to the following:</para><ul><li><para>The policy must be composed using IAM Policy version 2012-10-17 or version 2015-01-01.</para></li><li><para>The policy must include specifications for <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><code>Action</code> must specify <code>wafv2:CreateWebACL</code>, <code>wafv2:UpdateWebACL</code>, and <code>wafv2:PutFirewallManagerRuleGroups</code>. AWS WAF rejects any extra actions or wildcard actions in the policy.</para></li><li><para>The policy must not include a <code>Resource</code> parameter.</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> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.WriteWAF2PermissionPolicyCmdlet.ResourceArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the <a>RuleGroup</a> to which you want to attach the policy.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.WriteWAF2PermissionPolicyCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.WAFV2.Model.PutPermissionPolicyResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.WriteWAF2PermissionPolicyCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ResourceArn parameter. The -PassThru parameter is deprecated, use -Select '^ResourceArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.WriteWAF2PermissionPolicyCmdlet.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> |