wafv2.d.ts
1 import {Request} from '../lib/request'; 2 import {Response} from '../lib/response'; 3 import {AWSError} from '../lib/error'; 4 import {Service} from '../lib/service'; 5 import {ServiceConfigurationOptions} from '../lib/service'; 6 import {ConfigBase as Config} from '../lib/config-base'; 7 interface Blob {} 8 declare class WAFV2 extends Service { 9 /** 10 * Constructs a service object. This object has one method for each API operation. 11 */ 12 constructor(options?: WAFV2.Types.ClientConfiguration) 13 config: Config & WAFV2.Types.ClientConfiguration; 14 /** 15 * 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, or an AppSync GraphQL API. For Amazon CloudFront, don't use this call. Instead, use your CloudFront distribution configuration. To associate a web ACL, in the CloudFront call UpdateDistribution, set the web ACL ID to the Amazon Resource Name (ARN) of the web ACL. For information, see UpdateDistribution. 16 */ 17 associateWebACL(params: WAFV2.Types.AssociateWebACLRequest, callback?: (err: AWSError, data: WAFV2.Types.AssociateWebACLResponse) => void): Request<WAFV2.Types.AssociateWebACLResponse, AWSError>; 18 /** 19 * 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, or an AppSync GraphQL API. For Amazon CloudFront, don't use this call. Instead, use your CloudFront distribution configuration. To associate a web ACL, in the CloudFront call UpdateDistribution, set the web ACL ID to the Amazon Resource Name (ARN) of the web ACL. For information, see UpdateDistribution. 20 */ 21 associateWebACL(callback?: (err: AWSError, data: WAFV2.Types.AssociateWebACLResponse) => void): Request<WAFV2.Types.AssociateWebACLResponse, AWSError>; 22 /** 23 * 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 RuleGroup or WebACL. 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. The WCU limit for web ACLs is 1,500. 24 */ 25 checkCapacity(params: WAFV2.Types.CheckCapacityRequest, callback?: (err: AWSError, data: WAFV2.Types.CheckCapacityResponse) => void): Request<WAFV2.Types.CheckCapacityResponse, AWSError>; 26 /** 27 * 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 RuleGroup or WebACL. 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. The WCU limit for web ACLs is 1,500. 28 */ 29 checkCapacity(callback?: (err: AWSError, data: WAFV2.Types.CheckCapacityResponse) => void): Request<WAFV2.Types.CheckCapacityResponse, AWSError>; 30 /** 31 * Creates an IPSet, 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. 32 */ 33 createIPSet(params: WAFV2.Types.CreateIPSetRequest, callback?: (err: AWSError, data: WAFV2.Types.CreateIPSetResponse) => void): Request<WAFV2.Types.CreateIPSetResponse, AWSError>; 34 /** 35 * Creates an IPSet, 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. 36 */ 37 createIPSet(callback?: (err: AWSError, data: WAFV2.Types.CreateIPSetResponse) => void): Request<WAFV2.Types.CreateIPSetResponse, AWSError>; 38 /** 39 * Creates a RegexPatternSet, which you reference in a RegexPatternSetReferenceStatement, to have WAF inspect a web request component for the specified patterns. 40 */ 41 createRegexPatternSet(params: WAFV2.Types.CreateRegexPatternSetRequest, callback?: (err: AWSError, data: WAFV2.Types.CreateRegexPatternSetResponse) => void): Request<WAFV2.Types.CreateRegexPatternSetResponse, AWSError>; 42 /** 43 * Creates a RegexPatternSet, which you reference in a RegexPatternSetReferenceStatement, to have WAF inspect a web request component for the specified patterns. 44 */ 45 createRegexPatternSet(callback?: (err: AWSError, data: WAFV2.Types.CreateRegexPatternSetResponse) => void): Request<WAFV2.Types.CreateRegexPatternSetResponse, AWSError>; 46 /** 47 * Creates a RuleGroup per the specifications provided. A rule group defines a collection of rules to inspect and control web requests that you can use in a WebACL. When you create a rule group, you define an immutable capacity limit. If you update a rule group, you must stay within the capacity. This allows others to reuse the rule group with confidence in its capacity requirements. 48 */ 49 createRuleGroup(params: WAFV2.Types.CreateRuleGroupRequest, callback?: (err: AWSError, data: WAFV2.Types.CreateRuleGroupResponse) => void): Request<WAFV2.Types.CreateRuleGroupResponse, AWSError>; 50 /** 51 * Creates a RuleGroup per the specifications provided. A rule group defines a collection of rules to inspect and control web requests that you can use in a WebACL. When you create a rule group, you define an immutable capacity limit. If you update a rule group, you must stay within the capacity. This allows others to reuse the rule group with confidence in its capacity requirements. 52 */ 53 createRuleGroup(callback?: (err: AWSError, data: WAFV2.Types.CreateRuleGroupResponse) => void): Request<WAFV2.Types.CreateRuleGroupResponse, AWSError>; 54 /** 55 * Creates a WebACL per the specifications provided. 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 Rule, RuleGroup, 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, or an AppSync GraphQL API. 56 */ 57 createWebACL(params: WAFV2.Types.CreateWebACLRequest, callback?: (err: AWSError, data: WAFV2.Types.CreateWebACLResponse) => void): Request<WAFV2.Types.CreateWebACLResponse, AWSError>; 58 /** 59 * Creates a WebACL per the specifications provided. 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 Rule, RuleGroup, 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, or an AppSync GraphQL API. 60 */ 61 createWebACL(callback?: (err: AWSError, data: WAFV2.Types.CreateWebACLResponse) => void): Request<WAFV2.Types.CreateWebACLResponse, AWSError>; 62 /** 63 * Deletes all rule groups that are managed by Firewall Manager for the specified web ACL. You can only use this if ManagedByFirewallManager is false in the specified WebACL. 64 */ 65 deleteFirewallManagerRuleGroups(params: WAFV2.Types.DeleteFirewallManagerRuleGroupsRequest, callback?: (err: AWSError, data: WAFV2.Types.DeleteFirewallManagerRuleGroupsResponse) => void): Request<WAFV2.Types.DeleteFirewallManagerRuleGroupsResponse, AWSError>; 66 /** 67 * Deletes all rule groups that are managed by Firewall Manager for the specified web ACL. You can only use this if ManagedByFirewallManager is false in the specified WebACL. 68 */ 69 deleteFirewallManagerRuleGroups(callback?: (err: AWSError, data: WAFV2.Types.DeleteFirewallManagerRuleGroupsResponse) => void): Request<WAFV2.Types.DeleteFirewallManagerRuleGroupsResponse, AWSError>; 70 /** 71 * Deletes the specified IPSet. 72 */ 73 deleteIPSet(params: WAFV2.Types.DeleteIPSetRequest, callback?: (err: AWSError, data: WAFV2.Types.DeleteIPSetResponse) => void): Request<WAFV2.Types.DeleteIPSetResponse, AWSError>; 74 /** 75 * Deletes the specified IPSet. 76 */ 77 deleteIPSet(callback?: (err: AWSError, data: WAFV2.Types.DeleteIPSetResponse) => void): Request<WAFV2.Types.DeleteIPSetResponse, AWSError>; 78 /** 79 * Deletes the LoggingConfiguration from the specified web ACL. 80 */ 81 deleteLoggingConfiguration(params: WAFV2.Types.DeleteLoggingConfigurationRequest, callback?: (err: AWSError, data: WAFV2.Types.DeleteLoggingConfigurationResponse) => void): Request<WAFV2.Types.DeleteLoggingConfigurationResponse, AWSError>; 82 /** 83 * Deletes the LoggingConfiguration from the specified web ACL. 84 */ 85 deleteLoggingConfiguration(callback?: (err: AWSError, data: WAFV2.Types.DeleteLoggingConfigurationResponse) => void): Request<WAFV2.Types.DeleteLoggingConfigurationResponse, AWSError>; 86 /** 87 * Permanently deletes an IAM policy from the specified rule group. You must be the owner of the rule group to perform this operation. 88 */ 89 deletePermissionPolicy(params: WAFV2.Types.DeletePermissionPolicyRequest, callback?: (err: AWSError, data: WAFV2.Types.DeletePermissionPolicyResponse) => void): Request<WAFV2.Types.DeletePermissionPolicyResponse, AWSError>; 90 /** 91 * Permanently deletes an IAM policy from the specified rule group. You must be the owner of the rule group to perform this operation. 92 */ 93 deletePermissionPolicy(callback?: (err: AWSError, data: WAFV2.Types.DeletePermissionPolicyResponse) => void): Request<WAFV2.Types.DeletePermissionPolicyResponse, AWSError>; 94 /** 95 * Deletes the specified RegexPatternSet. 96 */ 97 deleteRegexPatternSet(params: WAFV2.Types.DeleteRegexPatternSetRequest, callback?: (err: AWSError, data: WAFV2.Types.DeleteRegexPatternSetResponse) => void): Request<WAFV2.Types.DeleteRegexPatternSetResponse, AWSError>; 98 /** 99 * Deletes the specified RegexPatternSet. 100 */ 101 deleteRegexPatternSet(callback?: (err: AWSError, data: WAFV2.Types.DeleteRegexPatternSetResponse) => void): Request<WAFV2.Types.DeleteRegexPatternSetResponse, AWSError>; 102 /** 103 * Deletes the specified RuleGroup. 104 */ 105 deleteRuleGroup(params: WAFV2.Types.DeleteRuleGroupRequest, callback?: (err: AWSError, data: WAFV2.Types.DeleteRuleGroupResponse) => void): Request<WAFV2.Types.DeleteRuleGroupResponse, AWSError>; 106 /** 107 * Deletes the specified RuleGroup. 108 */ 109 deleteRuleGroup(callback?: (err: AWSError, data: WAFV2.Types.DeleteRuleGroupResponse) => void): Request<WAFV2.Types.DeleteRuleGroupResponse, AWSError>; 110 /** 111 * Deletes the specified WebACL. You can only use this if ManagedByFirewallManager is false in the specified WebACL. 112 */ 113 deleteWebACL(params: WAFV2.Types.DeleteWebACLRequest, callback?: (err: AWSError, data: WAFV2.Types.DeleteWebACLResponse) => void): Request<WAFV2.Types.DeleteWebACLResponse, AWSError>; 114 /** 115 * Deletes the specified WebACL. You can only use this if ManagedByFirewallManager is false in the specified WebACL. 116 */ 117 deleteWebACL(callback?: (err: AWSError, data: WAFV2.Types.DeleteWebACLResponse) => void): Request<WAFV2.Types.DeleteWebACLResponse, AWSError>; 118 /** 119 * Provides high-level information for a managed rule group, including descriptions of the rules. 120 */ 121 describeManagedRuleGroup(params: WAFV2.Types.DescribeManagedRuleGroupRequest, callback?: (err: AWSError, data: WAFV2.Types.DescribeManagedRuleGroupResponse) => void): Request<WAFV2.Types.DescribeManagedRuleGroupResponse, AWSError>; 122 /** 123 * Provides high-level information for a managed rule group, including descriptions of the rules. 124 */ 125 describeManagedRuleGroup(callback?: (err: AWSError, data: WAFV2.Types.DescribeManagedRuleGroupResponse) => void): Request<WAFV2.Types.DescribeManagedRuleGroupResponse, AWSError>; 126 /** 127 * Disassociates a web ACL from a regional application resource. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, or an AppSync GraphQL API. 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 UpdateDistribution. For information, see UpdateDistribution. 128 */ 129 disassociateWebACL(params: WAFV2.Types.DisassociateWebACLRequest, callback?: (err: AWSError, data: WAFV2.Types.DisassociateWebACLResponse) => void): Request<WAFV2.Types.DisassociateWebACLResponse, AWSError>; 130 /** 131 * Disassociates a web ACL from a regional application resource. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, or an AppSync GraphQL API. 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 UpdateDistribution. For information, see UpdateDistribution. 132 */ 133 disassociateWebACL(callback?: (err: AWSError, data: WAFV2.Types.DisassociateWebACLResponse) => void): Request<WAFV2.Types.DisassociateWebACLResponse, AWSError>; 134 /** 135 * Retrieves the specified IPSet. 136 */ 137 getIPSet(params: WAFV2.Types.GetIPSetRequest, callback?: (err: AWSError, data: WAFV2.Types.GetIPSetResponse) => void): Request<WAFV2.Types.GetIPSetResponse, AWSError>; 138 /** 139 * Retrieves the specified IPSet. 140 */ 141 getIPSet(callback?: (err: AWSError, data: WAFV2.Types.GetIPSetResponse) => void): Request<WAFV2.Types.GetIPSetResponse, AWSError>; 142 /** 143 * Returns the LoggingConfiguration for the specified web ACL. 144 */ 145 getLoggingConfiguration(params: WAFV2.Types.GetLoggingConfigurationRequest, callback?: (err: AWSError, data: WAFV2.Types.GetLoggingConfigurationResponse) => void): Request<WAFV2.Types.GetLoggingConfigurationResponse, AWSError>; 146 /** 147 * Returns the LoggingConfiguration for the specified web ACL. 148 */ 149 getLoggingConfiguration(callback?: (err: AWSError, data: WAFV2.Types.GetLoggingConfigurationResponse) => void): Request<WAFV2.Types.GetLoggingConfigurationResponse, AWSError>; 150 /** 151 * Retrieves the specified managed rule set. This is intended for use only by vendors of managed rule sets. Vendors are Amazon Web Services and Marketplace sellers. 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 ListManagedRuleSets, GetManagedRuleSet, PutManagedRuleSetVersions, and UpdateManagedRuleSetVersionExpiryDate. 152 */ 153 getManagedRuleSet(params: WAFV2.Types.GetManagedRuleSetRequest, callback?: (err: AWSError, data: WAFV2.Types.GetManagedRuleSetResponse) => void): Request<WAFV2.Types.GetManagedRuleSetResponse, AWSError>; 154 /** 155 * Retrieves the specified managed rule set. This is intended for use only by vendors of managed rule sets. Vendors are Amazon Web Services and Marketplace sellers. 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 ListManagedRuleSets, GetManagedRuleSet, PutManagedRuleSetVersions, and UpdateManagedRuleSetVersionExpiryDate. 156 */ 157 getManagedRuleSet(callback?: (err: AWSError, data: WAFV2.Types.GetManagedRuleSetResponse) => void): Request<WAFV2.Types.GetManagedRuleSetResponse, AWSError>; 158 /** 159 * Returns the IAM policy that is attached to the specified rule group. You must be the owner of the rule group to perform this operation. 160 */ 161 getPermissionPolicy(params: WAFV2.Types.GetPermissionPolicyRequest, callback?: (err: AWSError, data: WAFV2.Types.GetPermissionPolicyResponse) => void): Request<WAFV2.Types.GetPermissionPolicyResponse, AWSError>; 162 /** 163 * Returns the IAM policy that is attached to the specified rule group. You must be the owner of the rule group to perform this operation. 164 */ 165 getPermissionPolicy(callback?: (err: AWSError, data: WAFV2.Types.GetPermissionPolicyResponse) => void): Request<WAFV2.Types.GetPermissionPolicyResponse, AWSError>; 166 /** 167 * Retrieves the keys that are currently blocked by a rate-based rule. The maximum number of managed keys that can be blocked for a single rate-based rule is 10,000. If more than 10,000 addresses exceed the rate limit, those with the highest rates are blocked. 168 */ 169 getRateBasedStatementManagedKeys(params: WAFV2.Types.GetRateBasedStatementManagedKeysRequest, callback?: (err: AWSError, data: WAFV2.Types.GetRateBasedStatementManagedKeysResponse) => void): Request<WAFV2.Types.GetRateBasedStatementManagedKeysResponse, AWSError>; 170 /** 171 * Retrieves the keys that are currently blocked by a rate-based rule. The maximum number of managed keys that can be blocked for a single rate-based rule is 10,000. If more than 10,000 addresses exceed the rate limit, those with the highest rates are blocked. 172 */ 173 getRateBasedStatementManagedKeys(callback?: (err: AWSError, data: WAFV2.Types.GetRateBasedStatementManagedKeysResponse) => void): Request<WAFV2.Types.GetRateBasedStatementManagedKeysResponse, AWSError>; 174 /** 175 * Retrieves the specified RegexPatternSet. 176 */ 177 getRegexPatternSet(params: WAFV2.Types.GetRegexPatternSetRequest, callback?: (err: AWSError, data: WAFV2.Types.GetRegexPatternSetResponse) => void): Request<WAFV2.Types.GetRegexPatternSetResponse, AWSError>; 178 /** 179 * Retrieves the specified RegexPatternSet. 180 */ 181 getRegexPatternSet(callback?: (err: AWSError, data: WAFV2.Types.GetRegexPatternSetResponse) => void): Request<WAFV2.Types.GetRegexPatternSetResponse, AWSError>; 182 /** 183 * Retrieves the specified RuleGroup. 184 */ 185 getRuleGroup(params: WAFV2.Types.GetRuleGroupRequest, callback?: (err: AWSError, data: WAFV2.Types.GetRuleGroupResponse) => void): Request<WAFV2.Types.GetRuleGroupResponse, AWSError>; 186 /** 187 * Retrieves the specified RuleGroup. 188 */ 189 getRuleGroup(callback?: (err: AWSError, data: WAFV2.Types.GetRuleGroupResponse) => void): Request<WAFV2.Types.GetRuleGroupResponse, AWSError>; 190 /** 191 * 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. GetSampledRequests 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, GetSampledRequests returns an updated time range. This new time range indicates the actual period during which WAF selected the requests in the sample. 192 */ 193 getSampledRequests(params: WAFV2.Types.GetSampledRequestsRequest, callback?: (err: AWSError, data: WAFV2.Types.GetSampledRequestsResponse) => void): Request<WAFV2.Types.GetSampledRequestsResponse, AWSError>; 194 /** 195 * 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. GetSampledRequests 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, GetSampledRequests returns an updated time range. This new time range indicates the actual period during which WAF selected the requests in the sample. 196 */ 197 getSampledRequests(callback?: (err: AWSError, data: WAFV2.Types.GetSampledRequestsResponse) => void): Request<WAFV2.Types.GetSampledRequestsResponse, AWSError>; 198 /** 199 * Retrieves the specified WebACL. 200 */ 201 getWebACL(params: WAFV2.Types.GetWebACLRequest, callback?: (err: AWSError, data: WAFV2.Types.GetWebACLResponse) => void): Request<WAFV2.Types.GetWebACLResponse, AWSError>; 202 /** 203 * Retrieves the specified WebACL. 204 */ 205 getWebACL(callback?: (err: AWSError, data: WAFV2.Types.GetWebACLResponse) => void): Request<WAFV2.Types.GetWebACLResponse, AWSError>; 206 /** 207 * Retrieves the WebACL for the specified resource. 208 */ 209 getWebACLForResource(params: WAFV2.Types.GetWebACLForResourceRequest, callback?: (err: AWSError, data: WAFV2.Types.GetWebACLForResourceResponse) => void): Request<WAFV2.Types.GetWebACLForResourceResponse, AWSError>; 210 /** 211 * Retrieves the WebACL for the specified resource. 212 */ 213 getWebACLForResource(callback?: (err: AWSError, data: WAFV2.Types.GetWebACLForResourceResponse) => void): Request<WAFV2.Types.GetWebACLForResourceResponse, AWSError>; 214 /** 215 * Returns a list of the available versions for the specified managed rule group. 216 */ 217 listAvailableManagedRuleGroupVersions(params: WAFV2.Types.ListAvailableManagedRuleGroupVersionsRequest, callback?: (err: AWSError, data: WAFV2.Types.ListAvailableManagedRuleGroupVersionsResponse) => void): Request<WAFV2.Types.ListAvailableManagedRuleGroupVersionsResponse, AWSError>; 218 /** 219 * Returns a list of the available versions for the specified managed rule group. 220 */ 221 listAvailableManagedRuleGroupVersions(callback?: (err: AWSError, data: WAFV2.Types.ListAvailableManagedRuleGroupVersionsResponse) => void): Request<WAFV2.Types.ListAvailableManagedRuleGroupVersionsResponse, AWSError>; 222 /** 223 * 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 Marketplace managed rule groups that you're subscribed to. 224 */ 225 listAvailableManagedRuleGroups(params: WAFV2.Types.ListAvailableManagedRuleGroupsRequest, callback?: (err: AWSError, data: WAFV2.Types.ListAvailableManagedRuleGroupsResponse) => void): Request<WAFV2.Types.ListAvailableManagedRuleGroupsResponse, AWSError>; 226 /** 227 * 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 Marketplace managed rule groups that you're subscribed to. 228 */ 229 listAvailableManagedRuleGroups(callback?: (err: AWSError, data: WAFV2.Types.ListAvailableManagedRuleGroupsResponse) => void): Request<WAFV2.Types.ListAvailableManagedRuleGroupsResponse, AWSError>; 230 /** 231 * Retrieves an array of IPSetSummary objects for the IP sets that you manage. 232 */ 233 listIPSets(params: WAFV2.Types.ListIPSetsRequest, callback?: (err: AWSError, data: WAFV2.Types.ListIPSetsResponse) => void): Request<WAFV2.Types.ListIPSetsResponse, AWSError>; 234 /** 235 * Retrieves an array of IPSetSummary objects for the IP sets that you manage. 236 */ 237 listIPSets(callback?: (err: AWSError, data: WAFV2.Types.ListIPSetsResponse) => void): Request<WAFV2.Types.ListIPSetsResponse, AWSError>; 238 /** 239 * Retrieves an array of your LoggingConfiguration objects. 240 */ 241 listLoggingConfigurations(params: WAFV2.Types.ListLoggingConfigurationsRequest, callback?: (err: AWSError, data: WAFV2.Types.ListLoggingConfigurationsResponse) => void): Request<WAFV2.Types.ListLoggingConfigurationsResponse, AWSError>; 242 /** 243 * Retrieves an array of your LoggingConfiguration objects. 244 */ 245 listLoggingConfigurations(callback?: (err: AWSError, data: WAFV2.Types.ListLoggingConfigurationsResponse) => void): Request<WAFV2.Types.ListLoggingConfigurationsResponse, AWSError>; 246 /** 247 * Retrieves the managed rule sets that you own. This is intended for use only by vendors of managed rule sets. Vendors are Amazon Web Services and Marketplace sellers. 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 ListManagedRuleSets, GetManagedRuleSet, PutManagedRuleSetVersions, and UpdateManagedRuleSetVersionExpiryDate. 248 */ 249 listManagedRuleSets(params: WAFV2.Types.ListManagedRuleSetsRequest, callback?: (err: AWSError, data: WAFV2.Types.ListManagedRuleSetsResponse) => void): Request<WAFV2.Types.ListManagedRuleSetsResponse, AWSError>; 250 /** 251 * Retrieves the managed rule sets that you own. This is intended for use only by vendors of managed rule sets. Vendors are Amazon Web Services and Marketplace sellers. 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 ListManagedRuleSets, GetManagedRuleSet, PutManagedRuleSetVersions, and UpdateManagedRuleSetVersionExpiryDate. 252 */ 253 listManagedRuleSets(callback?: (err: AWSError, data: WAFV2.Types.ListManagedRuleSetsResponse) => void): Request<WAFV2.Types.ListManagedRuleSetsResponse, AWSError>; 254 /** 255 * Retrieves an array of RegexPatternSetSummary objects for the regex pattern sets that you manage. 256 */ 257 listRegexPatternSets(params: WAFV2.Types.ListRegexPatternSetsRequest, callback?: (err: AWSError, data: WAFV2.Types.ListRegexPatternSetsResponse) => void): Request<WAFV2.Types.ListRegexPatternSetsResponse, AWSError>; 258 /** 259 * Retrieves an array of RegexPatternSetSummary objects for the regex pattern sets that you manage. 260 */ 261 listRegexPatternSets(callback?: (err: AWSError, data: WAFV2.Types.ListRegexPatternSetsResponse) => void): Request<WAFV2.Types.ListRegexPatternSetsResponse, AWSError>; 262 /** 263 * 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 ListDistributionsByWebACLId. 264 */ 265 listResourcesForWebACL(params: WAFV2.Types.ListResourcesForWebACLRequest, callback?: (err: AWSError, data: WAFV2.Types.ListResourcesForWebACLResponse) => void): Request<WAFV2.Types.ListResourcesForWebACLResponse, AWSError>; 266 /** 267 * 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 ListDistributionsByWebACLId. 268 */ 269 listResourcesForWebACL(callback?: (err: AWSError, data: WAFV2.Types.ListResourcesForWebACLResponse) => void): Request<WAFV2.Types.ListResourcesForWebACLResponse, AWSError>; 270 /** 271 * Retrieves an array of RuleGroupSummary objects for the rule groups that you manage. 272 */ 273 listRuleGroups(params: WAFV2.Types.ListRuleGroupsRequest, callback?: (err: AWSError, data: WAFV2.Types.ListRuleGroupsResponse) => void): Request<WAFV2.Types.ListRuleGroupsResponse, AWSError>; 274 /** 275 * Retrieves an array of RuleGroupSummary objects for the rule groups that you manage. 276 */ 277 listRuleGroups(callback?: (err: AWSError, data: WAFV2.Types.ListRuleGroupsResponse) => void): Request<WAFV2.Types.ListRuleGroupsResponse, AWSError>; 278 /** 279 * Retrieves the TagInfoForResource 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. 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. 280 */ 281 listTagsForResource(params: WAFV2.Types.ListTagsForResourceRequest, callback?: (err: AWSError, data: WAFV2.Types.ListTagsForResourceResponse) => void): Request<WAFV2.Types.ListTagsForResourceResponse, AWSError>; 282 /** 283 * Retrieves the TagInfoForResource 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. 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. 284 */ 285 listTagsForResource(callback?: (err: AWSError, data: WAFV2.Types.ListTagsForResourceResponse) => void): Request<WAFV2.Types.ListTagsForResourceResponse, AWSError>; 286 /** 287 * Retrieves an array of WebACLSummary objects for the web ACLs that you manage. 288 */ 289 listWebACLs(params: WAFV2.Types.ListWebACLsRequest, callback?: (err: AWSError, data: WAFV2.Types.ListWebACLsResponse) => void): Request<WAFV2.Types.ListWebACLsResponse, AWSError>; 290 /** 291 * Retrieves an array of WebACLSummary objects for the web ACLs that you manage. 292 */ 293 listWebACLs(callback?: (err: AWSError, data: WAFV2.Types.ListWebACLsResponse) => void): Request<WAFV2.Types.ListWebACLsResponse, AWSError>; 294 /** 295 * Enables the specified LoggingConfiguration, to start logging from a web ACL, according to the configuration provided. You can access information about all traffic that WAF inspects using the following steps: Create an Amazon Kinesis Data Firehose. Create the data firehose with a PUT source and in the Region that you are operating. If you are capturing logs for Amazon CloudFront, always create the firehose in US East (N. Virginia). Give the data firehose a name that starts with the prefix aws-waf-logs-. For example, aws-waf-logs-us-east-2-analytics. Do not create the data firehose using a Kinesis stream as your source. Associate that firehose to your web ACL using a PutLoggingConfiguration request. When you successfully enable logging using a PutLoggingConfiguration request, WAF will create a service linked role with the necessary permissions to write logs to the Amazon Kinesis Data Firehose. For more information, see Logging Web ACL Traffic Information in the WAF Developer Guide. This operation completely replaces the mutable specifications that you already have for the logging configuration with the ones that you provide to this call. To modify the logging configuration, retrieve it by calling GetLoggingConfiguration, update the settings as needed, and then provide the complete logging configuration specification to this call. 296 */ 297 putLoggingConfiguration(params: WAFV2.Types.PutLoggingConfigurationRequest, callback?: (err: AWSError, data: WAFV2.Types.PutLoggingConfigurationResponse) => void): Request<WAFV2.Types.PutLoggingConfigurationResponse, AWSError>; 298 /** 299 * Enables the specified LoggingConfiguration, to start logging from a web ACL, according to the configuration provided. You can access information about all traffic that WAF inspects using the following steps: Create an Amazon Kinesis Data Firehose. Create the data firehose with a PUT source and in the Region that you are operating. If you are capturing logs for Amazon CloudFront, always create the firehose in US East (N. Virginia). Give the data firehose a name that starts with the prefix aws-waf-logs-. For example, aws-waf-logs-us-east-2-analytics. Do not create the data firehose using a Kinesis stream as your source. Associate that firehose to your web ACL using a PutLoggingConfiguration request. When you successfully enable logging using a PutLoggingConfiguration request, WAF will create a service linked role with the necessary permissions to write logs to the Amazon Kinesis Data Firehose. For more information, see Logging Web ACL Traffic Information in the WAF Developer Guide. This operation completely replaces the mutable specifications that you already have for the logging configuration with the ones that you provide to this call. To modify the logging configuration, retrieve it by calling GetLoggingConfiguration, update the settings as needed, and then provide the complete logging configuration specification to this call. 300 */ 301 putLoggingConfiguration(callback?: (err: AWSError, data: WAFV2.Types.PutLoggingConfigurationResponse) => void): Request<WAFV2.Types.PutLoggingConfigurationResponse, AWSError>; 302 /** 303 * 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. This is intended for use only by vendors of managed rule sets. Vendors are Amazon Web Services and Marketplace sellers. 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 ListManagedRuleSets, GetManagedRuleSet, PutManagedRuleSetVersions, and UpdateManagedRuleSetVersionExpiryDate. Customers retrieve their managed rule group list by calling ListAvailableManagedRuleGroups. 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 ListAvailableManagedRuleGroupVersions. You provide a rule group specification for each version. For each managed rule set, you must specify a version that you recommend using. To initiate the expiration of a managed rule group version, use UpdateManagedRuleSetVersionExpiryDate. 304 */ 305 putManagedRuleSetVersions(params: WAFV2.Types.PutManagedRuleSetVersionsRequest, callback?: (err: AWSError, data: WAFV2.Types.PutManagedRuleSetVersionsResponse) => void): Request<WAFV2.Types.PutManagedRuleSetVersionsResponse, AWSError>; 306 /** 307 * 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. This is intended for use only by vendors of managed rule sets. Vendors are Amazon Web Services and Marketplace sellers. 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 ListManagedRuleSets, GetManagedRuleSet, PutManagedRuleSetVersions, and UpdateManagedRuleSetVersionExpiryDate. Customers retrieve their managed rule group list by calling ListAvailableManagedRuleGroups. 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 ListAvailableManagedRuleGroupVersions. You provide a rule group specification for each version. For each managed rule set, you must specify a version that you recommend using. To initiate the expiration of a managed rule group version, use UpdateManagedRuleSetVersionExpiryDate. 308 */ 309 putManagedRuleSetVersions(callback?: (err: AWSError, data: WAFV2.Types.PutManagedRuleSetVersionsResponse) => void): Request<WAFV2.Types.PutManagedRuleSetVersionsResponse, AWSError>; 310 /** 311 * Attaches an IAM policy to the specified resource. Use this to share a rule group across accounts. You must be the owner of the rule group to perform this operation. This action is subject to the following restrictions: You can attach only one policy with each PutPermissionPolicy request. The ARN in the request must be a valid WAF RuleGroup ARN and the rule group must exist in the same Region. The user making the request must be the owner of the rule group. 312 */ 313 putPermissionPolicy(params: WAFV2.Types.PutPermissionPolicyRequest, callback?: (err: AWSError, data: WAFV2.Types.PutPermissionPolicyResponse) => void): Request<WAFV2.Types.PutPermissionPolicyResponse, AWSError>; 314 /** 315 * Attaches an IAM policy to the specified resource. Use this to share a rule group across accounts. You must be the owner of the rule group to perform this operation. This action is subject to the following restrictions: You can attach only one policy with each PutPermissionPolicy request. The ARN in the request must be a valid WAF RuleGroup ARN and the rule group must exist in the same Region. The user making the request must be the owner of the rule group. 316 */ 317 putPermissionPolicy(callback?: (err: AWSError, data: WAFV2.Types.PutPermissionPolicyResponse) => void): Request<WAFV2.Types.PutPermissionPolicyResponse, AWSError>; 318 /** 319 * 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. 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. 320 */ 321 tagResource(params: WAFV2.Types.TagResourceRequest, callback?: (err: AWSError, data: WAFV2.Types.TagResourceResponse) => void): Request<WAFV2.Types.TagResourceResponse, AWSError>; 322 /** 323 * 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. 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. 324 */ 325 tagResource(callback?: (err: AWSError, data: WAFV2.Types.TagResourceResponse) => void): Request<WAFV2.Types.TagResourceResponse, AWSError>; 326 /** 327 * 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. 328 */ 329 untagResource(params: WAFV2.Types.UntagResourceRequest, callback?: (err: AWSError, data: WAFV2.Types.UntagResourceResponse) => void): Request<WAFV2.Types.UntagResourceResponse, AWSError>; 330 /** 331 * 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. 332 */ 333 untagResource(callback?: (err: AWSError, data: WAFV2.Types.UntagResourceResponse) => void): Request<WAFV2.Types.UntagResourceResponse, AWSError>; 334 /** 335 * Updates the specified IPSet. This operation completely replaces the mutable specifications that you already have for the IP set with the ones that you provide to this call. To modify the IP set, retrieve it by calling GetIPSet, update the settings as needed, and then provide the complete IP set specification to this call. 336 */ 337 updateIPSet(params: WAFV2.Types.UpdateIPSetRequest, callback?: (err: AWSError, data: WAFV2.Types.UpdateIPSetResponse) => void): Request<WAFV2.Types.UpdateIPSetResponse, AWSError>; 338 /** 339 * Updates the specified IPSet. This operation completely replaces the mutable specifications that you already have for the IP set with the ones that you provide to this call. To modify the IP set, retrieve it by calling GetIPSet, update the settings as needed, and then provide the complete IP set specification to this call. 340 */ 341 updateIPSet(callback?: (err: AWSError, data: WAFV2.Types.UpdateIPSetResponse) => void): Request<WAFV2.Types.UpdateIPSetResponse, AWSError>; 342 /** 343 * 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 reponse to ListAvailableManagedRuleGroupVersions for the managed rule group. This is intended for use only by vendors of managed rule sets. Vendors are Amazon Web Services and Marketplace sellers. 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 ListManagedRuleSets, GetManagedRuleSet, PutManagedRuleSetVersions, and UpdateManagedRuleSetVersionExpiryDate. 344 */ 345 updateManagedRuleSetVersionExpiryDate(params: WAFV2.Types.UpdateManagedRuleSetVersionExpiryDateRequest, callback?: (err: AWSError, data: WAFV2.Types.UpdateManagedRuleSetVersionExpiryDateResponse) => void): Request<WAFV2.Types.UpdateManagedRuleSetVersionExpiryDateResponse, AWSError>; 346 /** 347 * 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 reponse to ListAvailableManagedRuleGroupVersions for the managed rule group. This is intended for use only by vendors of managed rule sets. Vendors are Amazon Web Services and Marketplace sellers. 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 ListManagedRuleSets, GetManagedRuleSet, PutManagedRuleSetVersions, and UpdateManagedRuleSetVersionExpiryDate. 348 */ 349 updateManagedRuleSetVersionExpiryDate(callback?: (err: AWSError, data: WAFV2.Types.UpdateManagedRuleSetVersionExpiryDateResponse) => void): Request<WAFV2.Types.UpdateManagedRuleSetVersionExpiryDateResponse, AWSError>; 350 /** 351 * Updates the specified RegexPatternSet. 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. To modify the regex pattern set, retrieve it by calling GetRegexPatternSet, update the settings as needed, and then provide the complete regex pattern set specification to this call. 352 */ 353 updateRegexPatternSet(params: WAFV2.Types.UpdateRegexPatternSetRequest, callback?: (err: AWSError, data: WAFV2.Types.UpdateRegexPatternSetResponse) => void): Request<WAFV2.Types.UpdateRegexPatternSetResponse, AWSError>; 354 /** 355 * Updates the specified RegexPatternSet. 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. To modify the regex pattern set, retrieve it by calling GetRegexPatternSet, update the settings as needed, and then provide the complete regex pattern set specification to this call. 356 */ 357 updateRegexPatternSet(callback?: (err: AWSError, data: WAFV2.Types.UpdateRegexPatternSetResponse) => void): Request<WAFV2.Types.UpdateRegexPatternSetResponse, AWSError>; 358 /** 359 * Updates the specified RuleGroup. This operation completely replaces the mutable specifications that you already have for the rule group with the ones that you provide to this call. To modify the rule group, retrieve it by calling GetRuleGroup, update the settings as needed, and then provide the complete rule group specification to this call. A rule group defines a collection of rules to inspect and control web requests that you can use in a WebACL. When you create a rule group, you define an immutable capacity limit. If you update a rule group, you must stay within the capacity. This allows others to reuse the rule group with confidence in its capacity requirements. 360 */ 361 updateRuleGroup(params: WAFV2.Types.UpdateRuleGroupRequest, callback?: (err: AWSError, data: WAFV2.Types.UpdateRuleGroupResponse) => void): Request<WAFV2.Types.UpdateRuleGroupResponse, AWSError>; 362 /** 363 * Updates the specified RuleGroup. This operation completely replaces the mutable specifications that you already have for the rule group with the ones that you provide to this call. To modify the rule group, retrieve it by calling GetRuleGroup, update the settings as needed, and then provide the complete rule group specification to this call. A rule group defines a collection of rules to inspect and control web requests that you can use in a WebACL. When you create a rule group, you define an immutable capacity limit. If you update a rule group, you must stay within the capacity. This allows others to reuse the rule group with confidence in its capacity requirements. 364 */ 365 updateRuleGroup(callback?: (err: AWSError, data: WAFV2.Types.UpdateRuleGroupResponse) => void): Request<WAFV2.Types.UpdateRuleGroupResponse, AWSError>; 366 /** 367 * Updates the specified WebACL. This operation completely replaces the mutable specifications that you already have for the web ACL with the ones that you provide to this call. To modify the web ACL, retrieve it by calling GetWebACL, update the settings as needed, and then provide the complete web ACL specification to this call. 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 Rule, RuleGroup, 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, or an AppSync GraphQL API. 368 */ 369 updateWebACL(params: WAFV2.Types.UpdateWebACLRequest, callback?: (err: AWSError, data: WAFV2.Types.UpdateWebACLResponse) => void): Request<WAFV2.Types.UpdateWebACLResponse, AWSError>; 370 /** 371 * Updates the specified WebACL. This operation completely replaces the mutable specifications that you already have for the web ACL with the ones that you provide to this call. To modify the web ACL, retrieve it by calling GetWebACL, update the settings as needed, and then provide the complete web ACL specification to this call. 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 Rule, RuleGroup, 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, or an AppSync GraphQL API. 372 */ 373 updateWebACL(callback?: (err: AWSError, data: WAFV2.Types.UpdateWebACLResponse) => void): Request<WAFV2.Types.UpdateWebACLResponse, AWSError>; 374 } 375 declare namespace WAFV2 { 376 export type Action = string; 377 export interface ActionCondition { 378 /** 379 * The action setting that a log record must contain in order to meet the condition. 380 */ 381 Action: ActionValue; 382 } 383 export type ActionValue = "ALLOW"|"BLOCK"|"COUNT"|string; 384 export interface All { 385 } 386 export interface AllQueryArguments { 387 } 388 export interface AllowAction { 389 /** 390 * Defines custom handling for the web request. For information about customizing web requests and responses, see Customizing web requests and responses in WAF in the WAF Developer Guide. 391 */ 392 CustomRequestHandling?: CustomRequestHandling; 393 } 394 export interface AndStatement { 395 /** 396 * The statements to combine with AND logic. You can use any statements that can be nested. 397 */ 398 Statements: Statements; 399 } 400 export interface AssociateWebACLRequest { 401 /** 402 * The Amazon Resource Name (ARN) of the web ACL that you want to associate with the resource. 403 */ 404 WebACLArn: ResourceArn; 405 /** 406 * The Amazon Resource Name (ARN) of the resource to associate with the web ACL. The ARN must be in one of the following formats: For an Application Load Balancer: arn:aws:elasticloadbalancing:region:account-id:loadbalancer/app/load-balancer-name/load-balancer-id For an Amazon API Gateway REST API: arn:aws:apigateway:region::/restapis/api-id/stages/stage-name For an AppSync GraphQL API: arn:aws:appsync:region:account-id:apis/GraphQLApiId 407 */ 408 ResourceArn: ResourceArn; 409 } 410 export interface AssociateWebACLResponse { 411 } 412 export interface BlockAction { 413 /** 414 * Defines a custom response for the web request. For information about customizing web requests and responses, see Customizing web requests and responses in WAF in the WAF Developer Guide. 415 */ 416 CustomResponse?: CustomResponse; 417 } 418 export interface Body { 419 } 420 export type BodyParsingFallbackBehavior = "MATCH"|"NO_MATCH"|"EVALUATE_AS_STRING"|string; 421 export type Boolean = boolean; 422 export interface ByteMatchStatement { 423 /** 424 * A string value that you want WAF to search for. WAF searches only in the part of web requests that you designate for inspection in FieldToMatch. The maximum length of the value is 50 bytes. Valid values depend on the component that you specify for inspection in FieldToMatch: Method: The HTTP method that you want WAF to search for. This indicates the type of operation specified in the request. UriPath: The value that you want WAF to search for in the URI path, for example, /images/daily-ad.jpg. If SearchString includes alphabetic characters A-Z and a-z, note that the value is case sensitive. If you're using the WAF API Specify a base64-encoded version of the value. The maximum length of the value before you base64-encode it is 50 bytes. For example, suppose the value of Type is HEADER and the value of Data is User-Agent. If you want to search the User-Agent header for the value BadBot, you base64-encode BadBot using MIME base64-encoding and include the resulting value, QmFkQm90, in the value of SearchString. If you're using the CLI or one of the Amazon Web Services SDKs The value that you want WAF to search for. The SDK automatically base64 encodes the value. 425 */ 426 SearchString: SearchString; 427 /** 428 * The part of a web request that you want WAF to inspect. For more information, see FieldToMatch. 429 */ 430 FieldToMatch: FieldToMatch; 431 /** 432 * Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. If you specify one or more transformations in a rule statement, WAF performs all transformations on the content of the request component identified by FieldToMatch, starting from the lowest priority setting, before inspecting the content for a match. 433 */ 434 TextTransformations: TextTransformations; 435 /** 436 * The area within the portion of a web request that you want WAF to search for SearchString. Valid values include the following: CONTAINS The specified part of the web request must include the value of SearchString, but the location doesn't matter. CONTAINS_WORD The specified part of the web request must include the value of SearchString, and SearchString must contain only alphanumeric characters or underscore (A-Z, a-z, 0-9, or _). In addition, SearchString must be a word, which means that both of the following are true: SearchString is at the beginning of the specified part of the web request or is preceded by a character other than an alphanumeric character or underscore (_). Examples include the value of a header and ;BadBot. SearchString is at the end of the specified part of the web request or is followed by a character other than an alphanumeric character or underscore (_), for example, BadBot; and -BadBot;. EXACTLY The value of the specified part of the web request must exactly match the value of SearchString. STARTS_WITH The value of SearchString must appear at the beginning of the specified part of the web request. ENDS_WITH The value of SearchString must appear at the end of the specified part of the web request. 437 */ 438 PositionalConstraint: PositionalConstraint; 439 } 440 export type CapacityUnit = number; 441 export interface CheckCapacityRequest { 442 /** 443 * 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, or an AppSync GraphQL API. To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows: CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1. API and SDKs - For all calls, use the Region endpoint us-east-1. 444 */ 445 Scope: Scope; 446 /** 447 * An array of Rule that you're configuring to use in a rule group or web ACL. 448 */ 449 Rules: Rules; 450 } 451 export interface CheckCapacityResponse { 452 /** 453 * The capacity required by the rules and scope. 454 */ 455 Capacity?: ConsumedCapacity; 456 } 457 export type ComparisonOperator = "EQ"|"NE"|"LE"|"LT"|"GE"|"GT"|string; 458 export interface Condition { 459 /** 460 * A single action condition. 461 */ 462 ActionCondition?: ActionCondition; 463 /** 464 * A single label name condition. 465 */ 466 LabelNameCondition?: LabelNameCondition; 467 } 468 export type Conditions = Condition[]; 469 export type ConsumedCapacity = number; 470 export interface CountAction { 471 /** 472 * Defines custom handling for the web request. For information about customizing web requests and responses, see Customizing web requests and responses in WAF in the WAF Developer Guide. 473 */ 474 CustomRequestHandling?: CustomRequestHandling; 475 } 476 export type Country = string; 477 export type CountryCode = "AF"|"AX"|"AL"|"DZ"|"AS"|"AD"|"AO"|"AI"|"AQ"|"AG"|"AR"|"AM"|"AW"|"AU"|"AT"|"AZ"|"BS"|"BH"|"BD"|"BB"|"BY"|"BE"|"BZ"|"BJ"|"BM"|"BT"|"BO"|"BQ"|"BA"|"BW"|"BV"|"BR"|"IO"|"BN"|"BG"|"BF"|"BI"|"KH"|"CM"|"CA"|"CV"|"KY"|"CF"|"TD"|"CL"|"CN"|"CX"|"CC"|"CO"|"KM"|"CG"|"CD"|"CK"|"CR"|"CI"|"HR"|"CU"|"CW"|"CY"|"CZ"|"DK"|"DJ"|"DM"|"DO"|"EC"|"EG"|"SV"|"GQ"|"ER"|"EE"|"ET"|"FK"|"FO"|"FJ"|"FI"|"FR"|"GF"|"PF"|"TF"|"GA"|"GM"|"GE"|"DE"|"GH"|"GI"|"GR"|"GL"|"GD"|"GP"|"GU"|"GT"|"GG"|"GN"|"GW"|"GY"|"HT"|"HM"|"VA"|"HN"|"HK"|"HU"|"IS"|"IN"|"ID"|"IR"|"IQ"|"IE"|"IM"|"IL"|"IT"|"JM"|"JP"|"JE"|"JO"|"KZ"|"KE"|"KI"|"KP"|"KR"|"KW"|"KG"|"LA"|"LV"|"LB"|"LS"|"LR"|"LY"|"LI"|"LT"|"LU"|"MO"|"MK"|"MG"|"MW"|"MY"|"MV"|"ML"|"MT"|"MH"|"MQ"|"MR"|"MU"|"YT"|"MX"|"FM"|"MD"|"MC"|"MN"|"ME"|"MS"|"MA"|"MZ"|"MM"|"NA"|"NR"|"NP"|"NL"|"NC"|"NZ"|"NI"|"NE"|"NG"|"NU"|"NF"|"MP"|"NO"|"OM"|"PK"|"PW"|"PS"|"PA"|"PG"|"PY"|"PE"|"PH"|"PN"|"PL"|"PT"|"PR"|"QA"|"RE"|"RO"|"RU"|"RW"|"BL"|"SH"|"KN"|"LC"|"MF"|"PM"|"VC"|"WS"|"SM"|"ST"|"SA"|"SN"|"RS"|"SC"|"SL"|"SG"|"SX"|"SK"|"SI"|"SB"|"SO"|"ZA"|"GS"|"SS"|"ES"|"LK"|"SD"|"SR"|"SJ"|"SZ"|"SE"|"CH"|"SY"|"TW"|"TJ"|"TZ"|"TH"|"TL"|"TG"|"TK"|"TO"|"TT"|"TN"|"TR"|"TM"|"TC"|"TV"|"UG"|"UA"|"AE"|"GB"|"US"|"UM"|"UY"|"UZ"|"VU"|"VE"|"VN"|"VG"|"VI"|"WF"|"EH"|"YE"|"ZM"|"ZW"|string; 478 export type CountryCodes = CountryCode[]; 479 export interface CreateIPSetRequest { 480 /** 481 * The name of the IP set. You cannot change the name of an IPSet after you create it. 482 */ 483 Name: EntityName; 484 /** 485 * 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, or an AppSync GraphQL API. To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows: CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1. API and SDKs - For all calls, use the Region endpoint us-east-1. 486 */ 487 Scope: Scope; 488 /** 489 * A description of the IP set that helps with identification. 490 */ 491 Description?: EntityDescription; 492 /** 493 * The version of the IP addresses, either IPV4 or IPV6. 494 */ 495 IPAddressVersion: IPAddressVersion; 496 /** 497 * Contains an array of strings that specify one or more IP addresses or blocks of IP addresses in Classless Inter-Domain Routing (CIDR) notation. WAF supports all IPv4 and IPv6 CIDR ranges except for /0. Examples: To configure WAF to allow, block, or count requests that originated from the IP address 192.0.2.44, specify 192.0.2.44/32. 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 192.0.2.0/24. To configure WAF to allow, block, or count requests that originated from the IP address 1111:0000:0000:0000:0000:0000:0000:0111, specify 1111:0000:0000:0000:0000:0000:0000:0111/128. 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 1111:0000:0000:0000:0000:0000:0000:0000/64. For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing. 498 */ 499 Addresses: IPAddresses; 500 /** 501 * An array of key:value pairs to associate with the resource. 502 */ 503 Tags?: TagList; 504 } 505 export interface CreateIPSetResponse { 506 /** 507 * High-level information about an IPSet, returned by operations like create and list. This provides information like the ID, that you can use to retrieve and manage an IPSet, and the ARN, that you provide to the IPSetReferenceStatement to use the address set in a Rule. 508 */ 509 Summary?: IPSetSummary; 510 } 511 export interface CreateRegexPatternSetRequest { 512 /** 513 * The name of the set. You cannot change the name after you create the set. 514 */ 515 Name: EntityName; 516 /** 517 * 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, or an AppSync GraphQL API. To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows: CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1. API and SDKs - For all calls, use the Region endpoint us-east-1. 518 */ 519 Scope: Scope; 520 /** 521 * A description of the set that helps with identification. 522 */ 523 Description?: EntityDescription; 524 /** 525 * Array of regular expression strings. 526 */ 527 RegularExpressionList: RegularExpressionList; 528 /** 529 * An array of key:value pairs to associate with the resource. 530 */ 531 Tags?: TagList; 532 } 533 export interface CreateRegexPatternSetResponse { 534 /** 535 * High-level information about a RegexPatternSet, returned by operations like create and list. This provides information like the ID, that you can use to retrieve and manage a RegexPatternSet, and the ARN, that you provide to the RegexPatternSetReferenceStatement to use the pattern set in a Rule. 536 */ 537 Summary?: RegexPatternSetSummary; 538 } 539 export interface CreateRuleGroupRequest { 540 /** 541 * The name of the rule group. You cannot change the name of a rule group after you create it. 542 */ 543 Name: EntityName; 544 /** 545 * 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, or an AppSync GraphQL API. To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows: CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1. API and SDKs - For all calls, use the Region endpoint us-east-1. 546 */ 547 Scope: Scope; 548 /** 549 * The web ACL capacity units (WCUs) required for this rule group. 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 CheckCapacity. 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. The WCU limit for web ACLs is 1,500. 550 */ 551 Capacity: CapacityUnit; 552 /** 553 * A description of the rule group that helps with identification. 554 */ 555 Description?: EntityDescription; 556 /** 557 * The Rule statements used to identify the web requests that you want to allow, block, or count. Each rule includes one top-level statement that WAF uses to identify matching web requests, and parameters that govern how WAF handles them. 558 */ 559 Rules?: Rules; 560 /** 561 * Defines and enables Amazon CloudWatch metrics and web request sample collection. 562 */ 563 VisibilityConfig: VisibilityConfig; 564 /** 565 * An array of key:value pairs to associate with the resource. 566 */ 567 Tags?: TagList; 568 /** 569 * A map of custom response keys and content bodies. When you create a rule with a block action, you can send a custom response to the web request. You define these for the rule group, and then use them in the rules that you define in the rule group. For information about customizing web requests and responses, see Customizing web requests and responses in WAF in the WAF Developer Guide. For information about the limits on count and size for custom request and response settings, see WAF quotas in the WAF Developer Guide. 570 */ 571 CustomResponseBodies?: CustomResponseBodies; 572 } 573 export interface CreateRuleGroupResponse { 574 /** 575 * High-level information about a RuleGroup, returned by operations like create and list. This provides information like the ID, that you can use to retrieve and manage a RuleGroup, and the ARN, that you provide to the RuleGroupReferenceStatement to use the rule group in a Rule. 576 */ 577 Summary?: RuleGroupSummary; 578 } 579 export interface CreateWebACLRequest { 580 /** 581 * The name of the web ACL. You cannot change the name of a web ACL after you create it. 582 */ 583 Name: EntityName; 584 /** 585 * 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, or an AppSync GraphQL API. To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows: CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1. API and SDKs - For all calls, use the Region endpoint us-east-1. 586 */ 587 Scope: Scope; 588 /** 589 * The action to perform if none of the Rules contained in the WebACL match. 590 */ 591 DefaultAction: DefaultAction; 592 /** 593 * A description of the web ACL that helps with identification. 594 */ 595 Description?: EntityDescription; 596 /** 597 * The Rule statements used to identify the web requests that you want to allow, block, or count. Each rule includes one top-level statement that WAF uses to identify matching web requests, and parameters that govern how WAF handles them. 598 */ 599 Rules?: Rules; 600 /** 601 * Defines and enables Amazon CloudWatch metrics and web request sample collection. 602 */ 603 VisibilityConfig: VisibilityConfig; 604 /** 605 * An array of key:value pairs to associate with the resource. 606 */ 607 Tags?: TagList; 608 /** 609 * 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. For information about customizing web requests and responses, see Customizing web requests and responses in WAF in the WAF Developer Guide. For information about the limits on count and size for custom request and response settings, see WAF quotas in the WAF Developer Guide. 610 */ 611 CustomResponseBodies?: CustomResponseBodies; 612 } 613 export interface CreateWebACLResponse { 614 /** 615 * High-level information about a WebACL, returned by operations like create and list. This provides information like the ID, that you can use to retrieve and manage a WebACL, and the ARN, that you provide to operations like AssociateWebACL. 616 */ 617 Summary?: WebACLSummary; 618 } 619 export interface CustomHTTPHeader { 620 /** 621 * The name of the custom header. For custom request header insertion, when WAF inserts the header into the request, it prefixes this name x-amzn-waf-, to avoid confusion with the headers that are already in the request. For example, for the header name sample, WAF inserts the header x-amzn-waf-sample. 622 */ 623 Name: CustomHTTPHeaderName; 624 /** 625 * The value of the custom header. 626 */ 627 Value: CustomHTTPHeaderValue; 628 } 629 export type CustomHTTPHeaderName = string; 630 export type CustomHTTPHeaderValue = string; 631 export type CustomHTTPHeaders = CustomHTTPHeader[]; 632 export interface CustomRequestHandling { 633 /** 634 * The HTTP headers to insert into the request. Duplicate header names are not allowed. For information about the limits on count and size for custom request and response settings, see WAF quotas in the WAF Developer Guide. 635 */ 636 InsertHeaders: CustomHTTPHeaders; 637 } 638 export interface CustomResponse { 639 /** 640 * The HTTP status code to return to the client. For a list of status codes that you can use in your custom reqponses, see Supported status codes for custom response in the WAF Developer Guide. 641 */ 642 ResponseCode: ResponseStatusCode; 643 /** 644 * References the response body that you want WAF to return to the web request client. You can define a custom response for a rule action or a default web ACL action that is set to block. To do this, you first define the response body key and value in the CustomResponseBodies setting for the WebACL or RuleGroup where you want to use it. Then, in the rule action or web ACL default action BlockAction setting, you reference the response body using this key. 645 */ 646 CustomResponseBodyKey?: EntityName; 647 /** 648 * The HTTP headers to use in the response. Duplicate header names are not allowed. For information about the limits on count and size for custom request and response settings, see WAF quotas in the WAF Developer Guide. 649 */ 650 ResponseHeaders?: CustomHTTPHeaders; 651 } 652 export type CustomResponseBodies = {[key: string]: CustomResponseBody}; 653 export interface CustomResponseBody { 654 /** 655 * The type of content in the payload that you are defining in the Content string. 656 */ 657 ContentType: ResponseContentType; 658 /** 659 * The payload of the custom response. You can use JSON escape strings in JSON content. To do this, you must specify JSON content in the ContentType setting. For information about the limits on count and size for custom request and response settings, see WAF quotas in the WAF Developer Guide. 660 */ 661 Content: ResponseContent; 662 } 663 export interface DefaultAction { 664 /** 665 * Specifies that WAF should block requests by default. 666 */ 667 Block?: BlockAction; 668 /** 669 * Specifies that WAF should allow requests by default. 670 */ 671 Allow?: AllowAction; 672 } 673 export interface DeleteFirewallManagerRuleGroupsRequest { 674 /** 675 * The Amazon Resource Name (ARN) of the web ACL. 676 */ 677 WebACLArn: ResourceArn; 678 /** 679 * A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation. 680 */ 681 WebACLLockToken: LockToken; 682 } 683 export interface DeleteFirewallManagerRuleGroupsResponse { 684 /** 685 * A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation. 686 */ 687 NextWebACLLockToken?: LockToken; 688 } 689 export interface DeleteIPSetRequest { 690 /** 691 * The name of the IP set. You cannot change the name of an IPSet after you create it. 692 */ 693 Name: EntityName; 694 /** 695 * 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, or an AppSync GraphQL API. To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows: CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1. API and SDKs - For all calls, use the Region endpoint us-east-1. 696 */ 697 Scope: Scope; 698 /** 699 * 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. 700 */ 701 Id: EntityId; 702 /** 703 * A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation. 704 */ 705 LockToken: LockToken; 706 } 707 export interface DeleteIPSetResponse { 708 } 709 export interface DeleteLoggingConfigurationRequest { 710 /** 711 * The Amazon Resource Name (ARN) of the web ACL from which you want to delete the LoggingConfiguration. 712 */ 713 ResourceArn: ResourceArn; 714 } 715 export interface DeleteLoggingConfigurationResponse { 716 } 717 export interface DeletePermissionPolicyRequest { 718 /** 719 * The Amazon Resource Name (ARN) of the rule group from which you want to delete the policy. You must be the owner of the rule group to perform this operation. 720 */ 721 ResourceArn: ResourceArn; 722 } 723 export interface DeletePermissionPolicyResponse { 724 } 725 export interface DeleteRegexPatternSetRequest { 726 /** 727 * The name of the set. You cannot change the name after you create the set. 728 */ 729 Name: EntityName; 730 /** 731 * 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, or an AppSync GraphQL API. To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows: CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1. API and SDKs - For all calls, use the Region endpoint us-east-1. 732 */ 733 Scope: Scope; 734 /** 735 * 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. 736 */ 737 Id: EntityId; 738 /** 739 * A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation. 740 */ 741 LockToken: LockToken; 742 } 743 export interface DeleteRegexPatternSetResponse { 744 } 745 export interface DeleteRuleGroupRequest { 746 /** 747 * The name of the rule group. You cannot change the name of a rule group after you create it. 748 */ 749 Name: EntityName; 750 /** 751 * 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, or an AppSync GraphQL API. To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows: CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1. API and SDKs - For all calls, use the Region endpoint us-east-1. 752 */ 753 Scope: Scope; 754 /** 755 * 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. 756 */ 757 Id: EntityId; 758 /** 759 * A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation. 760 */ 761 LockToken: LockToken; 762 } 763 export interface DeleteRuleGroupResponse { 764 } 765 export interface DeleteWebACLRequest { 766 /** 767 * The name of the web ACL. You cannot change the name of a web ACL after you create it. 768 */ 769 Name: EntityName; 770 /** 771 * 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, or an AppSync GraphQL API. To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows: CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1. API and SDKs - For all calls, use the Region endpoint us-east-1. 772 */ 773 Scope: Scope; 774 /** 775 * 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. 776 */ 777 Id: EntityId; 778 /** 779 * A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation. 780 */ 781 LockToken: LockToken; 782 } 783 export interface DeleteWebACLResponse { 784 } 785 export interface DescribeManagedRuleGroupRequest { 786 /** 787 * The name of the managed rule group vendor. You use this, along with the rule group name, to identify the rule group. 788 */ 789 VendorName: VendorName; 790 /** 791 * The name of the managed rule group. You use this, along with the vendor name, to identify the rule group. 792 */ 793 Name: EntityName; 794 /** 795 * 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, or an AppSync GraphQL API. To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows: CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1. API and SDKs - For all calls, use the Region endpoint us-east-1. 796 */ 797 Scope: Scope; 798 /** 799 * 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. 800 */ 801 VersionName?: VersionKeyString; 802 } 803 export interface DescribeManagedRuleGroupResponse { 804 /** 805 * The managed rule group's version. 806 */ 807 VersionName?: VersionKeyString; 808 /** 809 * The Amazon resource name (ARN) of the Amazon Simple Notification Service SNS topic that's used to record changes to the managed rule group. You can subscribe to the SNS topic to receive notifications when the managed rule group is modified, such as for new versions and for version expiration. For more information, see the Amazon Simple Notification Service Developer Guide. 810 */ 811 SnsTopicArn?: ResourceArn; 812 /** 813 * The web ACL capacity units (WCUs) required for this rule group. WAF uses web ACL capacity units (WCU) 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 each rule's relative cost. Rule group capacity is fixed at creation, so users can plan their web ACL WCU usage when they use a rule group. The WCU limit for web ACLs is 1,500. 814 */ 815 Capacity?: CapacityUnit; 816 /** 817 * 818 */ 819 Rules?: RuleSummaries; 820 /** 821 * The label namespace prefix for this rule group. All labels added by rules in this rule group have this prefix. The syntax for the label namespace prefix for a managed rule group is the following: awswaf:managed:<vendor>:<rule group name>: When a rule with a label matches a web request, WAF adds the fully qualified label to the request. A fully qualified label is made up of the label namespace from the rule group or web ACL where the rule is defined and the label from the rule, separated by a colon: <label namespace>:<label from rule> 822 */ 823 LabelNamespace?: LabelName; 824 /** 825 * The labels that one or more rules in this rule group add to matching web requests. These labels are defined in the RuleLabels for a Rule. 826 */ 827 AvailableLabels?: LabelSummaries; 828 /** 829 * The labels that one or more rules in this rule group match against in label match statements. These labels are defined in a LabelMatchStatement specification, in the Statement definition of a rule. 830 */ 831 ConsumedLabels?: LabelSummaries; 832 } 833 export interface DisassociateWebACLRequest { 834 /** 835 * The Amazon Resource Name (ARN) of the resource to disassociate from the web ACL. The ARN must be in one of the following formats: For an Application Load Balancer: arn:aws:elasticloadbalancing:region:account-id:loadbalancer/app/load-balancer-name/load-balancer-id For an Amazon API Gateway REST API: arn:aws:apigateway:region::/restapis/api-id/stages/stage-name For an AppSync GraphQL API: arn:aws:appsync:region:account-id:apis/GraphQLApiId 836 */ 837 ResourceArn: ResourceArn; 838 } 839 export interface DisassociateWebACLResponse { 840 } 841 export type EntityDescription = string; 842 export type EntityId = string; 843 export type EntityName = string; 844 export interface ExcludedRule { 845 /** 846 * The name of the rule to exclude. 847 */ 848 Name: EntityName; 849 } 850 export type ExcludedRules = ExcludedRule[]; 851 export type FallbackBehavior = "MATCH"|"NO_MATCH"|string; 852 export interface FieldToMatch { 853 /** 854 * Inspect a single header. Provide the name of the header to inspect, for example, User-Agent or Referer. This setting isn't case sensitive. Example JSON: "SingleHeader": { "Name": "haystack" } 855 */ 856 SingleHeader?: SingleHeader; 857 /** 858 * Inspect a single query argument. Provide the name of the query argument to inspect, such as UserName or SalesRegion. The name can be up to 30 characters long and isn't case sensitive. This is used only to indicate the web request component for WAF to inspect, in the FieldToMatch specification. Example JSON: "SingleQueryArgument": { "Name": "myArgument" } 859 */ 860 SingleQueryArgument?: SingleQueryArgument; 861 /** 862 * Inspect all query arguments. 863 */ 864 AllQueryArguments?: AllQueryArguments; 865 /** 866 * Inspect the request URI path. This is the part of a web request that identifies a resource, for example, /images/daily-ad.jpg. 867 */ 868 UriPath?: UriPath; 869 /** 870 * Inspect the query string. This is the part of a URL that appears after a ? character, if any. 871 */ 872 QueryString?: QueryString; 873 /** 874 * Inspect the request body as plain text. The request body immediately follows the request headers. This is the part of a request that contains any additional data that you want to send to your web server as the HTTP request body, such as data from a form. Note that only the first 8 KB (8192 bytes) of the request body are forwarded to WAF for inspection by the underlying host service. If you don't need to inspect more than 8 KB, you can guarantee that you don't allow additional bytes in by combining a statement that inspects the body of the web request, such as ByteMatchStatement or RegexPatternSetReferenceStatement, with a SizeConstraintStatement that enforces an 8 KB size limit on the body of the request. WAF doesn't support inspecting the entire contents of web requests whose bodies exceed the 8 KB limit. 875 */ 876 Body?: Body; 877 /** 878 * Inspect the HTTP method. The method indicates the type of operation that the request is asking the origin to perform. 879 */ 880 Method?: Method; 881 /** 882 * Inspect the request body as JSON. The request body immediately follows the request headers. This is the part of a request that contains any additional data that you want to send to your web server as the HTTP request body, such as data from a form. Note that only the first 8 KB (8192 bytes) of the request body are forwarded to WAF for inspection by the underlying host service. If you don't need to inspect more than 8 KB, you can guarantee that you don't allow additional bytes in by combining a statement that inspects the body of the web request, such as ByteMatchStatement or RegexPatternSetReferenceStatement, with a SizeConstraintStatement that enforces an 8 KB size limit on the body of the request. WAF doesn't support inspecting the entire contents of web requests whose bodies exceed the 8 KB limit. 883 */ 884 JsonBody?: JsonBody; 885 } 886 export type FieldToMatchData = string; 887 export interface Filter { 888 /** 889 * How to handle logs that satisfy the filter's conditions and requirement. 890 */ 891 Behavior: FilterBehavior; 892 /** 893 * Logic to apply to the filtering conditions. You can specify that, in order to satisfy the filter, a log must match all conditions or must match at least one condition. 894 */ 895 Requirement: FilterRequirement; 896 /** 897 * Match conditions for the filter. 898 */ 899 Conditions: Conditions; 900 } 901 export type FilterBehavior = "KEEP"|"DROP"|string; 902 export type FilterRequirement = "MEETS_ALL"|"MEETS_ANY"|string; 903 export type Filters = Filter[]; 904 export interface FirewallManagerRuleGroup { 905 /** 906 * The name of the rule group. You cannot change the name of a rule group after you create it. 907 */ 908 Name: EntityName; 909 /** 910 * If you define more than one rule group in the first or last Firewall Manager rule groups, WAF evaluates each request against the rule groups in order, starting from the lowest priority setting. The priorities don't need to be consecutive, but they must all be different. 911 */ 912 Priority: RulePriority; 913 /** 914 * The processing guidance for an Firewall Manager rule. This is like a regular rule Statement, but it can only contain a rule group reference. 915 */ 916 FirewallManagerStatement: FirewallManagerStatement; 917 /** 918 * The override action to apply to the rules in a rule group. Used only for rule statements that reference a rule group, like RuleGroupReferenceStatement and ManagedRuleGroupStatement. Set the override action to none to leave the rule actions in effect. Set it to count to only count matches, regardless of the rule action settings. In a Rule, you must specify either this OverrideAction setting or the rule Action setting, but not both: If the rule statement references a rule group, use this override action setting and not the action setting. If the rule statement does not reference a rule group, use the rule action setting and not this rule override action setting. 919 */ 920 OverrideAction: OverrideAction; 921 /** 922 * Defines and enables Amazon CloudWatch metrics and web request sample collection. 923 */ 924 VisibilityConfig: VisibilityConfig; 925 } 926 export type FirewallManagerRuleGroups = FirewallManagerRuleGroup[]; 927 export interface FirewallManagerStatement { 928 /** 929 * A rule statement used to run the rules that are defined in a managed rule group. To use this, provide the vendor name and the name of the rule group in this statement. You can retrieve the required names by calling ListAvailableManagedRuleGroups. You cannot nest a ManagedRuleGroupStatement, for example for use inside a NotStatement or OrStatement. It can only be referenced as a top-level statement within a rule. 930 */ 931 ManagedRuleGroupStatement?: ManagedRuleGroupStatement; 932 /** 933 * A rule statement used to run the rules that are defined in a RuleGroup. To use this, create a rule group with your rules, then provide the ARN of the rule group in this statement. You cannot nest a RuleGroupReferenceStatement, for example for use inside a NotStatement or OrStatement. It can only be referenced as a top-level statement within a rule. 934 */ 935 RuleGroupReferenceStatement?: RuleGroupReferenceStatement; 936 } 937 export interface ForwardedIPConfig { 938 /** 939 * The name of the HTTP header to use for the IP address. For example, to use the X-Forwarded-For (XFF) header, set this to X-Forwarded-For. If the specified header isn't present in the request, WAF doesn't apply the rule to the web request at all. 940 */ 941 HeaderName: ForwardedIPHeaderName; 942 /** 943 * The match status to assign to the web request if the request doesn't have a valid IP address in the specified position. If the specified header isn't present in the request, WAF doesn't apply the rule to the web request at all. You can specify the following fallback behaviors: MATCH - Treat the web request as matching the rule statement. WAF applies the rule action to the request. NO_MATCH - Treat the web request as not matching the rule statement. 944 */ 945 FallbackBehavior: FallbackBehavior; 946 } 947 export type ForwardedIPHeaderName = string; 948 export type ForwardedIPPosition = "FIRST"|"LAST"|"ANY"|string; 949 export interface GeoMatchStatement { 950 /** 951 * An array of two-character country codes, for example, [ "US", "CN" ], from the alpha-2 country ISO codes of the ISO 3166 international standard. 952 */ 953 CountryCodes?: CountryCodes; 954 /** 955 * The configuration for inspecting IP addresses in an HTTP header that you specify, instead of using the IP address that's reported by the web request origin. Commonly, this is the X-Forwarded-For (XFF) header, but you can specify any header name. If the specified header isn't present in the request, WAF doesn't apply the rule to the web request at all. 956 */ 957 ForwardedIPConfig?: ForwardedIPConfig; 958 } 959 export interface GetIPSetRequest { 960 /** 961 * The name of the IP set. You cannot change the name of an IPSet after you create it. 962 */ 963 Name: EntityName; 964 /** 965 * 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, or an AppSync GraphQL API. To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows: CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1. API and SDKs - For all calls, use the Region endpoint us-east-1. 966 */ 967 Scope: Scope; 968 /** 969 * 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. 970 */ 971 Id: EntityId; 972 } 973 export interface GetIPSetResponse { 974 /** 975 * 976 */ 977 IPSet?: IPSet; 978 /** 979 * A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation. 980 */ 981 LockToken?: LockToken; 982 } 983 export interface GetLoggingConfigurationRequest { 984 /** 985 * The Amazon Resource Name (ARN) of the web ACL for which you want to get the LoggingConfiguration. 986 */ 987 ResourceArn: ResourceArn; 988 } 989 export interface GetLoggingConfigurationResponse { 990 /** 991 * The LoggingConfiguration for the specified web ACL. 992 */ 993 LoggingConfiguration?: LoggingConfiguration; 994 } 995 export interface GetManagedRuleSetRequest { 996 /** 997 * The name of the managed rule set. You use this, along with the rule set ID, to identify the rule set. This name is assigned to the corresponding managed rule group, which your customers can access and use. 998 */ 999 Name: EntityName; 1000 /** 1001 * 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, or an AppSync GraphQL API. To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows: CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1. API and SDKs - For all calls, use the Region endpoint us-east-1. 1002 */ 1003 Scope: Scope; 1004 /** 1005 * A unique identifier for the managed rule set. The ID is returned in the responses to commands like list. You provide it to operations like get and update. 1006 */ 1007 Id: EntityId; 1008 } 1009 export interface GetManagedRuleSetResponse { 1010 /** 1011 * The managed rule set that you requested. 1012 */ 1013 ManagedRuleSet?: ManagedRuleSet; 1014 /** 1015 * A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation. 1016 */ 1017 LockToken?: LockToken; 1018 } 1019 export interface GetPermissionPolicyRequest { 1020 /** 1021 * The Amazon Resource Name (ARN) of the rule group for which you want to get the policy. 1022 */ 1023 ResourceArn: ResourceArn; 1024 } 1025 export interface GetPermissionPolicyResponse { 1026 /** 1027 * The IAM policy that is attached to the specified rule group. 1028 */ 1029 Policy?: PolicyString; 1030 } 1031 export interface GetRateBasedStatementManagedKeysRequest { 1032 /** 1033 * 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, or an AppSync GraphQL API. To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows: CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1. API and SDKs - For all calls, use the Region endpoint us-east-1. 1034 */ 1035 Scope: Scope; 1036 /** 1037 * The name of the web ACL. You cannot change the name of a web ACL after you create it. 1038 */ 1039 WebACLName: EntityName; 1040 /** 1041 * 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. 1042 */ 1043 WebACLId: EntityId; 1044 /** 1045 * The name of the rate-based rule to get the keys for. 1046 */ 1047 RuleName: EntityName; 1048 } 1049 export interface GetRateBasedStatementManagedKeysResponse { 1050 /** 1051 * The keys that are of Internet Protocol version 4 (IPv4). 1052 */ 1053 ManagedKeysIPV4?: RateBasedStatementManagedKeysIPSet; 1054 /** 1055 * The keys that are of Internet Protocol version 6 (IPv6). 1056 */ 1057 ManagedKeysIPV6?: RateBasedStatementManagedKeysIPSet; 1058 } 1059 export interface GetRegexPatternSetRequest { 1060 /** 1061 * The name of the set. You cannot change the name after you create the set. 1062 */ 1063 Name: EntityName; 1064 /** 1065 * 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, or an AppSync GraphQL API. To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows: CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1. API and SDKs - For all calls, use the Region endpoint us-east-1. 1066 */ 1067 Scope: Scope; 1068 /** 1069 * 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. 1070 */ 1071 Id: EntityId; 1072 } 1073 export interface GetRegexPatternSetResponse { 1074 /** 1075 * 1076 */ 1077 RegexPatternSet?: RegexPatternSet; 1078 /** 1079 * A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation. 1080 */ 1081 LockToken?: LockToken; 1082 } 1083 export interface GetRuleGroupRequest { 1084 /** 1085 * The name of the rule group. You cannot change the name of a rule group after you create it. 1086 */ 1087 Name?: EntityName; 1088 /** 1089 * 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, or an AppSync GraphQL API. To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows: CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1. API and SDKs - For all calls, use the Region endpoint us-east-1. 1090 */ 1091 Scope?: Scope; 1092 /** 1093 * 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. 1094 */ 1095 Id?: EntityId; 1096 /** 1097 * The Amazon Resource Name (ARN) of the entity. 1098 */ 1099 ARN?: ResourceArn; 1100 } 1101 export interface GetRuleGroupResponse { 1102 /** 1103 * 1104 */ 1105 RuleGroup?: RuleGroup; 1106 /** 1107 * A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation. 1108 */ 1109 LockToken?: LockToken; 1110 } 1111 export interface GetSampledRequestsRequest { 1112 /** 1113 * The Amazon resource name (ARN) of the WebACL for which you want a sample of requests. 1114 */ 1115 WebAclArn: ResourceArn; 1116 /** 1117 * The metric name assigned to the Rule or RuleGroup for which you want a sample of requests. 1118 */ 1119 RuleMetricName: MetricName; 1120 /** 1121 * 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, or an AppSync GraphQL API. To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows: CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1. API and SDKs - For all calls, use the Region endpoint us-east-1. 1122 */ 1123 Scope: Scope; 1124 /** 1125 * The start date and time and the end date and time of the range for which you want GetSampledRequests to return a sample of requests. You must specify the times in Coordinated Universal Time (UTC) format. UTC format includes the special designator, Z. For example, "2016-09-27T14:50Z". You can specify any time range in the previous three hours. If you specify a start time that's earlier than three hours ago, WAF sets it to three hours ago. 1126 */ 1127 TimeWindow: TimeWindow; 1128 /** 1129 * 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 MaxItems, GetSampledRequests returns information about all of them. 1130 */ 1131 MaxItems: ListMaxItems; 1132 } 1133 export interface GetSampledRequestsResponse { 1134 /** 1135 * A complex type that contains detailed information about each of the requests in the sample. 1136 */ 1137 SampledRequests?: SampledHTTPRequests; 1138 /** 1139 * The total number of requests from which GetSampledRequests got a sample of MaxItems requests. If PopulationSize is less than MaxItems, the sample includes every request that your Amazon Web Services resource received during the specified time range. 1140 */ 1141 PopulationSize?: PopulationSize; 1142 /** 1143 * Usually, TimeWindow is the time range that you specified in the GetSampledRequests request. However, if your Amazon Web Services resource received more than 5,000 requests during the time range that you specified in the request, GetSampledRequests returns the time range for the first 5,000 requests. Times are in Coordinated Universal Time (UTC) format. 1144 */ 1145 TimeWindow?: TimeWindow; 1146 } 1147 export interface GetWebACLForResourceRequest { 1148 /** 1149 * The ARN (Amazon Resource Name) of the resource. 1150 */ 1151 ResourceArn: ResourceArn; 1152 } 1153 export interface GetWebACLForResourceResponse { 1154 /** 1155 * The web ACL that is associated with the resource. If there is no associated resource, WAF returns a null web ACL. 1156 */ 1157 WebACL?: WebACL; 1158 } 1159 export interface GetWebACLRequest { 1160 /** 1161 * The name of the web ACL. You cannot change the name of a web ACL after you create it. 1162 */ 1163 Name: EntityName; 1164 /** 1165 * 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, or an AppSync GraphQL API. To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows: CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1. API and SDKs - For all calls, use the Region endpoint us-east-1. 1166 */ 1167 Scope: Scope; 1168 /** 1169 * 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. 1170 */ 1171 Id: EntityId; 1172 } 1173 export interface GetWebACLResponse { 1174 /** 1175 * The web ACL specification. You can modify the settings in this web ACL and use it to update this web ACL or create a new one. 1176 */ 1177 WebACL?: WebACL; 1178 /** 1179 * A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation. 1180 */ 1181 LockToken?: LockToken; 1182 } 1183 export interface HTTPHeader { 1184 /** 1185 * The name of the HTTP header. 1186 */ 1187 Name?: HeaderName; 1188 /** 1189 * The value of the HTTP header. 1190 */ 1191 Value?: HeaderValue; 1192 } 1193 export type HTTPHeaders = HTTPHeader[]; 1194 export type HTTPMethod = string; 1195 export interface HTTPRequest { 1196 /** 1197 * The IP address that the request originated from. If the web ACL is associated with a CloudFront distribution, this is the value of one of the following fields in CloudFront access logs: c-ip, if the viewer did not use an HTTP proxy or a load balancer to send the request x-forwarded-for, if the viewer did use an HTTP proxy or a load balancer to send the request 1198 */ 1199 ClientIP?: IPString; 1200 /** 1201 * The two-letter country code for the country that the request originated from. For a current list of country codes, see the Wikipedia entry ISO 3166-1 alpha-2. 1202 */ 1203 Country?: Country; 1204 /** 1205 * The URI path of the request, which identifies the resource, for example, /images/daily-ad.jpg. 1206 */ 1207 URI?: URIString; 1208 /** 1209 * The HTTP method specified in the sampled web request. 1210 */ 1211 Method?: HTTPMethod; 1212 /** 1213 * The HTTP version specified in the sampled web request, for example, HTTP/1.1. 1214 */ 1215 HTTPVersion?: HTTPVersion; 1216 /** 1217 * A complex type that contains the name and value for each header in the sampled web request. 1218 */ 1219 Headers?: HTTPHeaders; 1220 } 1221 export type HTTPVersion = string; 1222 export type HeaderName = string; 1223 export type HeaderValue = string; 1224 export type IPAddress = string; 1225 export type IPAddressVersion = "IPV4"|"IPV6"|string; 1226 export type IPAddresses = IPAddress[]; 1227 export interface IPSet { 1228 /** 1229 * The name of the IP set. You cannot change the name of an IPSet after you create it. 1230 */ 1231 Name: EntityName; 1232 /** 1233 * 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. 1234 */ 1235 Id: EntityId; 1236 /** 1237 * The Amazon Resource Name (ARN) of the entity. 1238 */ 1239 ARN: ResourceArn; 1240 /** 1241 * A description of the IP set that helps with identification. 1242 */ 1243 Description?: EntityDescription; 1244 /** 1245 * The version of the IP addresses, either IPV4 or IPV6. 1246 */ 1247 IPAddressVersion: IPAddressVersion; 1248 /** 1249 * Contains an array of strings that specify one or more IP addresses or blocks of IP addresses in Classless Inter-Domain Routing (CIDR) notation. WAF supports all IPv4 and IPv6 CIDR ranges except for /0. Examples: To configure WAF to allow, block, or count requests that originated from the IP address 192.0.2.44, specify 192.0.2.44/32. 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 192.0.2.0/24. To configure WAF to allow, block, or count requests that originated from the IP address 1111:0000:0000:0000:0000:0000:0000:0111, specify 1111:0000:0000:0000:0000:0000:0000:0111/128. 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 1111:0000:0000:0000:0000:0000:0000:0000/64. For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing. 1250 */ 1251 Addresses: IPAddresses; 1252 } 1253 export interface IPSetForwardedIPConfig { 1254 /** 1255 * The name of the HTTP header to use for the IP address. For example, to use the X-Forwarded-For (XFF) header, set this to X-Forwarded-For. If the specified header isn't present in the request, WAF doesn't apply the rule to the web request at all. 1256 */ 1257 HeaderName: ForwardedIPHeaderName; 1258 /** 1259 * The match status to assign to the web request if the request doesn't have a valid IP address in the specified position. If the specified header isn't present in the request, WAF doesn't apply the rule to the web request at all. You can specify the following fallback behaviors: MATCH - Treat the web request as matching the rule statement. WAF applies the rule action to the request. NO_MATCH - Treat the web request as not matching the rule statement. 1260 */ 1261 FallbackBehavior: FallbackBehavior; 1262 /** 1263 * The position in the header to search for the IP address. The header can contain IP addresses of the original client and also of proxies. For example, the header value could be 10.1.1.1, 127.0.0.0, 10.10.10.10 where the first IP address identifies the original client and the rest identify proxies that the request went through. The options for this setting are the following: FIRST - Inspect the first IP address in the list of IP addresses in the header. This is usually the client's original IP. LAST - Inspect the last IP address in the list of IP addresses in the header. ANY - Inspect all IP addresses in the header for a match. If the header contains more than 10 IP addresses, WAF inspects the last 10. 1264 */ 1265 Position: ForwardedIPPosition; 1266 } 1267 export interface IPSetReferenceStatement { 1268 /** 1269 * The Amazon Resource Name (ARN) of the IPSet that this statement references. 1270 */ 1271 ARN: ResourceArn; 1272 /** 1273 * The configuration for inspecting IP addresses in an HTTP header that you specify, instead of using the IP address that's reported by the web request origin. Commonly, this is the X-Forwarded-For (XFF) header, but you can specify any header name. If the specified header isn't present in the request, WAF doesn't apply the rule to the web request at all. 1274 */ 1275 IPSetForwardedIPConfig?: IPSetForwardedIPConfig; 1276 } 1277 export type IPSetSummaries = IPSetSummary[]; 1278 export interface IPSetSummary { 1279 /** 1280 * The name of the IP set. You cannot change the name of an IPSet after you create it. 1281 */ 1282 Name?: EntityName; 1283 /** 1284 * 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. 1285 */ 1286 Id?: EntityId; 1287 /** 1288 * A description of the IP set that helps with identification. 1289 */ 1290 Description?: EntityDescription; 1291 /** 1292 * A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation. 1293 */ 1294 LockToken?: LockToken; 1295 /** 1296 * The Amazon Resource Name (ARN) of the entity. 1297 */ 1298 ARN?: ResourceArn; 1299 } 1300 export type IPString = string; 1301 export interface JsonBody { 1302 /** 1303 * The patterns to look for in the JSON body. WAF inspects the results of these pattern matches against the rule inspection criteria. 1304 */ 1305 MatchPattern: JsonMatchPattern; 1306 /** 1307 * The parts of the JSON to match against using the MatchPattern. If you specify All, WAF matches against keys and values. 1308 */ 1309 MatchScope: JsonMatchScope; 1310 /** 1311 * What WAF should do if it fails to completely parse the JSON body. The options are the following: EVALUATE_AS_STRING - Inspect the body as plain text. WAF applies the text transformations and inspection criteria that you defined for the JSON inspection to the body text string. MATCH - Treat the web request as matching the rule statement. WAF applies the rule action to the request. NO_MATCH - Treat the web request as not matching the rule statement. If you don't provide this setting, WAF parses and evaluates the content only up to the first parsing failure that it encounters. WAF does its best to parse the entire JSON body, but might be forced to stop for reasons such as invalid characters, duplicate keys, truncation, and any content whose root node isn't an object or an array. WAF parses the JSON in the following examples as two valid key, value pairs: Missing comma: {"key1":"value1""key2":"value2"} Missing colon: {"key1":"value1","key2""value2"} Extra colons: {"key1"::"value1","key2""value2"} 1312 */ 1313 InvalidFallbackBehavior?: BodyParsingFallbackBehavior; 1314 } 1315 export interface JsonMatchPattern { 1316 /** 1317 * Match all of the elements. See also MatchScope in JsonBody. You must specify either this setting or the IncludedPaths setting, but not both. 1318 */ 1319 All?: All; 1320 /** 1321 * Match only the specified include paths. See also MatchScope in JsonBody. Provide the include paths using JSON Pointer syntax. For example, "IncludedPaths": ["/dogs/0/name", "/dogs/1/name"]. For information about this syntax, see the Internet Engineering Task Force (IETF) documentation JavaScript Object Notation (JSON) Pointer. You must specify either this setting or the All setting, but not both. Don't use this option to include all paths. Instead, use the All setting. 1322 */ 1323 IncludedPaths?: JsonPointerPaths; 1324 } 1325 export type JsonMatchScope = "ALL"|"KEY"|"VALUE"|string; 1326 export type JsonPointerPath = string; 1327 export type JsonPointerPaths = JsonPointerPath[]; 1328 export interface Label { 1329 /** 1330 * The label string. 1331 */ 1332 Name: LabelName; 1333 } 1334 export type LabelMatchKey = string; 1335 export type LabelMatchScope = "LABEL"|"NAMESPACE"|string; 1336 export interface LabelMatchStatement { 1337 /** 1338 * Specify whether you want to match using the label name or just the namespace. 1339 */ 1340 Scope: LabelMatchScope; 1341 /** 1342 * The string to match against. The setting you provide for this depends on the match statement's Scope setting: If the Scope indicates LABEL, then this specification must include the name and can include any number of preceding namespace specifications and prefix up to providing the fully qualified label name. If the Scope indicates NAMESPACE, then this specification can include any number of contiguous namespace strings, and can include the entire label namespace prefix from the rule group or web ACL where the label originates. Labels are case sensitive and components of a label must be separated by colon, for example NS1:NS2:name. 1343 */ 1344 Key: LabelMatchKey; 1345 } 1346 export type LabelName = string; 1347 export interface LabelNameCondition { 1348 /** 1349 * The label name that a log record must contain in order to meet the condition. This must be a fully qualified label name. Fully qualified labels have a prefix, optional namespaces, and label name. The prefix identifies the rule group or web ACL context of the rule that added the label. 1350 */ 1351 LabelName: LabelName; 1352 } 1353 export type LabelSummaries = LabelSummary[]; 1354 export interface LabelSummary { 1355 /** 1356 * An individual label specification. 1357 */ 1358 Name?: LabelName; 1359 } 1360 export type Labels = Label[]; 1361 export interface ListAvailableManagedRuleGroupVersionsRequest { 1362 /** 1363 * The name of the managed rule group vendor. You use this, along with the rule group name, to identify the rule group. 1364 */ 1365 VendorName: VendorName; 1366 /** 1367 * The name of the managed rule group. You use this, along with the vendor name, to identify the rule group. 1368 */ 1369 Name: EntityName; 1370 /** 1371 * 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, or an AppSync GraphQL API. To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows: CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1. API and SDKs - For all calls, use the Region endpoint us-east-1. 1372 */ 1373 Scope: Scope; 1374 /** 1375 * When you request a list of objects with a Limit setting, if the number of objects that are still available for retrieval exceeds the limit, WAF returns a NextMarker value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request. 1376 */ 1377 NextMarker?: NextMarker; 1378 /** 1379 * 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 NextMarker value that you can use in a subsequent call to get the next batch of objects. 1380 */ 1381 Limit?: PaginationLimit; 1382 } 1383 export interface ListAvailableManagedRuleGroupVersionsResponse { 1384 /** 1385 * When you request a list of objects with a Limit setting, if the number of objects that are still available for retrieval exceeds the limit, WAF returns a NextMarker value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request. 1386 */ 1387 NextMarker?: NextMarker; 1388 /** 1389 * The versions that are currently available for the specified managed rule group. 1390 */ 1391 Versions?: ManagedRuleGroupVersions; 1392 } 1393 export interface ListAvailableManagedRuleGroupsRequest { 1394 /** 1395 * 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, or an AppSync GraphQL API. To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows: CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1. API and SDKs - For all calls, use the Region endpoint us-east-1. 1396 */ 1397 Scope: Scope; 1398 /** 1399 * When you request a list of objects with a Limit setting, if the number of objects that are still available for retrieval exceeds the limit, WAF returns a NextMarker value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request. 1400 */ 1401 NextMarker?: NextMarker; 1402 /** 1403 * 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 NextMarker value that you can use in a subsequent call to get the next batch of objects. 1404 */ 1405 Limit?: PaginationLimit; 1406 } 1407 export interface ListAvailableManagedRuleGroupsResponse { 1408 /** 1409 * When you request a list of objects with a Limit setting, if the number of objects that are still available for retrieval exceeds the limit, WAF returns a NextMarker value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request. 1410 */ 1411 NextMarker?: NextMarker; 1412 /** 1413 * 1414 */ 1415 ManagedRuleGroups?: ManagedRuleGroupSummaries; 1416 } 1417 export interface ListIPSetsRequest { 1418 /** 1419 * 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, or an AppSync GraphQL API. To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows: CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1. API and SDKs - For all calls, use the Region endpoint us-east-1. 1420 */ 1421 Scope: Scope; 1422 /** 1423 * When you request a list of objects with a Limit setting, if the number of objects that are still available for retrieval exceeds the limit, WAF returns a NextMarker value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request. 1424 */ 1425 NextMarker?: NextMarker; 1426 /** 1427 * 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 NextMarker value that you can use in a subsequent call to get the next batch of objects. 1428 */ 1429 Limit?: PaginationLimit; 1430 } 1431 export interface ListIPSetsResponse { 1432 /** 1433 * When you request a list of objects with a Limit setting, if the number of objects that are still available for retrieval exceeds the limit, WAF returns a NextMarker value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request. 1434 */ 1435 NextMarker?: NextMarker; 1436 /** 1437 * Array of IPSets. This may not be the full list of IPSets that you have defined. See the Limit specification for this request. 1438 */ 1439 IPSets?: IPSetSummaries; 1440 } 1441 export interface ListLoggingConfigurationsRequest { 1442 /** 1443 * 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, or an AppSync GraphQL API. To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows: CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1. API and SDKs - For all calls, use the Region endpoint us-east-1. 1444 */ 1445 Scope?: Scope; 1446 /** 1447 * When you request a list of objects with a Limit setting, if the number of objects that are still available for retrieval exceeds the limit, WAF returns a NextMarker value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request. 1448 */ 1449 NextMarker?: NextMarker; 1450 /** 1451 * 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 NextMarker value that you can use in a subsequent call to get the next batch of objects. 1452 */ 1453 Limit?: PaginationLimit; 1454 } 1455 export interface ListLoggingConfigurationsResponse { 1456 /** 1457 * 1458 */ 1459 LoggingConfigurations?: LoggingConfigurations; 1460 /** 1461 * When you request a list of objects with a Limit setting, if the number of objects that are still available for retrieval exceeds the limit, WAF returns a NextMarker value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request. 1462 */ 1463 NextMarker?: NextMarker; 1464 } 1465 export interface ListManagedRuleSetsRequest { 1466 /** 1467 * 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, or an AppSync GraphQL API. To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows: CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1. API and SDKs - For all calls, use the Region endpoint us-east-1. 1468 */ 1469 Scope: Scope; 1470 /** 1471 * When you request a list of objects with a Limit setting, if the number of objects that are still available for retrieval exceeds the limit, WAF returns a NextMarker value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request. 1472 */ 1473 NextMarker?: NextMarker; 1474 /** 1475 * 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 NextMarker value that you can use in a subsequent call to get the next batch of objects. 1476 */ 1477 Limit?: PaginationLimit; 1478 } 1479 export interface ListManagedRuleSetsResponse { 1480 /** 1481 * When you request a list of objects with a Limit setting, if the number of objects that are still available for retrieval exceeds the limit, WAF returns a NextMarker value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request. 1482 */ 1483 NextMarker?: NextMarker; 1484 /** 1485 * Your managed rule sets. 1486 */ 1487 ManagedRuleSets?: ManagedRuleSetSummaries; 1488 } 1489 export type ListMaxItems = number; 1490 export interface ListRegexPatternSetsRequest { 1491 /** 1492 * 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, or an AppSync GraphQL API. To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows: CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1. API and SDKs - For all calls, use the Region endpoint us-east-1. 1493 */ 1494 Scope: Scope; 1495 /** 1496 * When you request a list of objects with a Limit setting, if the number of objects that are still available for retrieval exceeds the limit, WAF returns a NextMarker value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request. 1497 */ 1498 NextMarker?: NextMarker; 1499 /** 1500 * 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 NextMarker value that you can use in a subsequent call to get the next batch of objects. 1501 */ 1502 Limit?: PaginationLimit; 1503 } 1504 export interface ListRegexPatternSetsResponse { 1505 /** 1506 * When you request a list of objects with a Limit setting, if the number of objects that are still available for retrieval exceeds the limit, WAF returns a NextMarker value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request. 1507 */ 1508 NextMarker?: NextMarker; 1509 /** 1510 * 1511 */ 1512 RegexPatternSets?: RegexPatternSetSummaries; 1513 } 1514 export interface ListResourcesForWebACLRequest { 1515 /** 1516 * The Amazon Resource Name (ARN) of the web ACL. 1517 */ 1518 WebACLArn: ResourceArn; 1519 /** 1520 * 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, or an AppSync GraphQL API. 1521 */ 1522 ResourceType?: ResourceType; 1523 } 1524 export interface ListResourcesForWebACLResponse { 1525 /** 1526 * The array of Amazon Resource Names (ARNs) of the associated resources. 1527 */ 1528 ResourceArns?: ResourceArns; 1529 } 1530 export interface ListRuleGroupsRequest { 1531 /** 1532 * 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, or an AppSync GraphQL API. To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows: CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1. API and SDKs - For all calls, use the Region endpoint us-east-1. 1533 */ 1534 Scope: Scope; 1535 /** 1536 * When you request a list of objects with a Limit setting, if the number of objects that are still available for retrieval exceeds the limit, WAF returns a NextMarker value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request. 1537 */ 1538 NextMarker?: NextMarker; 1539 /** 1540 * 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 NextMarker value that you can use in a subsequent call to get the next batch of objects. 1541 */ 1542 Limit?: PaginationLimit; 1543 } 1544 export interface ListRuleGroupsResponse { 1545 /** 1546 * When you request a list of objects with a Limit setting, if the number of objects that are still available for retrieval exceeds the limit, WAF returns a NextMarker value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request. 1547 */ 1548 NextMarker?: NextMarker; 1549 /** 1550 * 1551 */ 1552 RuleGroups?: RuleGroupSummaries; 1553 } 1554 export interface ListTagsForResourceRequest { 1555 /** 1556 * When you request a list of objects with a Limit setting, if the number of objects that are still available for retrieval exceeds the limit, WAF returns a NextMarker value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request. 1557 */ 1558 NextMarker?: NextMarker; 1559 /** 1560 * 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 NextMarker value that you can use in a subsequent call to get the next batch of objects. 1561 */ 1562 Limit?: PaginationLimit; 1563 /** 1564 * The Amazon Resource Name (ARN) of the resource. 1565 */ 1566 ResourceARN: ResourceArn; 1567 } 1568 export interface ListTagsForResourceResponse { 1569 /** 1570 * When you request a list of objects with a Limit setting, if the number of objects that are still available for retrieval exceeds the limit, WAF returns a NextMarker value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request. 1571 */ 1572 NextMarker?: NextMarker; 1573 /** 1574 * The collection of tagging definitions for the resource. 1575 */ 1576 TagInfoForResource?: TagInfoForResource; 1577 } 1578 export interface ListWebACLsRequest { 1579 /** 1580 * 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, or an AppSync GraphQL API. To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows: CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1. API and SDKs - For all calls, use the Region endpoint us-east-1. 1581 */ 1582 Scope: Scope; 1583 /** 1584 * When you request a list of objects with a Limit setting, if the number of objects that are still available for retrieval exceeds the limit, WAF returns a NextMarker value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request. 1585 */ 1586 NextMarker?: NextMarker; 1587 /** 1588 * 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 NextMarker value that you can use in a subsequent call to get the next batch of objects. 1589 */ 1590 Limit?: PaginationLimit; 1591 } 1592 export interface ListWebACLsResponse { 1593 /** 1594 * When you request a list of objects with a Limit setting, if the number of objects that are still available for retrieval exceeds the limit, WAF returns a NextMarker value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request. 1595 */ 1596 NextMarker?: NextMarker; 1597 /** 1598 * 1599 */ 1600 WebACLs?: WebACLSummaries; 1601 } 1602 export type LockToken = string; 1603 export type LogDestinationConfigs = ResourceArn[]; 1604 export interface LoggingConfiguration { 1605 /** 1606 * The Amazon Resource Name (ARN) of the web ACL that you want to associate with LogDestinationConfigs. 1607 */ 1608 ResourceArn: ResourceArn; 1609 /** 1610 * The Amazon Kinesis Data Firehose Amazon Resource Name (ARNs) that you want to associate with the web ACL. 1611 */ 1612 LogDestinationConfigs: LogDestinationConfigs; 1613 /** 1614 * The parts of the request that you want to keep out of the logs. For example, if you redact the HEADER field, the HEADER field in the firehose will be xxx. You must use one of the following values: URI, QUERY_STRING, HEADER, or METHOD. 1615 */ 1616 RedactedFields?: RedactedFields; 1617 /** 1618 * 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. 1619 */ 1620 ManagedByFirewallManager?: Boolean; 1621 /** 1622 * Filtering that specifies which web requests are kept in the logs and which are dropped. You can filter on the rule action and on the web request labels that were applied by matching rules during web ACL evaluation. 1623 */ 1624 LoggingFilter?: LoggingFilter; 1625 } 1626 export type LoggingConfigurations = LoggingConfiguration[]; 1627 export interface LoggingFilter { 1628 /** 1629 * The filters that you want to apply to the logs. 1630 */ 1631 Filters: Filters; 1632 /** 1633 * Default handling for logs that don't match any of the specified filtering conditions. 1634 */ 1635 DefaultBehavior: FilterBehavior; 1636 } 1637 export interface ManagedRuleGroupStatement { 1638 /** 1639 * The name of the managed rule group vendor. You use this, along with the rule group name, to identify the rule group. 1640 */ 1641 VendorName: VendorName; 1642 /** 1643 * The name of the managed rule group. You use this, along with the vendor name, to identify the rule group. 1644 */ 1645 Name: EntityName; 1646 /** 1647 * The version of the managed rule group to use. If you specify this, the version setting is fixed until you change it. If you don't specify this, WAF uses the vendor's default version, and then keeps the version at the vendor's default when the vendor updates the managed rule group settings. 1648 */ 1649 Version?: VersionKeyString; 1650 /** 1651 * The rules whose actions are set to COUNT by the web ACL, regardless of the action that is set on the rule. This effectively excludes the rule from acting on web requests. 1652 */ 1653 ExcludedRules?: ExcludedRules; 1654 /** 1655 * An optional nested statement that narrows the scope of the web requests that are evaluated by the managed rule group. Requests are only evaluated by the rule group if they match the scope-down statement. You can use any nestable Statement in the scope-down statement, and you can nest statements at any level, the same as you can for a rule statement. 1656 */ 1657 ScopeDownStatement?: Statement; 1658 } 1659 export type ManagedRuleGroupSummaries = ManagedRuleGroupSummary[]; 1660 export interface ManagedRuleGroupSummary { 1661 /** 1662 * The name of the managed rule group vendor. You use this, along with the rule group name, to identify the rule group. 1663 */ 1664 VendorName?: VendorName; 1665 /** 1666 * The name of the managed rule group. You use this, along with the vendor name, to identify the rule group. 1667 */ 1668 Name?: EntityName; 1669 /** 1670 * The description of the managed rule group, provided by Amazon Web Services Managed Rules or the Marketplace seller who manages it. 1671 */ 1672 Description?: EntityDescription; 1673 } 1674 export interface ManagedRuleGroupVersion { 1675 /** 1676 * The version name. 1677 */ 1678 Name?: VersionKeyString; 1679 /** 1680 * The date and time that the managed rule group owner updated the rule group version information. 1681 */ 1682 LastUpdateTimestamp?: Timestamp; 1683 } 1684 export type ManagedRuleGroupVersions = ManagedRuleGroupVersion[]; 1685 export interface ManagedRuleSet { 1686 /** 1687 * The name of the managed rule set. You use this, along with the rule set ID, to identify the rule set. This name is assigned to the corresponding managed rule group, which your customers can access and use. 1688 */ 1689 Name: EntityName; 1690 /** 1691 * A unique identifier for the managed rule set. The ID is returned in the responses to commands like list. You provide it to operations like get and update. 1692 */ 1693 Id: EntityId; 1694 /** 1695 * The Amazon Resource Name (ARN) of the entity. 1696 */ 1697 ARN: ResourceArn; 1698 /** 1699 * A description of the set that helps with identification. 1700 */ 1701 Description?: EntityDescription; 1702 /** 1703 * The versions of this managed rule set that are available for use by customers. 1704 */ 1705 PublishedVersions?: PublishedVersions; 1706 /** 1707 * The version that you would like your customers to use. 1708 */ 1709 RecommendedVersion?: VersionKeyString; 1710 /** 1711 * The label namespace prefix for the managed rule groups that are offered to customers from this managed rule set. All labels that are added by rules in the managed rule group have this prefix. The syntax for the label namespace prefix for a managed rule group is the following: awswaf:managed:<vendor>:<rule group name>: When a rule with a label matches a web request, WAF adds the fully qualified label to the request. A fully qualified label is made up of the label namespace from the rule group or web ACL where the rule is defined and the label from the rule, separated by a colon: <label namespace>:<label from rule> 1712 */ 1713 LabelNamespace?: LabelName; 1714 } 1715 export type ManagedRuleSetSummaries = ManagedRuleSetSummary[]; 1716 export interface ManagedRuleSetSummary { 1717 /** 1718 * The name of the managed rule set. You use this, along with the rule set ID, to identify the rule set. This name is assigned to the corresponding managed rule group, which your customers can access and use. 1719 */ 1720 Name?: EntityName; 1721 /** 1722 * A unique identifier for the managed rule set. The ID is returned in the responses to commands like list. You provide it to operations like get and update. 1723 */ 1724 Id?: EntityId; 1725 /** 1726 * A description of the set that helps with identification. 1727 */ 1728 Description?: EntityDescription; 1729 /** 1730 * A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation. 1731 */ 1732 LockToken?: LockToken; 1733 /** 1734 * The Amazon Resource Name (ARN) of the entity. 1735 */ 1736 ARN?: ResourceArn; 1737 /** 1738 * The label namespace prefix for the managed rule groups that are offered to customers from this managed rule set. All labels that are added by rules in the managed rule group have this prefix. The syntax for the label namespace prefix for a managed rule group is the following: awswaf:managed:<vendor>:<rule group name>: When a rule with a label matches a web request, WAF adds the fully qualified label to the request. A fully qualified label is made up of the label namespace from the rule group or web ACL where the rule is defined and the label from the rule, separated by a colon: <label namespace>:<label from rule> 1739 */ 1740 LabelNamespace?: LabelName; 1741 } 1742 export interface ManagedRuleSetVersion { 1743 /** 1744 * The Amazon Resource Name (ARN) of the vendor rule group that's used to define the published version of your managed rule group. 1745 */ 1746 AssociatedRuleGroupArn?: ResourceArn; 1747 /** 1748 * The web ACL capacity units (WCUs) required for this rule group. 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. The WCU limit for web ACLs is 1,500. 1749 */ 1750 Capacity?: CapacityUnit; 1751 /** 1752 * The amount of time you expect this version of your managed rule group to last, in days. 1753 */ 1754 ForecastedLifetime?: TimeWindowDay; 1755 /** 1756 * The time that you first published this version. Times are in Coordinated Universal Time (UTC) format. UTC format includes the special designator, Z. For example, "2016-09-27T14:50Z". 1757 */ 1758 PublishTimestamp?: Timestamp; 1759 /** 1760 * The last time that you updated this version. Times are in Coordinated Universal Time (UTC) format. UTC format includes the special designator, Z. For example, "2016-09-27T14:50Z". 1761 */ 1762 LastUpdateTimestamp?: Timestamp; 1763 /** 1764 * The time that this version is set to expire. Times are in Coordinated Universal Time (UTC) format. UTC format includes the special designator, Z. For example, "2016-09-27T14:50Z". 1765 */ 1766 ExpiryTimestamp?: Timestamp; 1767 } 1768 export interface Method { 1769 } 1770 export type MetricName = string; 1771 export type NextMarker = string; 1772 export interface NoneAction { 1773 } 1774 export interface NotStatement { 1775 /** 1776 * The statement to negate. You can use any statement that can be nested. 1777 */ 1778 Statement: Statement; 1779 } 1780 export interface OrStatement { 1781 /** 1782 * The statements to combine with OR logic. You can use any statements that can be nested. 1783 */ 1784 Statements: Statements; 1785 } 1786 export interface OverrideAction { 1787 /** 1788 * Override the rule action setting to count. 1789 */ 1790 Count?: CountAction; 1791 /** 1792 * Don't override the rule action setting. 1793 */ 1794 None?: NoneAction; 1795 } 1796 export type PaginationLimit = number; 1797 export type PolicyString = string; 1798 export type PopulationSize = number; 1799 export type PositionalConstraint = "EXACTLY"|"STARTS_WITH"|"ENDS_WITH"|"CONTAINS"|"CONTAINS_WORD"|string; 1800 export type PublishedVersions = {[key: string]: ManagedRuleSetVersion}; 1801 export interface PutLoggingConfigurationRequest { 1802 /** 1803 * 1804 */ 1805 LoggingConfiguration: LoggingConfiguration; 1806 } 1807 export interface PutLoggingConfigurationResponse { 1808 /** 1809 * 1810 */ 1811 LoggingConfiguration?: LoggingConfiguration; 1812 } 1813 export interface PutManagedRuleSetVersionsRequest { 1814 /** 1815 * The name of the managed rule set. You use this, along with the rule set ID, to identify the rule set. This name is assigned to the corresponding managed rule group, which your customers can access and use. 1816 */ 1817 Name: EntityName; 1818 /** 1819 * 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, or an AppSync GraphQL API. To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows: CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1. API and SDKs - For all calls, use the Region endpoint us-east-1. 1820 */ 1821 Scope: Scope; 1822 /** 1823 * A unique identifier for the managed rule set. The ID is returned in the responses to commands like list. You provide it to operations like get and update. 1824 */ 1825 Id: EntityId; 1826 /** 1827 * A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation. 1828 */ 1829 LockToken: LockToken; 1830 /** 1831 * The version of the named managed rule group that you'd like your customers to choose, from among your version offerings. 1832 */ 1833 RecommendedVersion?: VersionKeyString; 1834 /** 1835 * The versions of the named managed rule group that you want to offer to your customers. 1836 */ 1837 VersionsToPublish?: VersionsToPublish; 1838 } 1839 export interface PutManagedRuleSetVersionsResponse { 1840 /** 1841 * A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation. 1842 */ 1843 NextLockToken?: LockToken; 1844 } 1845 export interface PutPermissionPolicyRequest { 1846 /** 1847 * The Amazon Resource Name (ARN) of the RuleGroup to which you want to attach the policy. 1848 */ 1849 ResourceArn: ResourceArn; 1850 /** 1851 * The policy to attach to the specified rule group. The policy specifications must conform to the following: The policy must be composed using IAM Policy version 2012-10-17 or version 2015-01-01. The policy must include specifications for Effect, Action, and Principal. Effect must specify Allow. Action must specify wafv2:CreateWebACL, wafv2:UpdateWebACL, and wafv2:PutFirewallManagerRuleGroups. WAF rejects any extra actions or wildcard actions in the policy. The policy must not include a Resource parameter. For more information, see IAM Policies. 1852 */ 1853 Policy: PolicyString; 1854 } 1855 export interface PutPermissionPolicyResponse { 1856 } 1857 export interface QueryString { 1858 } 1859 export interface RateBasedStatement { 1860 /** 1861 * The limit on requests per 5-minute period for a single originating IP address. If the statement includes a ScopeDownStatement, this limit is applied only to the requests that match the statement. 1862 */ 1863 Limit: RateLimit; 1864 /** 1865 * Setting that indicates how to aggregate the request counts. The options are the following: IP - Aggregate the request counts on the IP address from the web request origin. FORWARDED_IP - Aggregate the request counts on the first IP address in an HTTP header. If you use this, configure the ForwardedIPConfig, to specify the header to use. 1866 */ 1867 AggregateKeyType: RateBasedStatementAggregateKeyType; 1868 /** 1869 * An optional nested statement that narrows the scope of the web requests that are evaluated by the rate-based statement. Requests are only tracked by the rate-based statement if they match the scope-down statement. You can use any nestable Statement in the scope-down statement, and you can nest statements at any level, the same as you can for a rule statement. 1870 */ 1871 ScopeDownStatement?: Statement; 1872 /** 1873 * The configuration for inspecting IP addresses in an HTTP header that you specify, instead of using the IP address that's reported by the web request origin. Commonly, this is the X-Forwarded-For (XFF) header, but you can specify any header name. If the specified header isn't present in the request, WAF doesn't apply the rule to the web request at all. This is required if AggregateKeyType is set to FORWARDED_IP. 1874 */ 1875 ForwardedIPConfig?: ForwardedIPConfig; 1876 } 1877 export type RateBasedStatementAggregateKeyType = "IP"|"FORWARDED_IP"|string; 1878 export interface RateBasedStatementManagedKeysIPSet { 1879 /** 1880 * The version of the IP addresses, either IPV4 or IPV6. 1881 */ 1882 IPAddressVersion?: IPAddressVersion; 1883 /** 1884 * The IP addresses that are currently blocked. 1885 */ 1886 Addresses?: IPAddresses; 1887 } 1888 export type RateLimit = number; 1889 export type RedactedFields = FieldToMatch[]; 1890 export interface Regex { 1891 /** 1892 * The string representing the regular expression. 1893 */ 1894 RegexString?: RegexPatternString; 1895 } 1896 export interface RegexPatternSet { 1897 /** 1898 * The name of the set. You cannot change the name after you create the set. 1899 */ 1900 Name?: EntityName; 1901 /** 1902 * 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. 1903 */ 1904 Id?: EntityId; 1905 /** 1906 * The Amazon Resource Name (ARN) of the entity. 1907 */ 1908 ARN?: ResourceArn; 1909 /** 1910 * A description of the set that helps with identification. 1911 */ 1912 Description?: EntityDescription; 1913 /** 1914 * The regular expression patterns in the set. 1915 */ 1916 RegularExpressionList?: RegularExpressionList; 1917 } 1918 export interface RegexPatternSetReferenceStatement { 1919 /** 1920 * The Amazon Resource Name (ARN) of the RegexPatternSet that this statement references. 1921 */ 1922 ARN: ResourceArn; 1923 /** 1924 * The part of a web request that you want WAF to inspect. For more information, see FieldToMatch. 1925 */ 1926 FieldToMatch: FieldToMatch; 1927 /** 1928 * Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. If you specify one or more transformations in a rule statement, WAF performs all transformations on the content of the request component identified by FieldToMatch, starting from the lowest priority setting, before inspecting the content for a match. 1929 */ 1930 TextTransformations: TextTransformations; 1931 } 1932 export type RegexPatternSetSummaries = RegexPatternSetSummary[]; 1933 export interface RegexPatternSetSummary { 1934 /** 1935 * The name of the data type instance. You cannot change the name after you create the instance. 1936 */ 1937 Name?: EntityName; 1938 /** 1939 * 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. 1940 */ 1941 Id?: EntityId; 1942 /** 1943 * A description of the set that helps with identification. 1944 */ 1945 Description?: EntityDescription; 1946 /** 1947 * A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation. 1948 */ 1949 LockToken?: LockToken; 1950 /** 1951 * The Amazon Resource Name (ARN) of the entity. 1952 */ 1953 ARN?: ResourceArn; 1954 } 1955 export type RegexPatternString = string; 1956 export type RegularExpressionList = Regex[]; 1957 export type ResourceArn = string; 1958 export type ResourceArns = ResourceArn[]; 1959 export type ResourceType = "APPLICATION_LOAD_BALANCER"|"API_GATEWAY"|"APPSYNC"|string; 1960 export type ResponseContent = string; 1961 export type ResponseContentType = "TEXT_PLAIN"|"TEXT_HTML"|"APPLICATION_JSON"|string; 1962 export type ResponseStatusCode = number; 1963 export interface Rule { 1964 /** 1965 * The name of the rule. You can't change the name of a Rule after you create it. 1966 */ 1967 Name: EntityName; 1968 /** 1969 * If you define more than one Rule in a WebACL, WAF evaluates each request against the Rules in order based on the value of Priority. WAF processes rules with lower priority first. The priorities don't need to be consecutive, but they must all be different. 1970 */ 1971 Priority: RulePriority; 1972 /** 1973 * The WAF processing statement for the rule, for example ByteMatchStatement or SizeConstraintStatement. 1974 */ 1975 Statement: Statement; 1976 /** 1977 * The action that WAF should take on a web request when it matches the rule statement. Settings at the web ACL level can override the rule action setting. This is used only for rules whose statements do not reference a rule group. Rule statements that reference a rule group include RuleGroupReferenceStatement and ManagedRuleGroupStatement. You must specify either this Action setting or the rule OverrideAction setting, but not both: If the rule statement does not reference a rule group, use this rule action setting and not the rule override action setting. If the rule statement references a rule group, use the override action setting and not this action setting. 1978 */ 1979 Action?: RuleAction; 1980 /** 1981 * The override action to apply to the rules in a rule group. Used only for rule statements that reference a rule group, like RuleGroupReferenceStatement and ManagedRuleGroupStatement. Set the override action to none to leave the rule actions in effect. Set it to count to only count matches, regardless of the rule action settings. In a Rule, you must specify either this OverrideAction setting or the rule Action setting, but not both: If the rule statement references a rule group, use this override action setting and not the action setting. If the rule statement does not reference a rule group, use the rule action setting and not this rule override action setting. 1982 */ 1983 OverrideAction?: OverrideAction; 1984 /** 1985 * Labels to apply to web requests that match the rule match statement. WAF applies fully qualified labels to matching web requests. A fully qualified label is the concatenation of a label namespace and a rule label. The rule's rule group or web ACL defines the label namespace. Rules that run after this rule in the web ACL can match against these labels using a LabelMatchStatement. For each label, provide a case-sensitive string containing optional namespaces and a label name, according to the following guidelines: Separate each component of the label with a colon. Each namespace or name can have up to 128 characters. You can specify up to 5 namespaces in a label. Don't use the following reserved words in your label specification: aws, waf, managed, rulegroup, webacl, regexpatternset, or ipset. For example, myLabelName or nameSpace1:nameSpace2:myLabelName. 1986 */ 1987 RuleLabels?: Labels; 1988 /** 1989 * Defines and enables Amazon CloudWatch metrics and web request sample collection. 1990 */ 1991 VisibilityConfig: VisibilityConfig; 1992 } 1993 export interface RuleAction { 1994 /** 1995 * Instructs WAF to block the web request. 1996 */ 1997 Block?: BlockAction; 1998 /** 1999 * Instructs WAF to allow the web request. 2000 */ 2001 Allow?: AllowAction; 2002 /** 2003 * Instructs WAF to count the web request and allow it. 2004 */ 2005 Count?: CountAction; 2006 } 2007 export interface RuleGroup { 2008 /** 2009 * The name of the rule group. You cannot change the name of a rule group after you create it. 2010 */ 2011 Name: EntityName; 2012 /** 2013 * 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. 2014 */ 2015 Id: EntityId; 2016 /** 2017 * The web ACL capacity units (WCUs) required for this rule group. 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 CheckCapacity. 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. The WCU limit for web ACLs is 1,500. 2018 */ 2019 Capacity: CapacityUnit; 2020 /** 2021 * The Amazon Resource Name (ARN) of the entity. 2022 */ 2023 ARN: ResourceArn; 2024 /** 2025 * A description of the rule group that helps with identification. 2026 */ 2027 Description?: EntityDescription; 2028 /** 2029 * The Rule statements used to identify the web requests that you want to allow, block, or count. Each rule includes one top-level statement that WAF uses to identify matching web requests, and parameters that govern how WAF handles them. 2030 */ 2031 Rules?: Rules; 2032 /** 2033 * Defines and enables Amazon CloudWatch metrics and web request sample collection. 2034 */ 2035 VisibilityConfig: VisibilityConfig; 2036 /** 2037 * The label namespace prefix for this rule group. All labels added by rules in this rule group have this prefix. The syntax for the label namespace prefix for your rule groups is the following: awswaf:<account ID>:rulegroup:<rule group name>: When a rule with a label matches a web request, WAF adds the fully qualified label to the request. A fully qualified label is made up of the label namespace from the rule group or web ACL where the rule is defined and the label from the rule, separated by a colon: <label namespace>:<label from rule> 2038 */ 2039 LabelNamespace?: LabelName; 2040 /** 2041 * A map of custom response keys and content bodies. When you create a rule with a block action, you can send a custom response to the web request. You define these for the rule group, and then use them in the rules that you define in the rule group. For information about customizing web requests and responses, see Customizing web requests and responses in WAF in the WAF Developer Guide. For information about the limits on count and size for custom request and response settings, see WAF quotas in the WAF Developer Guide. 2042 */ 2043 CustomResponseBodies?: CustomResponseBodies; 2044 /** 2045 * The labels that one or more rules in this rule group add to matching web requests. These labels are defined in the RuleLabels for a Rule. 2046 */ 2047 AvailableLabels?: LabelSummaries; 2048 /** 2049 * The labels that one or more rules in this rule group match against in label match statements. These labels are defined in a LabelMatchStatement specification, in the Statement definition of a rule. 2050 */ 2051 ConsumedLabels?: LabelSummaries; 2052 } 2053 export interface RuleGroupReferenceStatement { 2054 /** 2055 * The Amazon Resource Name (ARN) of the entity. 2056 */ 2057 ARN: ResourceArn; 2058 /** 2059 * The names of rules that are in the referenced rule group, but that you want WAF to exclude from processing for this rule statement. 2060 */ 2061 ExcludedRules?: ExcludedRules; 2062 } 2063 export type RuleGroupSummaries = RuleGroupSummary[]; 2064 export interface RuleGroupSummary { 2065 /** 2066 * The name of the data type instance. You cannot change the name after you create the instance. 2067 */ 2068 Name?: EntityName; 2069 /** 2070 * 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. 2071 */ 2072 Id?: EntityId; 2073 /** 2074 * A description of the rule group that helps with identification. 2075 */ 2076 Description?: EntityDescription; 2077 /** 2078 * A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation. 2079 */ 2080 LockToken?: LockToken; 2081 /** 2082 * The Amazon Resource Name (ARN) of the entity. 2083 */ 2084 ARN?: ResourceArn; 2085 } 2086 export type RulePriority = number; 2087 export type RuleSummaries = RuleSummary[]; 2088 export interface RuleSummary { 2089 /** 2090 * The name of the rule. 2091 */ 2092 Name?: EntityName; 2093 /** 2094 * The action that WAF should take on a web request when it matches a rule's statement. Settings at the web ACL level can override the rule action setting. 2095 */ 2096 Action?: RuleAction; 2097 } 2098 export type Rules = Rule[]; 2099 export type SampleWeight = number; 2100 export interface SampledHTTPRequest { 2101 /** 2102 * A complex type that contains detailed information about the request. 2103 */ 2104 Request: HTTPRequest; 2105 /** 2106 * A value that indicates how one result in the response relates proportionally to other results in the response. For example, a result that has a weight of 2 represents roughly twice as many web requests as a result that has a weight of 1. 2107 */ 2108 Weight: SampleWeight; 2109 /** 2110 * The time at which WAF received the request from your Amazon Web Services resource, in Unix time format (in seconds). 2111 */ 2112 Timestamp?: Timestamp; 2113 /** 2114 * The action for the Rule that the request matched: ALLOW, BLOCK, or COUNT. 2115 */ 2116 Action?: Action; 2117 /** 2118 * The name of the Rule that the request matched. For managed rule groups, the format for this name is <vendor name>#<managed rule group name>#<rule name>. For your own rule groups, the format for this name is <rule group name>#<rule name>. If the rule is not in a rule group, this field is absent. 2119 */ 2120 RuleNameWithinRuleGroup?: EntityName; 2121 /** 2122 * Custom request headers inserted by WAF into the request, according to the custom request configuration for the matching rule action. 2123 */ 2124 RequestHeadersInserted?: HTTPHeaders; 2125 /** 2126 * The response code that was sent for the request. 2127 */ 2128 ResponseCodeSent?: ResponseStatusCode; 2129 /** 2130 * Labels applied to the web request by matching rules. WAF applies fully qualified labels to matching web requests. A fully qualified label is the concatenation of a label namespace and a rule label. The rule's rule group or web ACL defines the label namespace. For example, awswaf:111122223333:myRuleGroup:testRules:testNS1:testNS2:labelNameA or awswaf:managed:aws:managed-rule-set:header:encoding:utf8. 2131 */ 2132 Labels?: Labels; 2133 } 2134 export type SampledHTTPRequests = SampledHTTPRequest[]; 2135 export type Scope = "CLOUDFRONT"|"REGIONAL"|string; 2136 export type SearchString = Buffer|Uint8Array|Blob|string; 2137 export interface SingleHeader { 2138 /** 2139 * The name of the query header to inspect. 2140 */ 2141 Name: FieldToMatchData; 2142 } 2143 export interface SingleQueryArgument { 2144 /** 2145 * The name of the query argument to inspect. 2146 */ 2147 Name: FieldToMatchData; 2148 } 2149 export type Size = number; 2150 export interface SizeConstraintStatement { 2151 /** 2152 * The part of a web request that you want WAF to inspect. For more information, see FieldToMatch. 2153 */ 2154 FieldToMatch: FieldToMatch; 2155 /** 2156 * The operator to use to compare the request part to the size setting. 2157 */ 2158 ComparisonOperator: ComparisonOperator; 2159 /** 2160 * The size, in byte, to compare to the request part, after any transformations. 2161 */ 2162 Size: Size; 2163 /** 2164 * Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. If you specify one or more transformations in a rule statement, WAF performs all transformations on the content of the request component identified by FieldToMatch, starting from the lowest priority setting, before inspecting the content for a match. 2165 */ 2166 TextTransformations: TextTransformations; 2167 } 2168 export interface SqliMatchStatement { 2169 /** 2170 * The part of a web request that you want WAF to inspect. For more information, see FieldToMatch. 2171 */ 2172 FieldToMatch: FieldToMatch; 2173 /** 2174 * Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. If you specify one or more transformations in a rule statement, WAF performs all transformations on the content of the request component identified by FieldToMatch, starting from the lowest priority setting, before inspecting the content for a match. 2175 */ 2176 TextTransformations: TextTransformations; 2177 } 2178 export interface Statement { 2179 /** 2180 * A rule statement that defines a string match search for WAF to apply to web requests. The byte match statement provides the bytes to search for, the location in requests that you want WAF to search, and other settings. The bytes to search for are typically a string that corresponds with ASCII characters. In the WAF console and the developer guide, this is refered to as a string match statement. 2181 */ 2182 ByteMatchStatement?: ByteMatchStatement; 2183 /** 2184 * Attackers sometimes insert malicious SQL code into web requests in an effort to extract data from your database. To allow or block web requests that appear to contain malicious SQL code, create one or more SQL injection match conditions. An SQL injection match condition identifies the part of web requests, such as the URI or the query string, that you want WAF to inspect. Later in the process, when you create a web ACL, you specify whether to allow or block requests that appear to contain malicious SQL code. 2185 */ 2186 SqliMatchStatement?: SqliMatchStatement; 2187 /** 2188 * A rule statement that defines a cross-site scripting (XSS) match search for WAF to apply to web requests. XSS attacks are those where the attacker uses vulnerabilities in a benign website as a vehicle to inject malicious client-site scripts into other legitimate web browsers. The XSS match statement provides the location in requests that you want WAF to search and text transformations to use on the search area before WAF searches for character sequences that are likely to be malicious strings. 2189 */ 2190 XssMatchStatement?: XssMatchStatement; 2191 /** 2192 * A rule statement that compares a number of bytes against the size of a request component, using a comparison operator, such as greater than (>) or less than (<). For example, you can use a size constraint statement to look for query strings that are longer than 100 bytes. If you configure WAF to inspect the request body, WAF inspects only the first 8192 bytes (8 KB). If the request body for your web requests never exceeds 8192 bytes, you can create a size constraint condition and block requests that have a request body greater than 8192 bytes. If you choose URI for the value of Part of the request to filter on, the slash (/) in the URI counts as one character. For example, the URI /logo.jpg is nine characters long. 2193 */ 2194 SizeConstraintStatement?: SizeConstraintStatement; 2195 /** 2196 * A rule statement used to identify web requests based on country of origin. 2197 */ 2198 GeoMatchStatement?: GeoMatchStatement; 2199 /** 2200 * A rule statement used to run the rules that are defined in a RuleGroup. To use this, create a rule group with your rules, then provide the ARN of the rule group in this statement. You cannot nest a RuleGroupReferenceStatement, for example for use inside a NotStatement or OrStatement. It can only be referenced as a top-level statement within a rule. 2201 */ 2202 RuleGroupReferenceStatement?: RuleGroupReferenceStatement; 2203 /** 2204 * A rule statement used to detect web requests coming from particular IP addresses or address ranges. To use this, create an IPSet that specifies the addresses you want to detect, then use the ARN of that set in this statement. To create an IP set, see CreateIPSet. Each IP set rule statement references an IP set. You create and maintain the set independent of your rules. This allows you to use the single set in multiple rules. When you update the referenced set, WAF automatically updates all rules that reference it. 2205 */ 2206 IPSetReferenceStatement?: IPSetReferenceStatement; 2207 /** 2208 * A rule statement used to search web request components for matches with regular expressions. To use this, create a RegexPatternSet that specifies the expressions that you want to detect, then use the ARN of that set in this statement. A web request matches the pattern set rule statement if the request component matches any of the patterns in the set. To create a regex pattern set, see CreateRegexPatternSet. Each regex pattern set rule statement references a regex pattern set. You create and maintain the set independent of your rules. This allows you to use the single set in multiple rules. When you update the referenced set, WAF automatically updates all rules that reference it. 2209 */ 2210 RegexPatternSetReferenceStatement?: RegexPatternSetReferenceStatement; 2211 /** 2212 * A rate-based rule tracks the rate of requests for each originating IP address, and triggers the rule action when the rate exceeds a limit that you specify on the number of requests in any 5-minute time span. You can use this to put a temporary block on requests from an IP address that is sending excessive requests. When the rule action triggers, WAF blocks additional requests from the IP address until the request rate falls below the limit. You can optionally nest another statement inside the rate-based statement, to narrow the scope of the rule so that it only counts requests that match the nested statement. For example, based on recent requests that you have seen from an attacker, you might create a rate-based rule with a nested AND rule statement that contains the following nested statements: An IP match statement with an IP set that specified the address 192.0.2.44. A string match statement that searches in the User-Agent header for the string BadBot. In this rate-based rule, you also define a rate limit. For this example, the rate limit is 1,000. Requests that meet both of the conditions in the statements are counted. If the count exceeds 1,000 requests per five minutes, the rule action triggers. Requests that do not meet both conditions are not counted towards the rate limit and are not affected by this rule. You cannot nest a RateBasedStatement, for example for use inside a NotStatement or OrStatement. It can only be referenced as a top-level statement within a rule. 2213 */ 2214 RateBasedStatement?: RateBasedStatement; 2215 /** 2216 * A logical rule statement used to combine other rule statements with AND logic. You provide more than one Statement within the AndStatement. 2217 */ 2218 AndStatement?: AndStatement; 2219 /** 2220 * A logical rule statement used to combine other rule statements with OR logic. You provide more than one Statement within the OrStatement. 2221 */ 2222 OrStatement?: OrStatement; 2223 /** 2224 * A logical rule statement used to negate the results of another rule statement. You provide one Statement within the NotStatement. 2225 */ 2226 NotStatement?: NotStatement; 2227 /** 2228 * A rule statement used to run the rules that are defined in a managed rule group. To use this, provide the vendor name and the name of the rule group in this statement. You can retrieve the required names by calling ListAvailableManagedRuleGroups. You cannot nest a ManagedRuleGroupStatement, for example for use inside a NotStatement or OrStatement. It can only be referenced as a top-level statement within a rule. 2229 */ 2230 ManagedRuleGroupStatement?: ManagedRuleGroupStatement; 2231 /** 2232 * A rule statement that defines a string match search against labels that have been added to the web request by rules that have already run in the web ACL. The label match statement provides the label or namespace string to search for. The label string can represent a part or all of the fully qualified label name that had been added to the web request. Fully qualified labels have a prefix, optional namespaces, and label name. The prefix identifies the rule group or web ACL context of the rule that added the label. If you do not provide the fully qualified name in your label match string, WAF performs the search for labels that were added in the same context as the label match statement. 2233 */ 2234 LabelMatchStatement?: LabelMatchStatement; 2235 } 2236 export type Statements = Statement[]; 2237 export interface Tag { 2238 /** 2239 * Part of the key:value pair that defines a tag. You can use a tag key to describe a category of information, such as "customer." Tag keys are case-sensitive. 2240 */ 2241 Key: TagKey; 2242 /** 2243 * Part of the key:value pair that defines a tag. You can use a tag value to describe a specific value within a category, such as "companyA" or "companyB." Tag values are case-sensitive. 2244 */ 2245 Value: TagValue; 2246 } 2247 export interface TagInfoForResource { 2248 /** 2249 * The Amazon Resource Name (ARN) of the resource. 2250 */ 2251 ResourceARN?: ResourceArn; 2252 /** 2253 * The array of Tag objects defined for the resource. 2254 */ 2255 TagList?: TagList; 2256 } 2257 export type TagKey = string; 2258 export type TagKeyList = TagKey[]; 2259 export type TagList = Tag[]; 2260 export interface TagResourceRequest { 2261 /** 2262 * The Amazon Resource Name (ARN) of the resource. 2263 */ 2264 ResourceARN: ResourceArn; 2265 /** 2266 * An array of key:value pairs to associate with the resource. 2267 */ 2268 Tags: TagList; 2269 } 2270 export interface TagResourceResponse { 2271 } 2272 export type TagValue = string; 2273 export interface TextTransformation { 2274 /** 2275 * Sets the relative processing order for multiple transformations that are defined for a rule statement. WAF processes all transformations, from lowest priority to highest, before inspecting the transformed content. The priorities don't need to be consecutive, but they must all be different. 2276 */ 2277 Priority: TextTransformationPriority; 2278 /** 2279 * You can specify the following transformation types: BASE64_DECODE - Decode a Base64-encoded string. BASE64_DECODE_EXT - Decode a Base64-encoded string, but use a forgiving implementation that ignores characters that aren't valid. CMD_LINE - Command-line transformations. These are helpful in reducing effectiveness of attackers who inject an operating system command-line command and use unusual formatting to disguise some or all of the command. Delete the following characters: \ " ' ^ Delete spaces before the following characters: / ( Replace the following characters with a space: , ; Replace multiple spaces with one space Convert uppercase letters (A-Z) to lowercase (a-z) COMPRESS_WHITE_SPACE - Replace these characters with a space character (decimal 32): \f, formfeed, decimal 12 \t, tab, decimal 9 \n, newline, decimal 10 \r, carriage return, decimal 13 \v, vertical tab, decimal 11 Non-breaking space, decimal 160 COMPRESS_WHITE_SPACE also replaces multiple spaces with one space. CSS_DECODE - Decode characters that were encoded using CSS 2.x escape rules syndata.html#characters. This function uses up to two bytes in the decoding process, so it can help to uncover ASCII characters that were encoded using CSS encoding that wouldn’t typically be encoded. It's also useful in countering evasion, which is a combination of a backslash and non-hexadecimal characters. For example, ja\vascript for javascript. ESCAPE_SEQ_DECODE - Decode the following ANSI C escape sequences: \a, \b, \f, \n, \r, \t, \v, \\, \?, \', \", \xHH (hexadecimal), \0OOO (octal). Encodings that aren't valid remain in the output. HEX_DECODE - Decode a string of hexadecimal characters into a binary. HTML_ENTITY_DECODE - Replace HTML-encoded characters with unencoded characters. HTML_ENTITY_DECODE performs these operations: Replaces (ampersand)quot; with " Replaces (ampersand)nbsp; with a non-breaking space, decimal 160 Replaces (ampersand)lt; with a "less than" symbol Replaces (ampersand)gt; with > Replaces characters that are represented in hexadecimal format, (ampersand)#xhhhh;, with the corresponding characters Replaces characters that are represented in decimal format, (ampersand)#nnnn;, with the corresponding characters JS_DECODE - Decode JavaScript escape sequences. If a \ u HHHH code is in the full-width ASCII code range of FF01-FF5E, then the higher byte is used to detect and adjust the lower byte. If not, only the lower byte is used and the higher byte is zeroed, causing a possible loss of information. LOWERCASE - Convert uppercase letters (A-Z) to lowercase (a-z). MD5 - Calculate an MD5 hash from the data in the input. The computed hash is in a raw binary form. NONE - Specify NONE if you don't want any text transformations. NORMALIZE_PATH - Remove multiple slashes, directory self-references, and directory back-references that are not at the beginning of the input from an input string. NORMALIZE_PATH_WIN - This is the same as NORMALIZE_PATH, but first converts backslash characters to forward slashes. REMOVE_NULLS - Remove all NULL bytes from the input. REPLACE_COMMENTS - Replace each occurrence of a C-style comment (/* ... *) with a single space. Multiple consecutive occurrences are not compressed. Unterminated comments are also replaced with a space (ASCII 0x20). However, a standalone termination of a comment (*) is not acted upon. REPLACE_NULLS - Replace NULL bytes in the input with space characters (ASCII 0x20). SQL_HEX_DECODE - Decode SQL hex data. Example (0x414243) will be decoded to (ABC). URL_DECODE - Decode a URL-encoded value. URL_DECODE_UNI - Like URL_DECODE, but with support for Microsoft-specific %u encoding. If the code is in the full-width ASCII code range of FF01-FF5E, the higher byte is used to detect and adjust the lower byte. Otherwise, only the lower byte is used and the higher byte is zeroed. UTF8_TO_UNICODE - Convert all UTF-8 character sequences to Unicode. This helps input normalization, and minimizing false-positives and false-negatives for non-English languages. 2280 */ 2281 Type: TextTransformationType; 2282 } 2283 export type TextTransformationPriority = number; 2284 export type TextTransformationType = "NONE"|"COMPRESS_WHITE_SPACE"|"HTML_ENTITY_DECODE"|"LOWERCASE"|"CMD_LINE"|"URL_DECODE"|"BASE64_DECODE"|"HEX_DECODE"|"MD5"|"REPLACE_COMMENTS"|"ESCAPE_SEQ_DECODE"|"SQL_HEX_DECODE"|"CSS_DECODE"|"JS_DECODE"|"NORMALIZE_PATH"|"NORMALIZE_PATH_WIN"|"REMOVE_NULLS"|"REPLACE_NULLS"|"BASE64_DECODE_EXT"|"URL_DECODE_UNI"|"UTF8_TO_UNICODE"|string; 2285 export type TextTransformations = TextTransformation[]; 2286 export interface TimeWindow { 2287 /** 2288 * The beginning of the time range from which you want GetSampledRequests 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, Z. For example, "2016-09-27T14:50Z". You can specify any time range in the previous three hours. 2289 */ 2290 StartTime: Timestamp; 2291 /** 2292 * The end of the time range from which you want GetSampledRequests 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, Z. For example, "2016-09-27T14:50Z". You can specify any time range in the previous three hours. 2293 */ 2294 EndTime: Timestamp; 2295 } 2296 export type TimeWindowDay = number; 2297 export type Timestamp = Date; 2298 export type URIString = string; 2299 export interface UntagResourceRequest { 2300 /** 2301 * The Amazon Resource Name (ARN) of the resource. 2302 */ 2303 ResourceARN: ResourceArn; 2304 /** 2305 * An array of keys identifying the tags to disassociate from the resource. 2306 */ 2307 TagKeys: TagKeyList; 2308 } 2309 export interface UntagResourceResponse { 2310 } 2311 export interface UpdateIPSetRequest { 2312 /** 2313 * The name of the IP set. You cannot change the name of an IPSet after you create it. 2314 */ 2315 Name: EntityName; 2316 /** 2317 * 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, or an AppSync GraphQL API. To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows: CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1. API and SDKs - For all calls, use the Region endpoint us-east-1. 2318 */ 2319 Scope: Scope; 2320 /** 2321 * 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. 2322 */ 2323 Id: EntityId; 2324 /** 2325 * A description of the IP set that helps with identification. 2326 */ 2327 Description?: EntityDescription; 2328 /** 2329 * Contains an array of strings that specify one or more IP addresses or blocks of IP addresses in Classless Inter-Domain Routing (CIDR) notation. WAF supports all IPv4 and IPv6 CIDR ranges except for /0. Examples: To configure WAF to allow, block, or count requests that originated from the IP address 192.0.2.44, specify 192.0.2.44/32. 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 192.0.2.0/24. To configure WAF to allow, block, or count requests that originated from the IP address 1111:0000:0000:0000:0000:0000:0000:0111, specify 1111:0000:0000:0000:0000:0000:0000:0111/128. 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 1111:0000:0000:0000:0000:0000:0000:0000/64. For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing. 2330 */ 2331 Addresses: IPAddresses; 2332 /** 2333 * A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation. 2334 */ 2335 LockToken: LockToken; 2336 } 2337 export interface UpdateIPSetResponse { 2338 /** 2339 * A token used for optimistic locking. WAF returns this token to your update requests. You use NextLockToken in the same manner as you use LockToken. 2340 */ 2341 NextLockToken?: LockToken; 2342 } 2343 export interface UpdateManagedRuleSetVersionExpiryDateRequest { 2344 /** 2345 * The name of the managed rule set. You use this, along with the rule set ID, to identify the rule set. This name is assigned to the corresponding managed rule group, which your customers can access and use. 2346 */ 2347 Name: EntityName; 2348 /** 2349 * 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, or an AppSync GraphQL API. To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows: CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1. API and SDKs - For all calls, use the Region endpoint us-east-1. 2350 */ 2351 Scope: Scope; 2352 /** 2353 * A unique identifier for the managed rule set. The ID is returned in the responses to commands like list. You provide it to operations like get and update. 2354 */ 2355 Id: EntityId; 2356 /** 2357 * A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation. 2358 */ 2359 LockToken: LockToken; 2360 /** 2361 * The version that you want to remove from your list of offerings for the named managed rule group. 2362 */ 2363 VersionToExpire: VersionKeyString; 2364 /** 2365 * The time that you want the version to expire. Times are in Coordinated Universal Time (UTC) format. UTC format includes the special designator, Z. For example, "2016-09-27T14:50Z". 2366 */ 2367 ExpiryTimestamp: Timestamp; 2368 } 2369 export interface UpdateManagedRuleSetVersionExpiryDateResponse { 2370 /** 2371 * The version that is set to expire. 2372 */ 2373 ExpiringVersion?: VersionKeyString; 2374 /** 2375 * The time that the version will expire. Times are in Coordinated Universal Time (UTC) format. UTC format includes the special designator, Z. For example, "2016-09-27T14:50Z". 2376 */ 2377 ExpiryTimestamp?: Timestamp; 2378 /** 2379 * A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation. 2380 */ 2381 NextLockToken?: LockToken; 2382 } 2383 export interface UpdateRegexPatternSetRequest { 2384 /** 2385 * The name of the set. You cannot change the name after you create the set. 2386 */ 2387 Name: EntityName; 2388 /** 2389 * 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, or an AppSync GraphQL API. To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows: CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1. API and SDKs - For all calls, use the Region endpoint us-east-1. 2390 */ 2391 Scope: Scope; 2392 /** 2393 * 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. 2394 */ 2395 Id: EntityId; 2396 /** 2397 * A description of the set that helps with identification. 2398 */ 2399 Description?: EntityDescription; 2400 /** 2401 * 2402 */ 2403 RegularExpressionList: RegularExpressionList; 2404 /** 2405 * A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation. 2406 */ 2407 LockToken: LockToken; 2408 } 2409 export interface UpdateRegexPatternSetResponse { 2410 /** 2411 * A token used for optimistic locking. WAF returns this token to your update requests. You use NextLockToken in the same manner as you use LockToken. 2412 */ 2413 NextLockToken?: LockToken; 2414 } 2415 export interface UpdateRuleGroupRequest { 2416 /** 2417 * The name of the rule group. You cannot change the name of a rule group after you create it. 2418 */ 2419 Name: EntityName; 2420 /** 2421 * 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, or an AppSync GraphQL API. To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows: CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1. API and SDKs - For all calls, use the Region endpoint us-east-1. 2422 */ 2423 Scope: Scope; 2424 /** 2425 * 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. 2426 */ 2427 Id: EntityId; 2428 /** 2429 * A description of the rule group that helps with identification. 2430 */ 2431 Description?: EntityDescription; 2432 /** 2433 * The Rule statements used to identify the web requests that you want to allow, block, or count. Each rule includes one top-level statement that WAF uses to identify matching web requests, and parameters that govern how WAF handles them. 2434 */ 2435 Rules?: Rules; 2436 /** 2437 * Defines and enables Amazon CloudWatch metrics and web request sample collection. 2438 */ 2439 VisibilityConfig: VisibilityConfig; 2440 /** 2441 * A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation. 2442 */ 2443 LockToken: LockToken; 2444 /** 2445 * A map of custom response keys and content bodies. When you create a rule with a block action, you can send a custom response to the web request. You define these for the rule group, and then use them in the rules that you define in the rule group. For information about customizing web requests and responses, see Customizing web requests and responses in WAF in the WAF Developer Guide. For information about the limits on count and size for custom request and response settings, see WAF quotas in the WAF Developer Guide. 2446 */ 2447 CustomResponseBodies?: CustomResponseBodies; 2448 } 2449 export interface UpdateRuleGroupResponse { 2450 /** 2451 * A token used for optimistic locking. WAF returns this token to your update requests. You use NextLockToken in the same manner as you use LockToken. 2452 */ 2453 NextLockToken?: LockToken; 2454 } 2455 export interface UpdateWebACLRequest { 2456 /** 2457 * The name of the web ACL. You cannot change the name of a web ACL after you create it. 2458 */ 2459 Name: EntityName; 2460 /** 2461 * 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, or an AppSync GraphQL API. To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows: CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1. API and SDKs - For all calls, use the Region endpoint us-east-1. 2462 */ 2463 Scope: Scope; 2464 /** 2465 * 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. 2466 */ 2467 Id: EntityId; 2468 /** 2469 * The action to perform if none of the Rules contained in the WebACL match. 2470 */ 2471 DefaultAction: DefaultAction; 2472 /** 2473 * A description of the web ACL that helps with identification. 2474 */ 2475 Description?: EntityDescription; 2476 /** 2477 * The Rule statements used to identify the web requests that you want to allow, block, or count. Each rule includes one top-level statement that WAF uses to identify matching web requests, and parameters that govern how WAF handles them. 2478 */ 2479 Rules?: Rules; 2480 /** 2481 * Defines and enables Amazon CloudWatch metrics and web request sample collection. 2482 */ 2483 VisibilityConfig: VisibilityConfig; 2484 /** 2485 * A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation. 2486 */ 2487 LockToken: LockToken; 2488 /** 2489 * 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. For information about customizing web requests and responses, see Customizing web requests and responses in WAF in the WAF Developer Guide. For information about the limits on count and size for custom request and response settings, see WAF quotas in the WAF Developer Guide. 2490 */ 2491 CustomResponseBodies?: CustomResponseBodies; 2492 } 2493 export interface UpdateWebACLResponse { 2494 /** 2495 * A token used for optimistic locking. WAF returns this token to your update requests. You use NextLockToken in the same manner as you use LockToken. 2496 */ 2497 NextLockToken?: LockToken; 2498 } 2499 export interface UriPath { 2500 } 2501 export type VendorName = string; 2502 export type VersionKeyString = string; 2503 export interface VersionToPublish { 2504 /** 2505 * The Amazon Resource Name (ARN) of the vendor's rule group that's used in the published managed rule group version. 2506 */ 2507 AssociatedRuleGroupArn?: ResourceArn; 2508 /** 2509 * The amount of time the vendor expects this version of the managed rule group to last, in days. 2510 */ 2511 ForecastedLifetime?: TimeWindowDay; 2512 } 2513 export type VersionsToPublish = {[key: string]: VersionToPublish}; 2514 export interface VisibilityConfig { 2515 /** 2516 * A boolean indicating whether WAF should store a sampling of the web requests that match the rules. You can view the sampled requests through the WAF console. 2517 */ 2518 SampledRequestsEnabled: Boolean; 2519 /** 2520 * A boolean indicating whether the associated resource sends metrics to Amazon CloudWatch. For the list of available metrics, see WAF Metrics. 2521 */ 2522 CloudWatchMetricsEnabled: Boolean; 2523 /** 2524 * A name of the Amazon CloudWatch metric. The name can contain only the characters: A-Z, a-z, 0-9, - (hyphen), and _ (underscore). The name can be from one to 128 characters long. It can't contain whitespace or metric names reserved for WAF, for example "All" and "Default_Action." 2525 */ 2526 MetricName: MetricName; 2527 } 2528 export interface WebACL { 2529 /** 2530 * The name of the web ACL. You cannot change the name of a web ACL after you create it. 2531 */ 2532 Name: EntityName; 2533 /** 2534 * A unique identifier for the WebACL. This ID is returned in the responses to create and list commands. You use this ID to do things like get, update, and delete a WebACL. 2535 */ 2536 Id: EntityId; 2537 /** 2538 * The Amazon Resource Name (ARN) of the web ACL that you want to associate with the resource. 2539 */ 2540 ARN: ResourceArn; 2541 /** 2542 * The action to perform if none of the Rules contained in the WebACL match. 2543 */ 2544 DefaultAction: DefaultAction; 2545 /** 2546 * A description of the web ACL that helps with identification. 2547 */ 2548 Description?: EntityDescription; 2549 /** 2550 * The Rule statements used to identify the web requests that you want to allow, block, or count. Each rule includes one top-level statement that WAF uses to identify matching web requests, and parameters that govern how WAF handles them. 2551 */ 2552 Rules?: Rules; 2553 /** 2554 * Defines and enables Amazon CloudWatch metrics and web request sample collection. 2555 */ 2556 VisibilityConfig: VisibilityConfig; 2557 /** 2558 * The web ACL capacity units (WCUs) currently being used by this web ACL. 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. The WCU limit for web ACLs is 1,500. 2559 */ 2560 Capacity?: ConsumedCapacity; 2561 /** 2562 * The first set of rules for WAF to process in the web ACL. This is defined in an Firewall Manager WAF policy and contains only rule group references. You can't alter these. Any rules and rule groups that you define for the web ACL are prioritized after these. In the Firewall Manager WAF policy, the Firewall Manager administrator can define a set of rule groups to run first in the web ACL and a set of rule groups to run last. Within each set, the administrator prioritizes the rule groups, to determine their relative processing order. 2563 */ 2564 PreProcessFirewallManagerRuleGroups?: FirewallManagerRuleGroups; 2565 /** 2566 * The last set of rules for WAF to process in the web ACL. This is defined in an Firewall Manager WAF policy and contains only rule group references. You can't alter these. Any rules and rule groups that you define for the web ACL are prioritized before these. In the Firewall Manager WAF policy, the Firewall Manager administrator can define a set of rule groups to run first in the web ACL and a set of rule groups to run last. Within each set, the administrator prioritizes the rule groups, to determine their relative processing order. 2567 */ 2568 PostProcessFirewallManagerRuleGroups?: FirewallManagerRuleGroups; 2569 /** 2570 * Indicates whether this web ACL is managed by Firewall Manager. If true, then only Firewall Manager can delete the web ACL or any Firewall Manager rule groups in the web ACL. 2571 */ 2572 ManagedByFirewallManager?: Boolean; 2573 /** 2574 * The label namespace prefix for this web ACL. All labels added by rules in this web ACL have this prefix. The syntax for the label namespace prefix for a web ACL is the following: awswaf:<account ID>:webacl:<web ACL name>: When a rule with a label matches a web request, WAF adds the fully qualified label to the request. A fully qualified label is made up of the label namespace from the rule group or web ACL where the rule is defined and the label from the rule, separated by a colon: <label namespace>:<label from rule> 2575 */ 2576 LabelNamespace?: LabelName; 2577 /** 2578 * 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. For information about customizing web requests and responses, see Customizing web requests and responses in WAF in the WAF Developer Guide. For information about the limits on count and size for custom request and response settings, see WAF quotas in the WAF Developer Guide. 2579 */ 2580 CustomResponseBodies?: CustomResponseBodies; 2581 } 2582 export type WebACLSummaries = WebACLSummary[]; 2583 export interface WebACLSummary { 2584 /** 2585 * The name of the web ACL. You cannot change the name of a web ACL after you create it. 2586 */ 2587 Name?: EntityName; 2588 /** 2589 * 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. 2590 */ 2591 Id?: EntityId; 2592 /** 2593 * A description of the web ACL that helps with identification. 2594 */ 2595 Description?: EntityDescription; 2596 /** 2597 * A token used for optimistic locking. WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation. 2598 */ 2599 LockToken?: LockToken; 2600 /** 2601 * The Amazon Resource Name (ARN) of the entity. 2602 */ 2603 ARN?: ResourceArn; 2604 } 2605 export interface XssMatchStatement { 2606 /** 2607 * The part of a web request that you want WAF to inspect. For more information, see FieldToMatch. 2608 */ 2609 FieldToMatch: FieldToMatch; 2610 /** 2611 * Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. If you specify one or more transformations in a rule statement, WAF performs all transformations on the content of the request component identified by FieldToMatch, starting from the lowest priority setting, before inspecting the content for a match. 2612 */ 2613 TextTransformations: TextTransformations; 2614 } 2615 /** 2616 * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. 2617 */ 2618 export type apiVersion = "2019-07-29"|"latest"|string; 2619 export interface ClientApiVersions { 2620 /** 2621 * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. 2622 */ 2623 apiVersion?: apiVersion; 2624 } 2625 export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions; 2626 /** 2627 * Contains interfaces for use with the WAFV2 client. 2628 */ 2629 export import Types = WAFV2; 2630 } 2631 export = WAFV2;