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> Associates tags with the specified Amazon Web Services 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 Amazon Web Services resource, up to 50 tags for a resource. <para> You can tag the Amazon Web Services resources that you manage through WAF: web ACLs, rule groups, IP sets, and regex pattern sets. You can't manage or view tags through the 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> Associates a web ACL with a regional application resource, to protect the resource. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance. <para> For Amazon 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> in the <i>Amazon CloudFront Developer Guide</i>. </para><para> When you make changes to web ACLs or web ACL components, like rules and rule groups, WAF propagates the changes everywhere that the web ACL and its components are stored and used. Your changes are applied within seconds, but there might be a brief period of inconsistency when the changes have arrived in some places and not in others. So, for example, if you change a rule action setting, the action might be the old action in one area and the new action in another area. Or if you add an IP address to an IP set used in a blocking rule, the new address might briefly be blocked in one area while still allowed in another. This temporary inconsistency can occur when you first associate a web ACL with an Amazon Web Services resource and when you change a web ACL that is already associated with a resource. Generally, any inconsistencies of this type last only a few seconds. </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:<i>partition</i>: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 REST API: <code>arn:<i>partition</i>:apigateway:<i>region</i>::/restapis/<i>api-id</i>/stages/<i>stage-name</i></code></para></li><li><para>For an AppSync GraphQL API: <code>arn:<i>partition</i>:appsync:<i>region</i>:<i>account-id</i>:apis/<i>GraphQLApiId</i></code></para></li><li><para>For an Amazon Cognito user pool: <code>arn:<i>partition</i>:cognito-idp:<i>region</i>:<i>account-id</i>:userpool/<i>user-pool-id</i></code></para></li><li><para>For an App Runner service: <code>arn:<i>partition</i>:apprunner:<i>region</i>:<i>account-id</i>:service/<i>apprunner-service-name</i>/<i>apprunner-service-id</i></code></para></li><li><para>For an Amazon Web Services Verified Access instance: <code>arn:<i>partition</i>:ec2:<i>region</i>:<i>account-id</i>:verified-access-instance/<i>instance-id</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.GetWAF2AllManagedProductCmdlet"> <summary> Provides high-level information for the Amazon Web Services Managed Rules rule groups and Amazon Web Services Marketplace managed rule groups. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.GetWAF2AllManagedProductCmdlet.Scope"> <summary> <para> <para>Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance. </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.GetWAF2AllManagedProductCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ManagedProducts'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.WAFV2.Model.DescribeAllManagedProductsResponse). Specifying the name of a property of type Amazon.WAFV2.Model.DescribeAllManagedProductsResponse 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="T:Amazon.PowerShell.Cmdlets.WAF2.GetWAF2APIKeyListCmdlet"> <summary> Retrieves a list of the API keys that you've defined for the specified scope. <para> API keys are required for the integration of the CAPTCHA API in your JavaScript client applications. The API lets you customize the placement and characteristics of the CAPTCHA puzzle for your end users. For more information about the CAPTCHA JavaScript integration, see <a href="https://docs.aws.amazon.com/waf/latest/developerguide/waf-application-integration.html">WAF client application integration</a> in the <i>WAF Developer Guide</i>. </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.GetWAF2APIKeyListCmdlet.Scope"> <summary> <para> <para>Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance. </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.GetWAF2APIKeyListCmdlet.Limit"> <summary> <para> <para>The maximum number of objects that you want WAF to return for this request. If more objects are available, in the response, 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.GetWAF2APIKeyListCmdlet.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, 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.GetWAF2APIKeyListCmdlet.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.ListAPIKeysResponse). Specifying the name of a property of type Amazon.WAFV2.Model.ListAPIKeysResponse 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.GetWAF2APIKeyListCmdlet.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.GetWAF2APIKeyListCmdlet.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.GetWAF2AvailableManagedRuleGroupListCmdlet"> <summary> Retrieves an array of managed rule groups that are available for you to use. This list includes all Amazon Web Services Managed Rules rule groups and all of the Amazon Web Services Marketplace managed rule groups that you're subscribed to.<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 Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance. </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 WAF to return for this request. If more objects are available, in the response, 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, 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.GetWAF2AvailableManagedRuleGroupVersionListCmdlet"> <summary> Returns a list of the available versions for the specified managed rule group.<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.GetWAF2AvailableManagedRuleGroupVersionListCmdlet.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.GetWAF2AvailableManagedRuleGroupVersionListCmdlet.Scope"> <summary> <para> <para>Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance. </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.GetWAF2AvailableManagedRuleGroupVersionListCmdlet.VendorName"> <summary> <para> <para>The name of the managed rule group vendor. You use this, along with the rule group name, to identify a rule group.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.GetWAF2AvailableManagedRuleGroupVersionListCmdlet.Limit"> <summary> <para> <para>The maximum number of objects that you want WAF to return for this request. If more objects are available, in the response, 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.GetWAF2AvailableManagedRuleGroupVersionListCmdlet.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, 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.GetWAF2AvailableManagedRuleGroupVersionListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Versions'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.WAFV2.Model.ListAvailableManagedRuleGroupVersionsResponse). Specifying the name of a property of type Amazon.WAFV2.Model.ListAvailableManagedRuleGroupVersionsResponse 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.GetWAF2AvailableManagedRuleGroupVersionListCmdlet.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.GetWAF2AvailableManagedRuleGroupVersionListCmdlet.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.GetWAF2DecryptedAPIKeyCmdlet"> <summary> Returns your API key in decrypted form. Use this to check the token domains that you have defined for the key. <para> API keys are required for the integration of the CAPTCHA API in your JavaScript client applications. The API lets you customize the placement and characteristics of the CAPTCHA puzzle for your end users. For more information about the CAPTCHA JavaScript integration, see <a href="https://docs.aws.amazon.com/waf/latest/developerguide/waf-application-integration.html">WAF client application integration</a> in the <i>WAF Developer Guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.GetWAF2DecryptedAPIKeyCmdlet.APIKey"> <summary> <para> <para>The encrypted API key. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.GetWAF2DecryptedAPIKeyCmdlet.Scope"> <summary> <para> <para>Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance. </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.GetWAF2DecryptedAPIKeyCmdlet.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.GetDecryptedAPIKeyResponse). Specifying the name of a property of type Amazon.WAFV2.Model.GetDecryptedAPIKeyResponse 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.GetWAF2DecryptedAPIKeyCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the APIKey parameter. The -PassThru parameter is deprecated, use -Select '^APIKey' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.WAF2.GetWAF2IPSetCmdlet"> <summary> Retrieves the specified <a>IPSet</a>. </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 Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance. </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> Retrieves an array of <a>IPSetSummary</a> objects for the IP sets that you manage.<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 Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance. </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 WAF to return for this request. If more objects are available, in the response, 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, 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> Returns the <a>LoggingConfiguration</a> for the specified web ACL. </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> Retrieves an array of your <a>LoggingConfiguration</a> objects.<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 Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance. </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 WAF to return for this request. If more objects are available, in the response, 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, 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.GetWAF2ManagedProductsByVendorCmdlet"> <summary> Provides high-level information for the managed rule groups owned by a specific vendor. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.GetWAF2ManagedProductsByVendorCmdlet.Scope"> <summary> <para> <para>Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance. </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.GetWAF2ManagedProductsByVendorCmdlet.VendorName"> <summary> <para> <para>The name of the managed rule group vendor. You use this, along with the rule group name, to identify a rule group.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.GetWAF2ManagedProductsByVendorCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ManagedProducts'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.WAFV2.Model.DescribeManagedProductsByVendorResponse). Specifying the name of a property of type Amazon.WAFV2.Model.DescribeManagedProductsByVendorResponse 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="T:Amazon.PowerShell.Cmdlets.WAF2.GetWAF2ManagedRuleGroupCmdlet"> <summary> Provides high-level information for a managed rule group, including descriptions of the rules. </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 Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance. </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 a rule group.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.GetWAF2ManagedRuleGroupCmdlet.VersionName"> <summary> <para> <para>The version of the rule group. You can only use a version that is not scheduled for expiration. If you don't provide this, WAF uses the vendor's default version. </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.GetWAF2ManagedRuleSetCmdlet"> <summary> Retrieves the specified managed rule set. <note><para> This is intended for use only by vendors of managed rule sets. Vendors are Amazon Web Services and Amazon Web Services Marketplace sellers. </para><para> Vendors, you can use the managed rule set APIs to provide controlled rollout of your versioned managed rule group offerings for your customers. The APIs are <code>ListManagedRuleSets</code>, <code>GetManagedRuleSet</code>, <code>PutManagedRuleSetVersions</code>, and <code>UpdateManagedRuleSetVersionExpiryDate</code>. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.GetWAF2ManagedRuleSetCmdlet.Id"> <summary> <para> <para>A unique identifier for the managed rule set. The ID is returned in the responses to commands like <code>list</code>. You provide it to operations like <code>get</code> and <code>update</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.GetWAF2ManagedRuleSetCmdlet.Name"> <summary> <para> <para>The name of the managed rule set. You use this, along with the rule set ID, to identify the rule set.</para><para>This name is assigned to the corresponding managed rule group, which your customers can access and use. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.GetWAF2ManagedRuleSetCmdlet.Scope"> <summary> <para> <para>Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance. </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.GetWAF2ManagedRuleSetCmdlet.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.GetManagedRuleSetResponse). Specifying the name of a property of type Amazon.WAFV2.Model.GetManagedRuleSetResponse 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.GetWAF2ManagedRuleSetCmdlet.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.GetWAF2ManagedRuleSetListCmdlet"> <summary> Retrieves the managed rule sets that you own. <note><para> This is intended for use only by vendors of managed rule sets. Vendors are Amazon Web Services and Amazon Web Services Marketplace sellers. </para><para> Vendors, you can use the managed rule set APIs to provide controlled rollout of your versioned managed rule group offerings for your customers. The APIs are <code>ListManagedRuleSets</code>, <code>GetManagedRuleSet</code>, <code>PutManagedRuleSetVersions</code>, and <code>UpdateManagedRuleSetVersionExpiryDate</code>. </para></note><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.GetWAF2ManagedRuleSetListCmdlet.Scope"> <summary> <para> <para>Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance. </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.GetWAF2ManagedRuleSetListCmdlet.Limit"> <summary> <para> <para>The maximum number of objects that you want WAF to return for this request. If more objects are available, in the response, 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.GetWAF2ManagedRuleSetListCmdlet.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, 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.GetWAF2ManagedRuleSetListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ManagedRuleSets'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.WAFV2.Model.ListManagedRuleSetsResponse). Specifying the name of a property of type Amazon.WAFV2.Model.ListManagedRuleSetsResponse 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.GetWAF2ManagedRuleSetListCmdlet.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.GetWAF2ManagedRuleSetListCmdlet.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.GetWAF2MobileSdkReleaseCmdlet"> <summary> Retrieves information for the specified mobile SDK release, including release notes and tags. <para> The mobile SDK is not generally available. Customers who have access to the mobile SDK can use it to establish and manage WAF tokens for use in HTTP(S) requests from a mobile device to WAF. For more information, see <a href="https://docs.aws.amazon.com/waf/latest/developerguide/waf-application-integration.html">WAF client application integration</a> in the <i>WAF Developer Guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.GetWAF2MobileSdkReleaseCmdlet.Platform"> <summary> <para> <para>The device platform.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.GetWAF2MobileSdkReleaseCmdlet.ReleaseVersion"> <summary> <para> <para>The release version. For the latest available version, specify <code>LATEST</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.GetWAF2MobileSdkReleaseCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'MobileSdkRelease'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.WAFV2.Model.GetMobileSdkReleaseResponse). Specifying the name of a property of type Amazon.WAFV2.Model.GetMobileSdkReleaseResponse 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="T:Amazon.PowerShell.Cmdlets.WAF2.GetWAF2MobileSdkReleaseListCmdlet"> <summary> Retrieves a list of the available releases for the mobile SDK and the specified device platform. <para> The mobile SDK is not generally available. Customers who have access to the mobile SDK can use it to establish and manage WAF tokens for use in HTTP(S) requests from a mobile device to WAF. For more information, see <a href="https://docs.aws.amazon.com/waf/latest/developerguide/waf-application-integration.html">WAF client application integration</a> in the <i>WAF Developer Guide</i>. </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.GetWAF2MobileSdkReleaseListCmdlet.Platform"> <summary> <para> <para>The device platform to retrieve the list for.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.GetWAF2MobileSdkReleaseListCmdlet.Limit"> <summary> <para> <para>The maximum number of objects that you want WAF to return for this request. If more objects are available, in the response, 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.GetWAF2MobileSdkReleaseListCmdlet.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, 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.GetWAF2MobileSdkReleaseListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ReleaseSummaries'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.WAFV2.Model.ListMobileSdkReleasesResponse). Specifying the name of a property of type Amazon.WAFV2.Model.ListMobileSdkReleasesResponse 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.GetWAF2MobileSdkReleaseListCmdlet.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.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> Retrieves the IP addresses that are currently blocked by a rate-based rule instance. This is only available for rate-based rules that aggregate solely on the IP address or on the forwarded IP address. <para> The maximum number of addresses that can be blocked for a single rate-based rule instance is 10,000. If more than 10,000 addresses exceed the rate limit, those with the highest rates are blocked. </para><para> For a rate-based rule that you've defined inside a rule group, provide the name of the rule group reference statement in your request, in addition to the rate-based rule name and the web ACL name. </para><para> WAF monitors web requests and manages keys independently for each unique combination of web ACL, optional rule group, and rate-based rule. For example, if you define a rate-based rule inside a rule group, and then use the rule group in a web ACL, WAF monitors web requests and manages keys for that web ACL, rule group reference statement, and rate-based rule instance. If you use the same rule group in a second web ACL, WAF monitors web requests and manages keys for this second usage completely independent of your first. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.GetWAF2RateBasedStatementManagedKeyCmdlet.RuleGroupRuleName"> <summary> <para> <para>The name of the rule group reference statement in your web ACL. This is required only when you have the rate-based rule nested inside a rule group. </para> </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. If you have the rule defined inside a rule group that you're using in your web ACL, also provide the name of the rule group reference statement in the request parameter <code>RuleGroupRuleName</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.GetWAF2RateBasedStatementManagedKeyCmdlet.Scope"> <summary> <para> <para>Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance. </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> Retrieves the specified <a>RegexPatternSet</a>. </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 Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance. </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> Retrieves an array of <a>RegexPatternSetSummary</a> objects for the regex pattern sets that you manage.<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 Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance. </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 WAF to return for this request. If more objects are available, in the response, 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, 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> 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 Amazon CloudFront resources, use the CloudFront call <code>ListDistributionsByWebACLId</code>. </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), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance. </para><note><para>If you don't provide a resource type, the call uses the resource type <code>APPLICATION_LOAD_BALANCER</code>. </para></note><para>Default: <code>APPLICATION_LOAD_BALANCER</code></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> 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 Amazon Web Services resource, up to 50 tags for a resource. <para> You can tag the Amazon Web Services resources that you manage through WAF: web ACLs, rule groups, IP sets, and regex pattern sets. You can't manage or view tags through the 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 WAF to return for this request. If more objects are available, in the response, 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, 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> Retrieves the specified <a>RuleGroup</a>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.GetWAF2RuleGroupCmdlet.ARN"> <summary> <para> <para>The Amazon Resource Name (ARN) of the entity.</para> </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 Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance. </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> Retrieves an array of <a>RuleGroupSummary</a> objects for the rule groups that you manage.<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 Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance. </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 WAF to return for this request. If more objects are available, in the response, 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, 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> Gets detailed information about a specified number of requests--a sample--that WAF randomly selects from among the first 5,000 requests that your Amazon Web Services resource received during a time range that you choose. You can specify a sample size of up to 500 requests, and you can specify any time range in the previous three hours. <para><code>GetSampledRequests</code> returns a time range, which is usually the time range that you specified. However, if your resource (such as a CloudFront distribution) received 5,000 requests before the specified time range elapsed, <code>GetSampledRequests</code> returns an updated time range. This new time range indicates the actual period during which 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 Amazon Web Services 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> dimension 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 Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance. </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 Amazon Web Services 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 WAF to return from among the first 5,000 requests that your Amazon Web Services 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> Retrieves the specified <a>WebACL</a>. </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 Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance. </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> Retrieves the <a>WebACL</a> for the specified resource. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.GetWAF2WebACLForResourceCmdlet.ResourceArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the resource whose web ACL you want to retrieve. </para><para>The ARN must be in one of the following formats:</para><ul><li><para>For an Application Load Balancer: <code>arn:<i>partition</i>: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 REST API: <code>arn:<i>partition</i>:apigateway:<i>region</i>::/restapis/<i>api-id</i>/stages/<i>stage-name</i></code></para></li><li><para>For an AppSync GraphQL API: <code>arn:<i>partition</i>:appsync:<i>region</i>:<i>account-id</i>:apis/<i>GraphQLApiId</i></code></para></li><li><para>For an Amazon Cognito user pool: <code>arn:<i>partition</i>:cognito-idp:<i>region</i>:<i>account-id</i>:userpool/<i>user-pool-id</i></code></para></li><li><para>For an App Runner service: <code>arn:<i>partition</i>:apprunner:<i>region</i>:<i>account-id</i>:service/<i>apprunner-service-name</i>/<i>apprunner-service-id</i></code></para></li><li><para>For an Amazon Web Services Verified Access instance: <code>arn:<i>partition</i>:ec2:<i>region</i>:<i>account-id</i>:verified-access-instance/<i>instance-id</i></code></para></li></ul> </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> Retrieves an array of <a>WebACLSummary</a> objects for the web ACLs that you manage.<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 Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance. </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 WAF to return for this request. If more objects are available, in the response, 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, 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.NewWAF2APIKeyCmdlet"> <summary> Creates an API key that contains a set of token domains. <para> API keys are required for the integration of the CAPTCHA API in your JavaScript client applications. The API lets you customize the placement and characteristics of the CAPTCHA puzzle for your end users. For more information about the CAPTCHA JavaScript integration, see <a href="https://docs.aws.amazon.com/waf/latest/developerguide/waf-application-integration.html">WAF client application integration</a> in the <i>WAF Developer Guide</i>. </para><para> You can use a single key for up to 5 domains. After you generate a key, you can copy it for use in your JavaScript integration. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.NewWAF2APIKeyCmdlet.Scope"> <summary> <para> <para>Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance. </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.NewWAF2APIKeyCmdlet.TokenDomain"> <summary> <para> <para>The client application domains that you want to use this API key for. </para><para>Example JSON: <code>"TokenDomains": ["abc.com", "store.abc.com"]</code></para><para>Public suffixes aren't allowed. For example, you can't use <code>usa.gov</code> or <code>co.uk</code> as token domains.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.NewWAF2APIKeyCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'APIKey'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.WAFV2.Model.CreateAPIKeyResponse). Specifying the name of a property of type Amazon.WAFV2.Model.CreateAPIKeyResponse 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.NewWAF2APIKeyCmdlet.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.NewWAF2APIKeyCmdlet.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.NewWAF2IPSetCmdlet"> <summary> 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 WAF to block them using an IPSet that lists those IP addresses. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.NewWAF2IPSetCmdlet.Address"> <summary> <para> <para>Contains an array of strings that specifies zero or more IP addresses or blocks of IP addresses. All addresses must be specified using Classless Inter-Domain Routing (CIDR) notation. WAF supports all IPv4 and IPv6 CIDR ranges except for <code>/0</code>. </para><para>Example address strings: </para><ul><li><para>To configure 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 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 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 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>Example JSON <code>Addresses</code> specifications: </para><ul><li><para>Empty array: <code>"Addresses": []</code></para></li><li><para>Array with one address: <code>"Addresses": ["192.0.2.44/32"]</code></para></li><li><para>Array with three addresses: <code>"Addresses": ["192.0.2.44/32", "192.0.2.0/24", "192.0.0.0/16"]</code></para></li><li><para>INVALID specification: <code>"Addresses": [""]</code> INVALID </para></li></ul> </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. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.NewWAF2IPSetCmdlet.IPAddressVersion"> <summary> <para> <para>The version of the IP addresses, either <code>IPV4</code> or <code>IPV6</code>. </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 Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance. </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.NewWAF2MobileSdkReleaseUrlCmdlet"> <summary> Generates a presigned download URL for the specified release of the mobile SDK. <para> The mobile SDK is not generally available. Customers who have access to the mobile SDK can use it to establish and manage WAF tokens for use in HTTP(S) requests from a mobile device to WAF. For more information, see <a href="https://docs.aws.amazon.com/waf/latest/developerguide/waf-application-integration.html">WAF client application integration</a> in the <i>WAF Developer Guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.NewWAF2MobileSdkReleaseUrlCmdlet.Platform"> <summary> <para> <para>The device platform.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.NewWAF2MobileSdkReleaseUrlCmdlet.ReleaseVersion"> <summary> <para> <para>The release version. For the latest available version, specify <code>LATEST</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.NewWAF2MobileSdkReleaseUrlCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Url'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.WAFV2.Model.GenerateMobileSdkReleaseUrlResponse). Specifying the name of a property of type Amazon.WAFV2.Model.GenerateMobileSdkReleaseUrlResponse 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.NewWAF2MobileSdkReleaseUrlCmdlet.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> Creates a <a>RegexPatternSet</a>, which you reference in a <a>RegexPatternSetReferenceStatement</a>, to have WAF inspect a web request component for the specified patterns. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.NewWAF2RegexPatternSetCmdlet.Description"> <summary> <para> <para>A description of the set that helps with identification. </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 Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance. </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> Creates a <a>RuleGroup</a> per the specifications provided. <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, WAF enforces this limit. You can check the capacity for a set of rules using <a>CheckCapacity</a>.</para><para>WAF uses WCUs to calculate and control the operating resources that are used to run your rules, rule groups, and web ACLs. 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. For more information, see <a href="https://docs.aws.amazon.com/waf/latest/developerguide/aws-waf-capacity-units.html">WAF web ACL capacity units (WCU)</a> in the <i>WAF Developer Guide</i>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.NewWAF2RuleGroupCmdlet.VisibilityConfig_CloudWatchMetricsEnabled"> <summary> <para> <para>Indicates whether the associated resource sends metrics to Amazon CloudWatch. For the list of available metrics, see <a href="https://docs.aws.amazon.com/waf/latest/developerguide/monitoring-cloudwatch.html#waf-metrics">WAF Metrics</a> in the <i>WAF Developer Guide</i>.</para><para>For web ACLs, the metrics are for web requests that have the web ACL default action applied. WAF applies the default action to web requests that pass the inspection of all rules in the web ACL without being either allowed or blocked. For more information, see <a href="https://docs.aws.amazon.com/waf/latest/developerguide/web-acl-default-action.html">The web ACL default action</a> in the <i>WAF Developer Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.NewWAF2RuleGroupCmdlet.CustomResponseBody"> <summary> <para> <para>A map of custom response keys and content bodies. When you create a rule with a block action, you can send a custom response to the web request. You define these for the rule group, and then use them in the rules that you define in the rule group. </para><para>For information about customizing web requests and responses, see <a href="https://docs.aws.amazon.com/waf/latest/developerguide/waf-custom-request-response.html">Customizing web requests and responses in WAF</a> in the <i>WAF Developer Guide</i>. </para><para>For information about the limits on count and size for custom request and response settings, see <a href="https://docs.aws.amazon.com/waf/latest/developerguide/limits.html">WAF quotas</a> in the <i>WAF Developer Guide</i>. </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. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.NewWAF2RuleGroupCmdlet.VisibilityConfig_MetricName"> <summary> <para> <para>A name of the Amazon CloudWatch metric dimension. 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 that are reserved for WAF, for example <code>All</code> and <code>Default_Action</code>. </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 WAF uses to identify matching web requests, and parameters that govern how WAF handles them. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.NewWAF2RuleGroupCmdlet.VisibilityConfig_SampledRequestsEnabled"> <summary> <para> <para>Indicates whether WAF should store a sampling of the web requests that match the rules. You can view the sampled requests through the WAF console. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.NewWAF2RuleGroupCmdlet.Scope"> <summary> <para> <para>Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance. </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> Creates a <a>WebACL</a> per the specifications provided. <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 Amazon Web Services resources to protect. The resources can be an Amazon CloudFront distribution, an Amazon API Gateway REST API, an Application Load Balancer, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.NewWAF2WebACLCmdlet.DefaultAction_Allow"> <summary> <para> <para>Specifies that 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 WAF should block requests by default. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.NewWAF2WebACLCmdlet.VisibilityConfig_CloudWatchMetricsEnabled"> <summary> <para> <para>Indicates whether the associated resource sends metrics to Amazon CloudWatch. For the list of available metrics, see <a href="https://docs.aws.amazon.com/waf/latest/developerguide/monitoring-cloudwatch.html#waf-metrics">WAF Metrics</a> in the <i>WAF Developer Guide</i>.</para><para>For web ACLs, the metrics are for web requests that have the web ACL default action applied. WAF applies the default action to web requests that pass the inspection of all rules in the web ACL without being either allowed or blocked. For more information, see <a href="https://docs.aws.amazon.com/waf/latest/developerguide/web-acl-default-action.html">The web ACL default action</a> in the <i>WAF Developer Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.NewWAF2WebACLCmdlet.CustomResponseBody"> <summary> <para> <para>A map of custom response keys and content bodies. When you create a rule with a block action, you can send a custom response to the web request. You define these for the web ACL, and then use them in the rules and default actions that you define in the web ACL. </para><para>For information about customizing web requests and responses, see <a href="https://docs.aws.amazon.com/waf/latest/developerguide/waf-custom-request-response.html">Customizing web requests and responses in WAF</a> in the <i>WAF Developer Guide</i>. </para><para>For information about the limits on count and size for custom request and response settings, see <a href="https://docs.aws.amazon.com/waf/latest/developerguide/limits.html">WAF quotas</a> in the <i>WAF Developer Guide</i>. </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. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.NewWAF2WebACLCmdlet.CaptchaConfig_ImmunityTimeProperty_ImmunityTime"> <summary> <para> <para>The amount of time, in seconds, that a <code>CAPTCHA</code> or challenge timestamp is considered valid by WAF. The default setting is 300. </para><para>For the Challenge action, the minimum setting is 300. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.NewWAF2WebACLCmdlet.ChallengeConfig_ImmunityTimeProperty_ImmunityTime"> <summary> <para> <para>The amount of time, in seconds, that a <code>CAPTCHA</code> or challenge timestamp is considered valid by WAF. The default setting is 300. </para><para>For the Challenge action, the minimum setting is 300. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.NewWAF2WebACLCmdlet.VisibilityConfig_MetricName"> <summary> <para> <para>A name of the Amazon CloudWatch metric dimension. 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 that are reserved for WAF, for example <code>All</code> and <code>Default_Action</code>. </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.AssociationConfig_RequestBody"> <summary> <para> <para>Customizes the maximum size of the request body that your protected CloudFront distributions forward to WAF for inspection. The default size is 16 KB (16,384 kilobytes). </para><note><para>You are charged additional fees when your protected resources forward body sizes that are larger than the default. For more information, see <a href="http://aws.amazon.com/waf/pricing/">WAF Pricing</a>.</para></note> </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 WAF uses to identify matching web requests, and parameters that govern how WAF handles them. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.NewWAF2WebACLCmdlet.VisibilityConfig_SampledRequestsEnabled"> <summary> <para> <para>Indicates whether WAF should store a sampling of the web requests that match the rules. You can view the sampled requests through the WAF console. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.NewWAF2WebACLCmdlet.Scope"> <summary> <para> <para>Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance. </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.TokenDomain"> <summary> <para> <para>Specifies the domains that WAF should accept in a web request token. This enables the use of tokens across multiple protected websites. When WAF provides a token, it uses the domain of the Amazon Web Services resource that the web ACL is protecting. If you don't specify a list of token domains, WAF accepts tokens only for the domain of the protected resource. With a token domain list, WAF accepts the resource's host domain plus all domains in the token domain list, including their prefixed subdomains.</para><para>Example JSON: <code>"TokenDomains": { "mywebsite.com", "myotherwebsite.com" }</code></para><para>Public suffixes aren't allowed. For example, you can't use <code>usa.gov</code> or <code>co.uk</code> as token domains.</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 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. WAF returns a token to your <code>get</code> and <code>list</code> 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 <code>update</code> and <code>delete</code>. 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 <code>get</code>, 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> Deletes the specified <a>IPSet</a>. </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. WAF returns a token to your <code>get</code> and <code>list</code> 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 <code>update</code> and <code>delete</code>. 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 <code>get</code>, 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 Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance. </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> Deletes the <a>LoggingConfiguration</a> from the specified web ACL. </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> Deletes the specified <a>RegexPatternSet</a>. </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. WAF returns a token to your <code>get</code> and <code>list</code> 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 <code>update</code> and <code>delete</code>. 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 <code>get</code>, 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 Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance. </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> Disassociates tags from an Amazon Web Services resource. Tags are key:value pairs that you can associate with Amazon Web Services 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 Amazon Web Services resource. </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> Deletes the specified <a>RuleGroup</a>. </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. WAF returns a token to your <code>get</code> and <code>list</code> 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 <code>update</code> and <code>delete</code>. 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 <code>get</code>, 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 Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance. </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> Deletes the specified <a>WebACL</a>. <para> You can only use this if <code>ManagedByFirewallManager</code> is false in the specified <a>WebACL</a>. </para><note><para> Before deleting any web ACL, first disassociate it from all resources. </para><ul><li><para> To retrieve a list of the resources that are associated with a web ACL, use the following calls: </para><ul><li><para> For regional resources, call <a>ListResourcesForWebACL</a>. </para></li><li><para> For Amazon CloudFront distributions, use the CloudFront call <code>ListDistributionsByWebACLId</code>. For information, see <a href="https://docs.aws.amazon.com/cloudfront/latest/APIReference/API_ListDistributionsByWebACLId.html">ListDistributionsByWebACLId</a> in the <i>Amazon CloudFront API Reference</i>. </para></li></ul></li><li><para> To disassociate a resource from a web ACL, use the following calls: </para><ul><li><para> For regional resources, call <a>DisassociateWebACL</a>. </para></li><li><para> For Amazon CloudFront distributions, 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> in the <i>Amazon CloudFront API Reference</i>. </para></li></ul></li></ul></note> </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. WAF returns a token to your <code>get</code> and <code>list</code> 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 <code>update</code> and <code>delete</code>. 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 <code>get</code>, 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 Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance. </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> Disassociates the specified regional application resource from any existing web ACL association. A resource can have at most one web ACL association. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance. <para> For Amazon 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> in the <i>Amazon CloudFront API Reference</i>. </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:<i>partition</i>: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 REST API: <code>arn:<i>partition</i>:apigateway:<i>region</i>::/restapis/<i>api-id</i>/stages/<i>stage-name</i></code></para></li><li><para>For an AppSync GraphQL API: <code>arn:<i>partition</i>:appsync:<i>region</i>:<i>account-id</i>:apis/<i>GraphQLApiId</i></code></para></li><li><para>For an Amazon Cognito user pool: <code>arn:<i>partition</i>:cognito-idp:<i>region</i>:<i>account-id</i>:userpool/<i>user-pool-id</i></code></para></li><li><para>For an App Runner service: <code>arn:<i>partition</i>:apprunner:<i>region</i>:<i>account-id</i>:service/<i>apprunner-service-name</i>/<i>apprunner-service-id</i></code></para></li><li><para>For an Amazon Web Services Verified Access instance: <code>arn:<i>partition</i>:ec2:<i>region</i>:<i>account-id</i>:verified-access-instance/<i>instance-id</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> 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> WAF uses WCUs to calculate and control the operating resources that are used to run your rules, rule groups, and web ACLs. 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. For more information, see <a href="https://docs.aws.amazon.com/waf/latest/developerguide/aws-waf-capacity-units.html">WAF web ACL capacity units (WCU)</a> in the <i>WAF Developer Guide</i>. </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 Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance. </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> Updates the specified <a>IPSet</a>. <note><para> This operation completely replaces the mutable specifications that you already have for the IP set with the ones that you provide to this call. </para><para> To modify an IP set, do the following: </para><ol><li><para> Retrieve it by calling <a>GetIPSet</a></para></li><li><para> Update its settings as needed </para></li><li><para> Provide the complete IP set specification to this call </para></li></ol></note><para> When you make changes to web ACLs or web ACL components, like rules and rule groups, WAF propagates the changes everywhere that the web ACL and its components are stored and used. Your changes are applied within seconds, but there might be a brief period of inconsistency when the changes have arrived in some places and not in others. So, for example, if you change a rule action setting, the action might be the old action in one area and the new action in another area. Or if you add an IP address to an IP set used in a blocking rule, the new address might briefly be blocked in one area while still allowed in another. This temporary inconsistency can occur when you first associate a web ACL with an Amazon Web Services resource and when you change a web ACL that is already associated with a resource. Generally, any inconsistencies of this type last only a few seconds. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.UpdateWAF2IPSetCmdlet.Address"> <summary> <para> <para>Contains an array of strings that specifies zero or more IP addresses or blocks of IP addresses. All addresses must be specified using Classless Inter-Domain Routing (CIDR) notation. WAF supports all IPv4 and IPv6 CIDR ranges except for <code>/0</code>. </para><para>Example address strings: </para><ul><li><para>To configure 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 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 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 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>Example JSON <code>Addresses</code> specifications: </para><ul><li><para>Empty array: <code>"Addresses": []</code></para></li><li><para>Array with one address: <code>"Addresses": ["192.0.2.44/32"]</code></para></li><li><para>Array with three addresses: <code>"Addresses": ["192.0.2.44/32", "192.0.2.0/24", "192.0.0.0/16"]</code></para></li><li><para>INVALID specification: <code>"Addresses": [""]</code> INVALID </para></li></ul> </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. </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. WAF returns a token to your <code>get</code> and <code>list</code> 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 <code>update</code> and <code>delete</code>. 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 <code>get</code>, 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 Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance. </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.UpdateWAF2ManagedRuleSetVersionExpiryDateCmdlet"> <summary> Updates the expiration information for your managed rule set. Use this to initiate the expiration of a managed rule group version. After you initiate expiration for a version, WAF excludes it from the response to <a>ListAvailableManagedRuleGroupVersions</a> for the managed rule group. <note><para> This is intended for use only by vendors of managed rule sets. Vendors are Amazon Web Services and Amazon Web Services Marketplace sellers. </para><para> Vendors, you can use the managed rule set APIs to provide controlled rollout of your versioned managed rule group offerings for your customers. The APIs are <code>ListManagedRuleSets</code>, <code>GetManagedRuleSet</code>, <code>PutManagedRuleSetVersions</code>, and <code>UpdateManagedRuleSetVersionExpiryDate</code>. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.UpdateWAF2ManagedRuleSetVersionExpiryDateCmdlet.ExpiryTimestamp"> <summary> <para> <para>The time that you want the version to expire.</para><para>Times are in Coordinated Universal Time (UTC) format. UTC format includes the special designator, Z. For example, "2016-09-27T14:50Z". </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.UpdateWAF2ManagedRuleSetVersionExpiryDateCmdlet.Id"> <summary> <para> <para>A unique identifier for the managed rule set. The ID is returned in the responses to commands like <code>list</code>. You provide it to operations like <code>get</code> and <code>update</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.UpdateWAF2ManagedRuleSetVersionExpiryDateCmdlet.LockToken"> <summary> <para> <para>A token used for optimistic locking. WAF returns a token to your <code>get</code> and <code>list</code> 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 <code>update</code> and <code>delete</code>. 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 <code>get</code>, and use the new token returned by that operation. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.UpdateWAF2ManagedRuleSetVersionExpiryDateCmdlet.Name"> <summary> <para> <para>The name of the managed rule set. You use this, along with the rule set ID, to identify the rule set.</para><para>This name is assigned to the corresponding managed rule group, which your customers can access and use. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.UpdateWAF2ManagedRuleSetVersionExpiryDateCmdlet.Scope"> <summary> <para> <para>Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance. </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.UpdateWAF2ManagedRuleSetVersionExpiryDateCmdlet.VersionToExpire"> <summary> <para> <para>The version that you want to remove from your list of offerings for the named managed rule group. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.UpdateWAF2ManagedRuleSetVersionExpiryDateCmdlet.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.UpdateManagedRuleSetVersionExpiryDateResponse). Specifying the name of a property of type Amazon.WAFV2.Model.UpdateManagedRuleSetVersionExpiryDateResponse 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.UpdateWAF2ManagedRuleSetVersionExpiryDateCmdlet.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.UpdateWAF2ManagedRuleSetVersionExpiryDateCmdlet.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> Updates the specified <a>RegexPatternSet</a>. <note><para> This operation completely replaces the mutable specifications that you already have for the regex pattern set with the ones that you provide to this call. </para><para> To modify a regex pattern set, do the following: </para><ol><li><para> Retrieve it by calling <a>GetRegexPatternSet</a></para></li><li><para> Update its settings as needed </para></li><li><para> Provide the complete regex pattern set specification to this call </para></li></ol></note><para> When you make changes to web ACLs or web ACL components, like rules and rule groups, WAF propagates the changes everywhere that the web ACL and its components are stored and used. Your changes are applied within seconds, but there might be a brief period of inconsistency when the changes have arrived in some places and not in others. So, for example, if you change a rule action setting, the action might be the old action in one area and the new action in another area. Or if you add an IP address to an IP set used in a blocking rule, the new address might briefly be blocked in one area while still allowed in another. This temporary inconsistency can occur when you first associate a web ACL with an Amazon Web Services resource and when you change a web ACL that is already associated with a resource. Generally, any inconsistencies of this type last only a few seconds. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.UpdateWAF2RegexPatternSetCmdlet.Description"> <summary> <para> <para>A description of the set that helps with identification. </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. WAF returns a token to your <code>get</code> and <code>list</code> 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 <code>update</code> and <code>delete</code>. 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 <code>get</code>, 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 Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance. </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> Updates the specified <a>RuleGroup</a>. <note><para> This operation completely replaces the mutable specifications that you already have for the rule group with the ones that you provide to this call. </para><para> To modify a rule group, do the following: </para><ol><li><para> Retrieve it by calling <a>GetRuleGroup</a></para></li><li><para> Update its settings as needed </para></li><li><para> Provide the complete rule group specification to this call </para></li></ol></note><para> When you make changes to web ACLs or web ACL components, like rules and rule groups, WAF propagates the changes everywhere that the web ACL and its components are stored and used. Your changes are applied within seconds, but there might be a brief period of inconsistency when the changes have arrived in some places and not in others. So, for example, if you change a rule action setting, the action might be the old action in one area and the new action in another area. Or if you add an IP address to an IP set used in a blocking rule, the new address might briefly be blocked in one area while still allowed in another. This temporary inconsistency can occur when you first associate a web ACL with an Amazon Web Services resource and when you change a web ACL that is already associated with a resource. Generally, any inconsistencies of this type last only a few seconds. </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>Indicates whether the associated resource sends metrics to Amazon CloudWatch. For the list of available metrics, see <a href="https://docs.aws.amazon.com/waf/latest/developerguide/monitoring-cloudwatch.html#waf-metrics">WAF Metrics</a> in the <i>WAF Developer Guide</i>.</para><para>For web ACLs, the metrics are for web requests that have the web ACL default action applied. WAF applies the default action to web requests that pass the inspection of all rules in the web ACL without being either allowed or blocked. For more information, see <a href="https://docs.aws.amazon.com/waf/latest/developerguide/web-acl-default-action.html">The web ACL default action</a> in the <i>WAF Developer Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.UpdateWAF2RuleGroupCmdlet.CustomResponseBody"> <summary> <para> <para>A map of custom response keys and content bodies. When you create a rule with a block action, you can send a custom response to the web request. You define these for the rule group, and then use them in the rules that you define in the rule group. </para><para>For information about customizing web requests and responses, see <a href="https://docs.aws.amazon.com/waf/latest/developerguide/waf-custom-request-response.html">Customizing web requests and responses in WAF</a> in the <i>WAF Developer Guide</i>. </para><para>For information about the limits on count and size for custom request and response settings, see <a href="https://docs.aws.amazon.com/waf/latest/developerguide/limits.html">WAF quotas</a> in the <i>WAF Developer Guide</i>. </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. </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. WAF returns a token to your <code>get</code> and <code>list</code> 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 <code>update</code> and <code>delete</code>. 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 <code>get</code>, 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 Amazon CloudWatch metric dimension. 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 that are reserved for WAF, for example <code>All</code> and <code>Default_Action</code>. </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 WAF uses to identify matching web requests, and parameters that govern how WAF handles them. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.UpdateWAF2RuleGroupCmdlet.VisibilityConfig_SampledRequestsEnabled"> <summary> <para> <para>Indicates whether WAF should store a sampling of the web requests that match the rules. You can view the sampled requests through the WAF console. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.UpdateWAF2RuleGroupCmdlet.Scope"> <summary> <para> <para>Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance. </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> Updates the specified <a>WebACL</a>. While updating a web ACL, WAF provides continuous coverage to the resources that you have associated with the web ACL. <note><para> This operation completely replaces the mutable specifications that you already have for the web ACL with the ones that you provide to this call. </para><para> To modify a web ACL, do the following: </para><ol><li><para> Retrieve it by calling <a>GetWebACL</a></para></li><li><para> Update its settings as needed </para></li><li><para> Provide the complete web ACL specification to this call </para></li></ol></note><para> When you make changes to web ACLs or web ACL components, like rules and rule groups, WAF propagates the changes everywhere that the web ACL and its components are stored and used. Your changes are applied within seconds, but there might be a brief period of inconsistency when the changes have arrived in some places and not in others. So, for example, if you change a rule action setting, the action might be the old action in one area and the new action in another area. Or if you add an IP address to an IP set used in a blocking rule, the new address might briefly be blocked in one area while still allowed in another. This temporary inconsistency can occur when you first associate a web ACL with an Amazon Web Services resource and when you change a web ACL that is already associated with a resource. Generally, any inconsistencies of this type last only a few seconds. </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 Amazon Web Services resources to protect. The resources can be an Amazon CloudFront distribution, an Amazon API Gateway REST API, an Application Load Balancer, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.UpdateWAF2WebACLCmdlet.DefaultAction_Allow"> <summary> <para> <para>Specifies that 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 WAF should block requests by default. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.UpdateWAF2WebACLCmdlet.VisibilityConfig_CloudWatchMetricsEnabled"> <summary> <para> <para>Indicates whether the associated resource sends metrics to Amazon CloudWatch. For the list of available metrics, see <a href="https://docs.aws.amazon.com/waf/latest/developerguide/monitoring-cloudwatch.html#waf-metrics">WAF Metrics</a> in the <i>WAF Developer Guide</i>.</para><para>For web ACLs, the metrics are for web requests that have the web ACL default action applied. WAF applies the default action to web requests that pass the inspection of all rules in the web ACL without being either allowed or blocked. For more information, see <a href="https://docs.aws.amazon.com/waf/latest/developerguide/web-acl-default-action.html">The web ACL default action</a> in the <i>WAF Developer Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.UpdateWAF2WebACLCmdlet.CustomResponseBody"> <summary> <para> <para>A map of custom response keys and content bodies. When you create a rule with a block action, you can send a custom response to the web request. You define these for the web ACL, and then use them in the rules and default actions that you define in the web ACL. </para><para>For information about customizing web requests and responses, see <a href="https://docs.aws.amazon.com/waf/latest/developerguide/waf-custom-request-response.html">Customizing web requests and responses in WAF</a> in the <i>WAF Developer Guide</i>. </para><para>For information about the limits on count and size for custom request and response settings, see <a href="https://docs.aws.amazon.com/waf/latest/developerguide/limits.html">WAF quotas</a> in the <i>WAF Developer Guide</i>. </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. </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.CaptchaConfig_ImmunityTimeProperty_ImmunityTime"> <summary> <para> <para>The amount of time, in seconds, that a <code>CAPTCHA</code> or challenge timestamp is considered valid by WAF. The default setting is 300. </para><para>For the Challenge action, the minimum setting is 300. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.UpdateWAF2WebACLCmdlet.ChallengeConfig_ImmunityTimeProperty_ImmunityTime"> <summary> <para> <para>The amount of time, in seconds, that a <code>CAPTCHA</code> or challenge timestamp is considered valid by WAF. The default setting is 300. </para><para>For the Challenge action, the minimum setting is 300. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.UpdateWAF2WebACLCmdlet.LockToken"> <summary> <para> <para>A token used for optimistic locking. WAF returns a token to your <code>get</code> and <code>list</code> 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 <code>update</code> and <code>delete</code>. 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 <code>get</code>, 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 Amazon CloudWatch metric dimension. 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 that are reserved for WAF, for example <code>All</code> and <code>Default_Action</code>. </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.AssociationConfig_RequestBody"> <summary> <para> <para>Customizes the maximum size of the request body that your protected CloudFront distributions forward to WAF for inspection. The default size is 16 KB (16,384 kilobytes). </para><note><para>You are charged additional fees when your protected resources forward body sizes that are larger than the default. For more information, see <a href="http://aws.amazon.com/waf/pricing/">WAF Pricing</a>.</para></note> </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 WAF uses to identify matching web requests, and parameters that govern how WAF handles them. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.UpdateWAF2WebACLCmdlet.VisibilityConfig_SampledRequestsEnabled"> <summary> <para> <para>Indicates whether WAF should store a sampling of the web requests that match the rules. You can view the sampled requests through the WAF console. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.UpdateWAF2WebACLCmdlet.Scope"> <summary> <para> <para>Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance. </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.TokenDomain"> <summary> <para> <para>Specifies the domains that WAF should accept in a web request token. This enables the use of tokens across multiple protected websites. When WAF provides a token, it uses the domain of the Amazon Web Services resource that the web ACL is protecting. If you don't specify a list of token domains, WAF accepts tokens only for the domain of the protected resource. With a token domain list, WAF accepts the resource's host domain plus all domains in the token domain list, including their prefixed subdomains.</para><para>Example JSON: <code>"TokenDomains": { "mywebsite.com", "myotherwebsite.com" }</code></para><para>Public suffixes aren't allowed. For example, you can't use <code>usa.gov</code> or <code>co.uk</code> as token domains.</para> </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> Enables the specified <a>LoggingConfiguration</a>, to start logging from a web ACL, according to the configuration provided. <note><para> This operation completely replaces any mutable specifications that you already have for a logging configuration with the ones that you provide to this call. </para><para> To modify an existing logging configuration, do the following: </para><ol><li><para> Retrieve it by calling <a>GetLoggingConfiguration</a></para></li><li><para> Update its settings as needed </para></li><li><para> Provide the complete logging configuration specification to this call </para></li></ol></note><note><para> You can define one logging destination per web ACL. </para></note><para> You can access information about the traffic that WAF inspects using the following steps: </para><ol><li><para> Create your logging destination. You can use an Amazon CloudWatch Logs log group, an Amazon Simple Storage Service (Amazon S3) bucket, or an Amazon Kinesis Data Firehose. </para><para> The name that you give the destination must start with <code>aws-waf-logs-</code>. Depending on the type of destination, you might need to configure additional settings or permissions. </para><para> For configuration requirements and pricing information for each destination type, see <a href="https://docs.aws.amazon.com/waf/latest/developerguide/logging.html">Logging web ACL traffic</a> in the <i>WAF Developer Guide</i>. </para></li><li><para> Associate your logging destination 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, WAF creates an additional role or policy that is required to write logs to the logging destination. For an Amazon CloudWatch Logs log group, WAF creates a resource policy on the log group. For an Amazon S3 bucket, WAF creates a bucket policy. For an Amazon Kinesis Data Firehose, WAF creates a service-linked role. </para><para> For additional information about web ACL logging, see <a href="https://docs.aws.amazon.com/waf/latest/developerguide/logging.html">Logging web ACL traffic information</a> in the <i>WAF Developer Guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.WriteWAF2LoggingConfigurationCmdlet.LoggingFilter_DefaultBehavior"> <summary> <para> <para>Default handling for logs that don't match any of the specified filtering conditions. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.WriteWAF2LoggingConfigurationCmdlet.LoggingFilter_Filter"> <summary> <para> <para>The filters that you want to apply to the logs. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.WriteWAF2LoggingConfigurationCmdlet.LoggingConfiguration_LogDestinationConfig"> <summary> <para> <para>The logging destination configuration that you want to associate with the web ACL.</para><note><para>You can associate one logging destination to a web ACL.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.WriteWAF2LoggingConfigurationCmdlet.LoggingConfiguration_ManagedByFirewallManager"> <summary> <para> <para>Indicates whether the logging configuration was created by Firewall Manager, as part of an 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>SingleHeader</code> field, the <code>HEADER</code> field in the logs will be <code>REDACTED</code>. </para><note><para>You can specify only the following fields for redaction: <code>UriPath</code>, <code>QueryString</code>, <code>SingleHeader</code>, <code>Method</code>, and <code>JsonBody</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.WriteWAF2ManagedRuleSetVersionCmdlet"> <summary> Defines the versions of your managed rule set that you are offering to the customers. Customers see your offerings as managed rule groups with versioning. <note><para> This is intended for use only by vendors of managed rule sets. Vendors are Amazon Web Services and Amazon Web Services Marketplace sellers. </para><para> Vendors, you can use the managed rule set APIs to provide controlled rollout of your versioned managed rule group offerings for your customers. The APIs are <code>ListManagedRuleSets</code>, <code>GetManagedRuleSet</code>, <code>PutManagedRuleSetVersions</code>, and <code>UpdateManagedRuleSetVersionExpiryDate</code>. </para></note><para> Customers retrieve their managed rule group list by calling <a>ListAvailableManagedRuleGroups</a>. The name that you provide here for your managed rule set is the name the customer sees for the corresponding managed rule group. Customers can retrieve the available versions for a managed rule group by calling <a>ListAvailableManagedRuleGroupVersions</a>. You provide a rule group specification for each version. For each managed rule set, you must specify a version that you recommend using. </para><para> To initiate the expiration of a managed rule group version, use <a>UpdateManagedRuleSetVersionExpiryDate</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.WriteWAF2ManagedRuleSetVersionCmdlet.Id"> <summary> <para> <para>A unique identifier for the managed rule set. The ID is returned in the responses to commands like <code>list</code>. You provide it to operations like <code>get</code> and <code>update</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.WriteWAF2ManagedRuleSetVersionCmdlet.LockToken"> <summary> <para> <para>A token used for optimistic locking. WAF returns a token to your <code>get</code> and <code>list</code> 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 <code>update</code> and <code>delete</code>. 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 <code>get</code>, and use the new token returned by that operation. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.WriteWAF2ManagedRuleSetVersionCmdlet.Name"> <summary> <para> <para>The name of the managed rule set. You use this, along with the rule set ID, to identify the rule set.</para><para>This name is assigned to the corresponding managed rule group, which your customers can access and use. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.WriteWAF2ManagedRuleSetVersionCmdlet.RecommendedVersion"> <summary> <para> <para>The version of the named managed rule group that you'd like your customers to choose, from among your version offerings. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.WriteWAF2ManagedRuleSetVersionCmdlet.Scope"> <summary> <para> <para>Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance. </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.WriteWAF2ManagedRuleSetVersionCmdlet.VersionsToPublish"> <summary> <para> <para>The versions of the named managed rule group that you want to offer to your customers. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.WAF2.WriteWAF2ManagedRuleSetVersionCmdlet.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.PutManagedRuleSetVersionsResponse). Specifying the name of a property of type Amazon.WAFV2.Model.PutManagedRuleSetVersionsResponse 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.WriteWAF2ManagedRuleSetVersionCmdlet.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.WriteWAF2ManagedRuleSetVersionCmdlet.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.</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> and may optionally specify <code>wafv2:GetRuleGroup</code>. 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> |