Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
- Operations
- AssociateWebACL
- CheckCapacity
- CreateIPSet
- CreateRegexPatternSet
- CreateRuleGroup
- CreateWebACL
- DeleteFirewallManagerRuleGroups
- DeleteIPSet
- DeleteLoggingConfiguration
- DeletePermissionPolicy
- DeleteRegexPatternSet
- DeleteRuleGroup
- DeleteWebACL
- DescribeManagedRuleGroup
- DisassociateWebACL
- GenerateMobileSdkReleaseUrl
- GetIPSet
- GetLoggingConfiguration
- GetManagedRuleSet
- GetMobileSdkRelease
- GetPermissionPolicy
- GetRateBasedStatementManagedKeys
- GetRegexPatternSet
- GetRuleGroup
- GetSampledRequests
- GetWebACL
- GetWebACLForResource
- ListAvailableManagedRuleGroupVersions
- ListAvailableManagedRuleGroups
- ListIPSets
- ListLoggingConfigurations
- ListManagedRuleSets
- ListMobileSdkReleases
- ListRegexPatternSets
- ListResourcesForWebACL
- ListRuleGroups
- ListTagsForResource
- ListWebACLs
- PutLoggingConfiguration
- PutManagedRuleSetVersions
- PutPermissionPolicy
- TagResource
- UntagResource
- UpdateIPSet
- UpdateManagedRuleSetVersionExpiryDate
- UpdateRegexPatternSet
- UpdateRuleGroup
- UpdateWebACL
- Types
- AWSManagedRulesBotControlRuleSet
- ActionCondition
- All
- AllQueryArguments
- AllowAction
- AndStatement
- BlockAction
- Body
- ByteMatchStatement
- CaptchaAction
- CaptchaConfig
- CaptchaResponse
- ChallengeAction
- ChallengeConfig
- ChallengeResponse
- Condition
- CookieMatchPattern
- Cookies
- CountAction
- CustomHTTPHeader
- CustomRequestHandling
- CustomResponse
- CustomResponseBody
- DefaultAction
- ExcludedRule
- FieldToMatch
- Filter
- FirewallManagerRuleGroup
- FirewallManagerStatement
- ForwardedIPConfig
- GeoMatchStatement
- HTTPHeader
- HTTPRequest
- HeaderMatchPattern
- Headers
- IPSet
- IPSetForwardedIPConfig
- IPSetReferenceStatement
- IPSetSummary
- ImmunityTimeProperty
- JsonBody
- JsonMatchPattern
- Label
- LabelMatchStatement
- LabelNameCondition
- LabelSummary
- LoggingConfiguration
- LoggingFilter
- ManagedRuleGroupConfig
- ManagedRuleGroupStatement
- ManagedRuleGroupSummary
- ManagedRuleGroupVersion
- ManagedRuleSet
- ManagedRuleSetSummary
- ManagedRuleSetVersion
- Method
- MobileSdkRelease
- NoneAction
- NotStatement
- OrStatement
- OverrideAction
- PasswordField
- QueryString
- RateBasedStatement
- RateBasedStatementManagedKeysIPSet
- Regex
- RegexMatchStatement
- RegexPatternSet
- RegexPatternSetReferenceStatement
- RegexPatternSetSummary
- ReleaseSummary
- Rule
- RuleAction
- RuleActionOverride
- RuleGroup
- RuleGroupReferenceStatement
- RuleGroupSummary
- RuleSummary
- SampledHTTPRequest
- SingleHeader
- SingleQueryArgument
- SizeConstraintStatement
- SqliMatchStatement
- Statement
- Tag
- TagInfoForResource
- TextTransformation
- TimeWindow
- UriPath
- UsernameField
- VersionToPublish
- VisibilityConfig
- WebACL
- WebACLSummary
- XssMatchStatement
Synopsis
- associateWebACL_webACLArn :: Lens' AssociateWebACL Text
- associateWebACL_resourceArn :: Lens' AssociateWebACL Text
- associateWebACLResponse_httpStatus :: Lens' AssociateWebACLResponse Int
- checkCapacity_scope :: Lens' CheckCapacity Scope
- checkCapacity_rules :: Lens' CheckCapacity [Rule]
- checkCapacityResponse_capacity :: Lens' CheckCapacityResponse (Maybe Natural)
- checkCapacityResponse_httpStatus :: Lens' CheckCapacityResponse Int
- createIPSet_description :: Lens' CreateIPSet (Maybe Text)
- createIPSet_tags :: Lens' CreateIPSet (Maybe (NonEmpty Tag))
- createIPSet_name :: Lens' CreateIPSet Text
- createIPSet_scope :: Lens' CreateIPSet Scope
- createIPSet_iPAddressVersion :: Lens' CreateIPSet IPAddressVersion
- createIPSet_addresses :: Lens' CreateIPSet [Text]
- createIPSetResponse_summary :: Lens' CreateIPSetResponse (Maybe IPSetSummary)
- createIPSetResponse_httpStatus :: Lens' CreateIPSetResponse Int
- createRegexPatternSet_description :: Lens' CreateRegexPatternSet (Maybe Text)
- createRegexPatternSet_tags :: Lens' CreateRegexPatternSet (Maybe (NonEmpty Tag))
- createRegexPatternSet_name :: Lens' CreateRegexPatternSet Text
- createRegexPatternSet_scope :: Lens' CreateRegexPatternSet Scope
- createRegexPatternSet_regularExpressionList :: Lens' CreateRegexPatternSet [Regex]
- createRegexPatternSetResponse_summary :: Lens' CreateRegexPatternSetResponse (Maybe RegexPatternSetSummary)
- createRegexPatternSetResponse_httpStatus :: Lens' CreateRegexPatternSetResponse Int
- createRuleGroup_customResponseBodies :: Lens' CreateRuleGroup (Maybe (HashMap Text CustomResponseBody))
- createRuleGroup_description :: Lens' CreateRuleGroup (Maybe Text)
- createRuleGroup_rules :: Lens' CreateRuleGroup (Maybe [Rule])
- createRuleGroup_tags :: Lens' CreateRuleGroup (Maybe (NonEmpty Tag))
- createRuleGroup_name :: Lens' CreateRuleGroup Text
- createRuleGroup_scope :: Lens' CreateRuleGroup Scope
- createRuleGroup_capacity :: Lens' CreateRuleGroup Natural
- createRuleGroup_visibilityConfig :: Lens' CreateRuleGroup VisibilityConfig
- createRuleGroupResponse_summary :: Lens' CreateRuleGroupResponse (Maybe RuleGroupSummary)
- createRuleGroupResponse_httpStatus :: Lens' CreateRuleGroupResponse Int
- createWebACL_captchaConfig :: Lens' CreateWebACL (Maybe CaptchaConfig)
- createWebACL_challengeConfig :: Lens' CreateWebACL (Maybe ChallengeConfig)
- createWebACL_customResponseBodies :: Lens' CreateWebACL (Maybe (HashMap Text CustomResponseBody))
- createWebACL_description :: Lens' CreateWebACL (Maybe Text)
- createWebACL_rules :: Lens' CreateWebACL (Maybe [Rule])
- createWebACL_tags :: Lens' CreateWebACL (Maybe (NonEmpty Tag))
- createWebACL_tokenDomains :: Lens' CreateWebACL (Maybe (NonEmpty Text))
- createWebACL_name :: Lens' CreateWebACL Text
- createWebACL_scope :: Lens' CreateWebACL Scope
- createWebACL_defaultAction :: Lens' CreateWebACL DefaultAction
- createWebACL_visibilityConfig :: Lens' CreateWebACL VisibilityConfig
- createWebACLResponse_summary :: Lens' CreateWebACLResponse (Maybe WebACLSummary)
- createWebACLResponse_httpStatus :: Lens' CreateWebACLResponse Int
- deleteFirewallManagerRuleGroups_webACLArn :: Lens' DeleteFirewallManagerRuleGroups Text
- deleteFirewallManagerRuleGroups_webACLLockToken :: Lens' DeleteFirewallManagerRuleGroups Text
- deleteFirewallManagerRuleGroupsResponse_nextWebACLLockToken :: Lens' DeleteFirewallManagerRuleGroupsResponse (Maybe Text)
- deleteFirewallManagerRuleGroupsResponse_httpStatus :: Lens' DeleteFirewallManagerRuleGroupsResponse Int
- deleteIPSet_name :: Lens' DeleteIPSet Text
- deleteIPSet_scope :: Lens' DeleteIPSet Scope
- deleteIPSet_id :: Lens' DeleteIPSet Text
- deleteIPSet_lockToken :: Lens' DeleteIPSet Text
- deleteIPSetResponse_httpStatus :: Lens' DeleteIPSetResponse Int
- deleteLoggingConfiguration_resourceArn :: Lens' DeleteLoggingConfiguration Text
- deleteLoggingConfigurationResponse_httpStatus :: Lens' DeleteLoggingConfigurationResponse Int
- deletePermissionPolicy_resourceArn :: Lens' DeletePermissionPolicy Text
- deletePermissionPolicyResponse_httpStatus :: Lens' DeletePermissionPolicyResponse Int
- deleteRegexPatternSet_name :: Lens' DeleteRegexPatternSet Text
- deleteRegexPatternSet_scope :: Lens' DeleteRegexPatternSet Scope
- deleteRegexPatternSet_id :: Lens' DeleteRegexPatternSet Text
- deleteRegexPatternSet_lockToken :: Lens' DeleteRegexPatternSet Text
- deleteRegexPatternSetResponse_httpStatus :: Lens' DeleteRegexPatternSetResponse Int
- deleteRuleGroup_name :: Lens' DeleteRuleGroup Text
- deleteRuleGroup_scope :: Lens' DeleteRuleGroup Scope
- deleteRuleGroup_id :: Lens' DeleteRuleGroup Text
- deleteRuleGroup_lockToken :: Lens' DeleteRuleGroup Text
- deleteRuleGroupResponse_httpStatus :: Lens' DeleteRuleGroupResponse Int
- deleteWebACL_name :: Lens' DeleteWebACL Text
- deleteWebACL_scope :: Lens' DeleteWebACL Scope
- deleteWebACL_id :: Lens' DeleteWebACL Text
- deleteWebACL_lockToken :: Lens' DeleteWebACL Text
- deleteWebACLResponse_httpStatus :: Lens' DeleteWebACLResponse Int
- describeManagedRuleGroup_versionName :: Lens' DescribeManagedRuleGroup (Maybe Text)
- describeManagedRuleGroup_vendorName :: Lens' DescribeManagedRuleGroup Text
- describeManagedRuleGroup_name :: Lens' DescribeManagedRuleGroup Text
- describeManagedRuleGroup_scope :: Lens' DescribeManagedRuleGroup Scope
- describeManagedRuleGroupResponse_availableLabels :: Lens' DescribeManagedRuleGroupResponse (Maybe [LabelSummary])
- describeManagedRuleGroupResponse_capacity :: Lens' DescribeManagedRuleGroupResponse (Maybe Natural)
- describeManagedRuleGroupResponse_consumedLabels :: Lens' DescribeManagedRuleGroupResponse (Maybe [LabelSummary])
- describeManagedRuleGroupResponse_labelNamespace :: Lens' DescribeManagedRuleGroupResponse (Maybe Text)
- describeManagedRuleGroupResponse_rules :: Lens' DescribeManagedRuleGroupResponse (Maybe [RuleSummary])
- describeManagedRuleGroupResponse_snsTopicArn :: Lens' DescribeManagedRuleGroupResponse (Maybe Text)
- describeManagedRuleGroupResponse_versionName :: Lens' DescribeManagedRuleGroupResponse (Maybe Text)
- describeManagedRuleGroupResponse_httpStatus :: Lens' DescribeManagedRuleGroupResponse Int
- disassociateWebACL_resourceArn :: Lens' DisassociateWebACL Text
- disassociateWebACLResponse_httpStatus :: Lens' DisassociateWebACLResponse Int
- generateMobileSdkReleaseUrl_platform :: Lens' GenerateMobileSdkReleaseUrl Platform
- generateMobileSdkReleaseUrl_releaseVersion :: Lens' GenerateMobileSdkReleaseUrl Text
- generateMobileSdkReleaseUrlResponse_url :: Lens' GenerateMobileSdkReleaseUrlResponse (Maybe Text)
- generateMobileSdkReleaseUrlResponse_httpStatus :: Lens' GenerateMobileSdkReleaseUrlResponse Int
- getIPSet_name :: Lens' GetIPSet Text
- getIPSet_scope :: Lens' GetIPSet Scope
- getIPSet_id :: Lens' GetIPSet Text
- getIPSetResponse_iPSet :: Lens' GetIPSetResponse (Maybe IPSet)
- getIPSetResponse_lockToken :: Lens' GetIPSetResponse (Maybe Text)
- getIPSetResponse_httpStatus :: Lens' GetIPSetResponse Int
- getLoggingConfiguration_resourceArn :: Lens' GetLoggingConfiguration Text
- getLoggingConfigurationResponse_loggingConfiguration :: Lens' GetLoggingConfigurationResponse (Maybe LoggingConfiguration)
- getLoggingConfigurationResponse_httpStatus :: Lens' GetLoggingConfigurationResponse Int
- getManagedRuleSet_name :: Lens' GetManagedRuleSet Text
- getManagedRuleSet_scope :: Lens' GetManagedRuleSet Scope
- getManagedRuleSet_id :: Lens' GetManagedRuleSet Text
- getManagedRuleSetResponse_lockToken :: Lens' GetManagedRuleSetResponse (Maybe Text)
- getManagedRuleSetResponse_managedRuleSet :: Lens' GetManagedRuleSetResponse (Maybe ManagedRuleSet)
- getManagedRuleSetResponse_httpStatus :: Lens' GetManagedRuleSetResponse Int
- getMobileSdkRelease_platform :: Lens' GetMobileSdkRelease Platform
- getMobileSdkRelease_releaseVersion :: Lens' GetMobileSdkRelease Text
- getMobileSdkReleaseResponse_mobileSdkRelease :: Lens' GetMobileSdkReleaseResponse (Maybe MobileSdkRelease)
- getMobileSdkReleaseResponse_httpStatus :: Lens' GetMobileSdkReleaseResponse Int
- getPermissionPolicy_resourceArn :: Lens' GetPermissionPolicy Text
- getPermissionPolicyResponse_policy :: Lens' GetPermissionPolicyResponse (Maybe Text)
- getPermissionPolicyResponse_httpStatus :: Lens' GetPermissionPolicyResponse Int
- getRateBasedStatementManagedKeys_ruleGroupRuleName :: Lens' GetRateBasedStatementManagedKeys (Maybe Text)
- getRateBasedStatementManagedKeys_scope :: Lens' GetRateBasedStatementManagedKeys Scope
- getRateBasedStatementManagedKeys_webACLName :: Lens' GetRateBasedStatementManagedKeys Text
- getRateBasedStatementManagedKeys_webACLId :: Lens' GetRateBasedStatementManagedKeys Text
- getRateBasedStatementManagedKeys_ruleName :: Lens' GetRateBasedStatementManagedKeys Text
- getRateBasedStatementManagedKeysResponse_managedKeysIPV4 :: Lens' GetRateBasedStatementManagedKeysResponse (Maybe RateBasedStatementManagedKeysIPSet)
- getRateBasedStatementManagedKeysResponse_managedKeysIPV6 :: Lens' GetRateBasedStatementManagedKeysResponse (Maybe RateBasedStatementManagedKeysIPSet)
- getRateBasedStatementManagedKeysResponse_httpStatus :: Lens' GetRateBasedStatementManagedKeysResponse Int
- getRegexPatternSet_name :: Lens' GetRegexPatternSet Text
- getRegexPatternSet_scope :: Lens' GetRegexPatternSet Scope
- getRegexPatternSet_id :: Lens' GetRegexPatternSet Text
- getRegexPatternSetResponse_lockToken :: Lens' GetRegexPatternSetResponse (Maybe Text)
- getRegexPatternSetResponse_regexPatternSet :: Lens' GetRegexPatternSetResponse (Maybe RegexPatternSet)
- getRegexPatternSetResponse_httpStatus :: Lens' GetRegexPatternSetResponse Int
- getRuleGroup_arn :: Lens' GetRuleGroup (Maybe Text)
- getRuleGroup_id :: Lens' GetRuleGroup (Maybe Text)
- getRuleGroup_name :: Lens' GetRuleGroup (Maybe Text)
- getRuleGroup_scope :: Lens' GetRuleGroup (Maybe Scope)
- getRuleGroupResponse_lockToken :: Lens' GetRuleGroupResponse (Maybe Text)
- getRuleGroupResponse_ruleGroup :: Lens' GetRuleGroupResponse (Maybe RuleGroup)
- getRuleGroupResponse_httpStatus :: Lens' GetRuleGroupResponse Int
- getSampledRequests_webAclArn :: Lens' GetSampledRequests Text
- getSampledRequests_ruleMetricName :: Lens' GetSampledRequests Text
- getSampledRequests_scope :: Lens' GetSampledRequests Scope
- getSampledRequests_timeWindow :: Lens' GetSampledRequests TimeWindow
- getSampledRequests_maxItems :: Lens' GetSampledRequests Natural
- getSampledRequestsResponse_populationSize :: Lens' GetSampledRequestsResponse (Maybe Integer)
- getSampledRequestsResponse_sampledRequests :: Lens' GetSampledRequestsResponse (Maybe [SampledHTTPRequest])
- getSampledRequestsResponse_timeWindow :: Lens' GetSampledRequestsResponse (Maybe TimeWindow)
- getSampledRequestsResponse_httpStatus :: Lens' GetSampledRequestsResponse Int
- getWebACL_name :: Lens' GetWebACL Text
- getWebACL_scope :: Lens' GetWebACL Scope
- getWebACL_id :: Lens' GetWebACL Text
- getWebACLResponse_applicationIntegrationURL :: Lens' GetWebACLResponse (Maybe Text)
- getWebACLResponse_lockToken :: Lens' GetWebACLResponse (Maybe Text)
- getWebACLResponse_webACL :: Lens' GetWebACLResponse (Maybe WebACL)
- getWebACLResponse_httpStatus :: Lens' GetWebACLResponse Int
- getWebACLForResource_resourceArn :: Lens' GetWebACLForResource Text
- getWebACLForResourceResponse_webACL :: Lens' GetWebACLForResourceResponse (Maybe WebACL)
- getWebACLForResourceResponse_httpStatus :: Lens' GetWebACLForResourceResponse Int
- listAvailableManagedRuleGroupVersions_limit :: Lens' ListAvailableManagedRuleGroupVersions (Maybe Natural)
- listAvailableManagedRuleGroupVersions_nextMarker :: Lens' ListAvailableManagedRuleGroupVersions (Maybe Text)
- listAvailableManagedRuleGroupVersions_vendorName :: Lens' ListAvailableManagedRuleGroupVersions Text
- listAvailableManagedRuleGroupVersions_name :: Lens' ListAvailableManagedRuleGroupVersions Text
- listAvailableManagedRuleGroupVersions_scope :: Lens' ListAvailableManagedRuleGroupVersions Scope
- listAvailableManagedRuleGroupVersionsResponse_currentDefaultVersion :: Lens' ListAvailableManagedRuleGroupVersionsResponse (Maybe Text)
- listAvailableManagedRuleGroupVersionsResponse_nextMarker :: Lens' ListAvailableManagedRuleGroupVersionsResponse (Maybe Text)
- listAvailableManagedRuleGroupVersionsResponse_versions :: Lens' ListAvailableManagedRuleGroupVersionsResponse (Maybe [ManagedRuleGroupVersion])
- listAvailableManagedRuleGroupVersionsResponse_httpStatus :: Lens' ListAvailableManagedRuleGroupVersionsResponse Int
- listAvailableManagedRuleGroups_limit :: Lens' ListAvailableManagedRuleGroups (Maybe Natural)
- listAvailableManagedRuleGroups_nextMarker :: Lens' ListAvailableManagedRuleGroups (Maybe Text)
- listAvailableManagedRuleGroups_scope :: Lens' ListAvailableManagedRuleGroups Scope
- listAvailableManagedRuleGroupsResponse_managedRuleGroups :: Lens' ListAvailableManagedRuleGroupsResponse (Maybe [ManagedRuleGroupSummary])
- listAvailableManagedRuleGroupsResponse_nextMarker :: Lens' ListAvailableManagedRuleGroupsResponse (Maybe Text)
- listAvailableManagedRuleGroupsResponse_httpStatus :: Lens' ListAvailableManagedRuleGroupsResponse Int
- listIPSets_limit :: Lens' ListIPSets (Maybe Natural)
- listIPSets_nextMarker :: Lens' ListIPSets (Maybe Text)
- listIPSets_scope :: Lens' ListIPSets Scope
- listIPSetsResponse_iPSets :: Lens' ListIPSetsResponse (Maybe [IPSetSummary])
- listIPSetsResponse_nextMarker :: Lens' ListIPSetsResponse (Maybe Text)
- listIPSetsResponse_httpStatus :: Lens' ListIPSetsResponse Int
- listLoggingConfigurations_limit :: Lens' ListLoggingConfigurations (Maybe Natural)
- listLoggingConfigurations_nextMarker :: Lens' ListLoggingConfigurations (Maybe Text)
- listLoggingConfigurations_scope :: Lens' ListLoggingConfigurations Scope
- listLoggingConfigurationsResponse_loggingConfigurations :: Lens' ListLoggingConfigurationsResponse (Maybe [LoggingConfiguration])
- listLoggingConfigurationsResponse_nextMarker :: Lens' ListLoggingConfigurationsResponse (Maybe Text)
- listLoggingConfigurationsResponse_httpStatus :: Lens' ListLoggingConfigurationsResponse Int
- listManagedRuleSets_limit :: Lens' ListManagedRuleSets (Maybe Natural)
- listManagedRuleSets_nextMarker :: Lens' ListManagedRuleSets (Maybe Text)
- listManagedRuleSets_scope :: Lens' ListManagedRuleSets Scope
- listManagedRuleSetsResponse_managedRuleSets :: Lens' ListManagedRuleSetsResponse (Maybe [ManagedRuleSetSummary])
- listManagedRuleSetsResponse_nextMarker :: Lens' ListManagedRuleSetsResponse (Maybe Text)
- listManagedRuleSetsResponse_httpStatus :: Lens' ListManagedRuleSetsResponse Int
- listMobileSdkReleases_limit :: Lens' ListMobileSdkReleases (Maybe Natural)
- listMobileSdkReleases_nextMarker :: Lens' ListMobileSdkReleases (Maybe Text)
- listMobileSdkReleases_platform :: Lens' ListMobileSdkReleases Platform
- listMobileSdkReleasesResponse_nextMarker :: Lens' ListMobileSdkReleasesResponse (Maybe Text)
- listMobileSdkReleasesResponse_releaseSummaries :: Lens' ListMobileSdkReleasesResponse (Maybe [ReleaseSummary])
- listMobileSdkReleasesResponse_httpStatus :: Lens' ListMobileSdkReleasesResponse Int
- listRegexPatternSets_limit :: Lens' ListRegexPatternSets (Maybe Natural)
- listRegexPatternSets_nextMarker :: Lens' ListRegexPatternSets (Maybe Text)
- listRegexPatternSets_scope :: Lens' ListRegexPatternSets Scope
- listRegexPatternSetsResponse_nextMarker :: Lens' ListRegexPatternSetsResponse (Maybe Text)
- listRegexPatternSetsResponse_regexPatternSets :: Lens' ListRegexPatternSetsResponse (Maybe [RegexPatternSetSummary])
- listRegexPatternSetsResponse_httpStatus :: Lens' ListRegexPatternSetsResponse Int
- listResourcesForWebACL_resourceType :: Lens' ListResourcesForWebACL (Maybe ResourceType)
- listResourcesForWebACL_webACLArn :: Lens' ListResourcesForWebACL Text
- listResourcesForWebACLResponse_resourceArns :: Lens' ListResourcesForWebACLResponse (Maybe [Text])
- listResourcesForWebACLResponse_httpStatus :: Lens' ListResourcesForWebACLResponse Int
- listRuleGroups_limit :: Lens' ListRuleGroups (Maybe Natural)
- listRuleGroups_nextMarker :: Lens' ListRuleGroups (Maybe Text)
- listRuleGroups_scope :: Lens' ListRuleGroups Scope
- listRuleGroupsResponse_nextMarker :: Lens' ListRuleGroupsResponse (Maybe Text)
- listRuleGroupsResponse_ruleGroups :: Lens' ListRuleGroupsResponse (Maybe [RuleGroupSummary])
- listRuleGroupsResponse_httpStatus :: Lens' ListRuleGroupsResponse Int
- listTagsForResource_limit :: Lens' ListTagsForResource (Maybe Natural)
- listTagsForResource_nextMarker :: Lens' ListTagsForResource (Maybe Text)
- listTagsForResource_resourceARN :: Lens' ListTagsForResource Text
- listTagsForResourceResponse_nextMarker :: Lens' ListTagsForResourceResponse (Maybe Text)
- listTagsForResourceResponse_tagInfoForResource :: Lens' ListTagsForResourceResponse (Maybe TagInfoForResource)
- listTagsForResourceResponse_httpStatus :: Lens' ListTagsForResourceResponse Int
- listWebACLs_limit :: Lens' ListWebACLs (Maybe Natural)
- listWebACLs_nextMarker :: Lens' ListWebACLs (Maybe Text)
- listWebACLs_scope :: Lens' ListWebACLs Scope
- listWebACLsResponse_nextMarker :: Lens' ListWebACLsResponse (Maybe Text)
- listWebACLsResponse_webACLs :: Lens' ListWebACLsResponse (Maybe [WebACLSummary])
- listWebACLsResponse_httpStatus :: Lens' ListWebACLsResponse Int
- putLoggingConfiguration_loggingConfiguration :: Lens' PutLoggingConfiguration LoggingConfiguration
- putLoggingConfigurationResponse_loggingConfiguration :: Lens' PutLoggingConfigurationResponse (Maybe LoggingConfiguration)
- putLoggingConfigurationResponse_httpStatus :: Lens' PutLoggingConfigurationResponse Int
- putManagedRuleSetVersions_recommendedVersion :: Lens' PutManagedRuleSetVersions (Maybe Text)
- putManagedRuleSetVersions_versionsToPublish :: Lens' PutManagedRuleSetVersions (Maybe (HashMap Text VersionToPublish))
- putManagedRuleSetVersions_name :: Lens' PutManagedRuleSetVersions Text
- putManagedRuleSetVersions_scope :: Lens' PutManagedRuleSetVersions Scope
- putManagedRuleSetVersions_id :: Lens' PutManagedRuleSetVersions Text
- putManagedRuleSetVersions_lockToken :: Lens' PutManagedRuleSetVersions Text
- putManagedRuleSetVersionsResponse_nextLockToken :: Lens' PutManagedRuleSetVersionsResponse (Maybe Text)
- putManagedRuleSetVersionsResponse_httpStatus :: Lens' PutManagedRuleSetVersionsResponse Int
- putPermissionPolicy_resourceArn :: Lens' PutPermissionPolicy Text
- putPermissionPolicy_policy :: Lens' PutPermissionPolicy Text
- putPermissionPolicyResponse_httpStatus :: Lens' PutPermissionPolicyResponse Int
- tagResource_resourceARN :: Lens' TagResource Text
- tagResource_tags :: Lens' TagResource (NonEmpty Tag)
- tagResourceResponse_httpStatus :: Lens' TagResourceResponse Int
- untagResource_resourceARN :: Lens' UntagResource Text
- untagResource_tagKeys :: Lens' UntagResource (NonEmpty Text)
- untagResourceResponse_httpStatus :: Lens' UntagResourceResponse Int
- updateIPSet_description :: Lens' UpdateIPSet (Maybe Text)
- updateIPSet_name :: Lens' UpdateIPSet Text
- updateIPSet_scope :: Lens' UpdateIPSet Scope
- updateIPSet_id :: Lens' UpdateIPSet Text
- updateIPSet_addresses :: Lens' UpdateIPSet [Text]
- updateIPSet_lockToken :: Lens' UpdateIPSet Text
- updateIPSetResponse_nextLockToken :: Lens' UpdateIPSetResponse (Maybe Text)
- updateIPSetResponse_httpStatus :: Lens' UpdateIPSetResponse Int
- updateManagedRuleSetVersionExpiryDate_name :: Lens' UpdateManagedRuleSetVersionExpiryDate Text
- updateManagedRuleSetVersionExpiryDate_scope :: Lens' UpdateManagedRuleSetVersionExpiryDate Scope
- updateManagedRuleSetVersionExpiryDate_id :: Lens' UpdateManagedRuleSetVersionExpiryDate Text
- updateManagedRuleSetVersionExpiryDate_lockToken :: Lens' UpdateManagedRuleSetVersionExpiryDate Text
- updateManagedRuleSetVersionExpiryDate_versionToExpire :: Lens' UpdateManagedRuleSetVersionExpiryDate Text
- updateManagedRuleSetVersionExpiryDate_expiryTimestamp :: Lens' UpdateManagedRuleSetVersionExpiryDate UTCTime
- updateManagedRuleSetVersionExpiryDateResponse_expiringVersion :: Lens' UpdateManagedRuleSetVersionExpiryDateResponse (Maybe Text)
- updateManagedRuleSetVersionExpiryDateResponse_expiryTimestamp :: Lens' UpdateManagedRuleSetVersionExpiryDateResponse (Maybe UTCTime)
- updateManagedRuleSetVersionExpiryDateResponse_nextLockToken :: Lens' UpdateManagedRuleSetVersionExpiryDateResponse (Maybe Text)
- updateManagedRuleSetVersionExpiryDateResponse_httpStatus :: Lens' UpdateManagedRuleSetVersionExpiryDateResponse Int
- updateRegexPatternSet_description :: Lens' UpdateRegexPatternSet (Maybe Text)
- updateRegexPatternSet_name :: Lens' UpdateRegexPatternSet Text
- updateRegexPatternSet_scope :: Lens' UpdateRegexPatternSet Scope
- updateRegexPatternSet_id :: Lens' UpdateRegexPatternSet Text
- updateRegexPatternSet_regularExpressionList :: Lens' UpdateRegexPatternSet [Regex]
- updateRegexPatternSet_lockToken :: Lens' UpdateRegexPatternSet Text
- updateRegexPatternSetResponse_nextLockToken :: Lens' UpdateRegexPatternSetResponse (Maybe Text)
- updateRegexPatternSetResponse_httpStatus :: Lens' UpdateRegexPatternSetResponse Int
- updateRuleGroup_customResponseBodies :: Lens' UpdateRuleGroup (Maybe (HashMap Text CustomResponseBody))
- updateRuleGroup_description :: Lens' UpdateRuleGroup (Maybe Text)
- updateRuleGroup_rules :: Lens' UpdateRuleGroup (Maybe [Rule])
- updateRuleGroup_name :: Lens' UpdateRuleGroup Text
- updateRuleGroup_scope :: Lens' UpdateRuleGroup Scope
- updateRuleGroup_id :: Lens' UpdateRuleGroup Text
- updateRuleGroup_visibilityConfig :: Lens' UpdateRuleGroup VisibilityConfig
- updateRuleGroup_lockToken :: Lens' UpdateRuleGroup Text
- updateRuleGroupResponse_nextLockToken :: Lens' UpdateRuleGroupResponse (Maybe Text)
- updateRuleGroupResponse_httpStatus :: Lens' UpdateRuleGroupResponse Int
- updateWebACL_captchaConfig :: Lens' UpdateWebACL (Maybe CaptchaConfig)
- updateWebACL_challengeConfig :: Lens' UpdateWebACL (Maybe ChallengeConfig)
- updateWebACL_customResponseBodies :: Lens' UpdateWebACL (Maybe (HashMap Text CustomResponseBody))
- updateWebACL_description :: Lens' UpdateWebACL (Maybe Text)
- updateWebACL_rules :: Lens' UpdateWebACL (Maybe [Rule])
- updateWebACL_tokenDomains :: Lens' UpdateWebACL (Maybe (NonEmpty Text))
- updateWebACL_name :: Lens' UpdateWebACL Text
- updateWebACL_scope :: Lens' UpdateWebACL Scope
- updateWebACL_id :: Lens' UpdateWebACL Text
- updateWebACL_defaultAction :: Lens' UpdateWebACL DefaultAction
- updateWebACL_visibilityConfig :: Lens' UpdateWebACL VisibilityConfig
- updateWebACL_lockToken :: Lens' UpdateWebACL Text
- updateWebACLResponse_nextLockToken :: Lens' UpdateWebACLResponse (Maybe Text)
- updateWebACLResponse_httpStatus :: Lens' UpdateWebACLResponse Int
- aWSManagedRulesBotControlRuleSet_inspectionLevel :: Lens' AWSManagedRulesBotControlRuleSet InspectionLevel
- actionCondition_action :: Lens' ActionCondition ActionValue
- allowAction_customRequestHandling :: Lens' AllowAction (Maybe CustomRequestHandling)
- andStatement_statements :: Lens' AndStatement [Statement]
- blockAction_customResponse :: Lens' BlockAction (Maybe CustomResponse)
- body_oversizeHandling :: Lens' Body (Maybe OversizeHandling)
- byteMatchStatement_searchString :: Lens' ByteMatchStatement ByteString
- byteMatchStatement_fieldToMatch :: Lens' ByteMatchStatement FieldToMatch
- byteMatchStatement_textTransformations :: Lens' ByteMatchStatement (NonEmpty TextTransformation)
- byteMatchStatement_positionalConstraint :: Lens' ByteMatchStatement PositionalConstraint
- captchaAction_customRequestHandling :: Lens' CaptchaAction (Maybe CustomRequestHandling)
- captchaConfig_immunityTimeProperty :: Lens' CaptchaConfig (Maybe ImmunityTimeProperty)
- captchaResponse_failureReason :: Lens' CaptchaResponse (Maybe FailureReason)
- captchaResponse_responseCode :: Lens' CaptchaResponse (Maybe Int)
- captchaResponse_solveTimestamp :: Lens' CaptchaResponse (Maybe Integer)
- challengeAction_customRequestHandling :: Lens' ChallengeAction (Maybe CustomRequestHandling)
- challengeConfig_immunityTimeProperty :: Lens' ChallengeConfig (Maybe ImmunityTimeProperty)
- challengeResponse_failureReason :: Lens' ChallengeResponse (Maybe FailureReason)
- challengeResponse_responseCode :: Lens' ChallengeResponse (Maybe Int)
- challengeResponse_solveTimestamp :: Lens' ChallengeResponse (Maybe Integer)
- condition_actionCondition :: Lens' Condition (Maybe ActionCondition)
- condition_labelNameCondition :: Lens' Condition (Maybe LabelNameCondition)
- cookieMatchPattern_all :: Lens' CookieMatchPattern (Maybe All)
- cookieMatchPattern_excludedCookies :: Lens' CookieMatchPattern (Maybe (NonEmpty Text))
- cookieMatchPattern_includedCookies :: Lens' CookieMatchPattern (Maybe (NonEmpty Text))
- cookies_matchPattern :: Lens' Cookies CookieMatchPattern
- cookies_matchScope :: Lens' Cookies MapMatchScope
- cookies_oversizeHandling :: Lens' Cookies OversizeHandling
- countAction_customRequestHandling :: Lens' CountAction (Maybe CustomRequestHandling)
- customHTTPHeader_name :: Lens' CustomHTTPHeader Text
- customHTTPHeader_value :: Lens' CustomHTTPHeader Text
- customRequestHandling_insertHeaders :: Lens' CustomRequestHandling (NonEmpty CustomHTTPHeader)
- customResponse_customResponseBodyKey :: Lens' CustomResponse (Maybe Text)
- customResponse_responseHeaders :: Lens' CustomResponse (Maybe (NonEmpty CustomHTTPHeader))
- customResponse_responseCode :: Lens' CustomResponse Natural
- customResponseBody_contentType :: Lens' CustomResponseBody ResponseContentType
- customResponseBody_content :: Lens' CustomResponseBody Text
- defaultAction_allow :: Lens' DefaultAction (Maybe AllowAction)
- defaultAction_block :: Lens' DefaultAction (Maybe BlockAction)
- excludedRule_name :: Lens' ExcludedRule Text
- fieldToMatch_allQueryArguments :: Lens' FieldToMatch (Maybe AllQueryArguments)
- fieldToMatch_body :: Lens' FieldToMatch (Maybe Body)
- fieldToMatch_cookies :: Lens' FieldToMatch (Maybe Cookies)
- fieldToMatch_headers :: Lens' FieldToMatch (Maybe Headers)
- fieldToMatch_jsonBody :: Lens' FieldToMatch (Maybe JsonBody)
- fieldToMatch_method :: Lens' FieldToMatch (Maybe Method)
- fieldToMatch_queryString :: Lens' FieldToMatch (Maybe QueryString)
- fieldToMatch_singleHeader :: Lens' FieldToMatch (Maybe SingleHeader)
- fieldToMatch_singleQueryArgument :: Lens' FieldToMatch (Maybe SingleQueryArgument)
- fieldToMatch_uriPath :: Lens' FieldToMatch (Maybe UriPath)
- filter_behavior :: Lens' Filter FilterBehavior
- filter_requirement :: Lens' Filter FilterRequirement
- filter_conditions :: Lens' Filter (NonEmpty Condition)
- firewallManagerRuleGroup_name :: Lens' FirewallManagerRuleGroup Text
- firewallManagerRuleGroup_priority :: Lens' FirewallManagerRuleGroup Natural
- firewallManagerRuleGroup_firewallManagerStatement :: Lens' FirewallManagerRuleGroup FirewallManagerStatement
- firewallManagerRuleGroup_overrideAction :: Lens' FirewallManagerRuleGroup OverrideAction
- firewallManagerRuleGroup_visibilityConfig :: Lens' FirewallManagerRuleGroup VisibilityConfig
- firewallManagerStatement_managedRuleGroupStatement :: Lens' FirewallManagerStatement (Maybe ManagedRuleGroupStatement)
- firewallManagerStatement_ruleGroupReferenceStatement :: Lens' FirewallManagerStatement (Maybe RuleGroupReferenceStatement)
- forwardedIPConfig_headerName :: Lens' ForwardedIPConfig Text
- forwardedIPConfig_fallbackBehavior :: Lens' ForwardedIPConfig FallbackBehavior
- geoMatchStatement_countryCodes :: Lens' GeoMatchStatement (Maybe (NonEmpty CountryCode))
- geoMatchStatement_forwardedIPConfig :: Lens' GeoMatchStatement (Maybe ForwardedIPConfig)
- hTTPHeader_name :: Lens' HTTPHeader (Maybe Text)
- hTTPHeader_value :: Lens' HTTPHeader (Maybe Text)
- hTTPRequest_clientIP :: Lens' HTTPRequest (Maybe Text)
- hTTPRequest_country :: Lens' HTTPRequest (Maybe Text)
- hTTPRequest_hTTPVersion :: Lens' HTTPRequest (Maybe Text)
- hTTPRequest_headers :: Lens' HTTPRequest (Maybe [HTTPHeader])
- hTTPRequest_method :: Lens' HTTPRequest (Maybe Text)
- hTTPRequest_uri :: Lens' HTTPRequest (Maybe Text)
- headerMatchPattern_all :: Lens' HeaderMatchPattern (Maybe All)
- headerMatchPattern_excludedHeaders :: Lens' HeaderMatchPattern (Maybe (NonEmpty Text))
- headerMatchPattern_includedHeaders :: Lens' HeaderMatchPattern (Maybe (NonEmpty Text))
- headers_matchPattern :: Lens' Headers HeaderMatchPattern
- headers_matchScope :: Lens' Headers MapMatchScope
- headers_oversizeHandling :: Lens' Headers OversizeHandling
- iPSet_description :: Lens' IPSet (Maybe Text)
- iPSet_name :: Lens' IPSet Text
- iPSet_id :: Lens' IPSet Text
- iPSet_arn :: Lens' IPSet Text
- iPSet_iPAddressVersion :: Lens' IPSet IPAddressVersion
- iPSet_addresses :: Lens' IPSet [Text]
- iPSetForwardedIPConfig_headerName :: Lens' IPSetForwardedIPConfig Text
- iPSetForwardedIPConfig_fallbackBehavior :: Lens' IPSetForwardedIPConfig FallbackBehavior
- iPSetForwardedIPConfig_position :: Lens' IPSetForwardedIPConfig ForwardedIPPosition
- iPSetReferenceStatement_iPSetForwardedIPConfig :: Lens' IPSetReferenceStatement (Maybe IPSetForwardedIPConfig)
- iPSetReferenceStatement_arn :: Lens' IPSetReferenceStatement Text
- iPSetSummary_arn :: Lens' IPSetSummary (Maybe Text)
- iPSetSummary_description :: Lens' IPSetSummary (Maybe Text)
- iPSetSummary_id :: Lens' IPSetSummary (Maybe Text)
- iPSetSummary_lockToken :: Lens' IPSetSummary (Maybe Text)
- iPSetSummary_name :: Lens' IPSetSummary (Maybe Text)
- immunityTimeProperty_immunityTime :: Lens' ImmunityTimeProperty Natural
- jsonBody_invalidFallbackBehavior :: Lens' JsonBody (Maybe BodyParsingFallbackBehavior)
- jsonBody_oversizeHandling :: Lens' JsonBody (Maybe OversizeHandling)
- jsonBody_matchPattern :: Lens' JsonBody JsonMatchPattern
- jsonBody_matchScope :: Lens' JsonBody JsonMatchScope
- jsonMatchPattern_all :: Lens' JsonMatchPattern (Maybe All)
- jsonMatchPattern_includedPaths :: Lens' JsonMatchPattern (Maybe (NonEmpty Text))
- label_name :: Lens' Label Text
- labelMatchStatement_scope :: Lens' LabelMatchStatement LabelMatchScope
- labelMatchStatement_key :: Lens' LabelMatchStatement Text
- labelNameCondition_labelName :: Lens' LabelNameCondition Text
- labelSummary_name :: Lens' LabelSummary (Maybe Text)
- loggingConfiguration_loggingFilter :: Lens' LoggingConfiguration (Maybe LoggingFilter)
- loggingConfiguration_managedByFirewallManager :: Lens' LoggingConfiguration (Maybe Bool)
- loggingConfiguration_redactedFields :: Lens' LoggingConfiguration (Maybe [FieldToMatch])
- loggingConfiguration_resourceArn :: Lens' LoggingConfiguration Text
- loggingConfiguration_logDestinationConfigs :: Lens' LoggingConfiguration (NonEmpty Text)
- loggingFilter_filters :: Lens' LoggingFilter (NonEmpty Filter)
- loggingFilter_defaultBehavior :: Lens' LoggingFilter FilterBehavior
- managedRuleGroupConfig_aWSManagedRulesBotControlRuleSet :: Lens' ManagedRuleGroupConfig (Maybe AWSManagedRulesBotControlRuleSet)
- managedRuleGroupConfig_loginPath :: Lens' ManagedRuleGroupConfig (Maybe Text)
- managedRuleGroupConfig_passwordField :: Lens' ManagedRuleGroupConfig (Maybe PasswordField)
- managedRuleGroupConfig_payloadType :: Lens' ManagedRuleGroupConfig (Maybe PayloadType)
- managedRuleGroupConfig_usernameField :: Lens' ManagedRuleGroupConfig (Maybe UsernameField)
- managedRuleGroupStatement_excludedRules :: Lens' ManagedRuleGroupStatement (Maybe [ExcludedRule])
- managedRuleGroupStatement_managedRuleGroupConfigs :: Lens' ManagedRuleGroupStatement (Maybe (NonEmpty ManagedRuleGroupConfig))
- managedRuleGroupStatement_ruleActionOverrides :: Lens' ManagedRuleGroupStatement (Maybe (NonEmpty RuleActionOverride))
- managedRuleGroupStatement_scopeDownStatement :: Lens' ManagedRuleGroupStatement (Maybe Statement)
- managedRuleGroupStatement_version :: Lens' ManagedRuleGroupStatement (Maybe Text)
- managedRuleGroupStatement_vendorName :: Lens' ManagedRuleGroupStatement Text
- managedRuleGroupStatement_name :: Lens' ManagedRuleGroupStatement Text
- managedRuleGroupSummary_description :: Lens' ManagedRuleGroupSummary (Maybe Text)
- managedRuleGroupSummary_name :: Lens' ManagedRuleGroupSummary (Maybe Text)
- managedRuleGroupSummary_vendorName :: Lens' ManagedRuleGroupSummary (Maybe Text)
- managedRuleGroupSummary_versioningSupported :: Lens' ManagedRuleGroupSummary (Maybe Bool)
- managedRuleGroupVersion_lastUpdateTimestamp :: Lens' ManagedRuleGroupVersion (Maybe UTCTime)
- managedRuleGroupVersion_name :: Lens' ManagedRuleGroupVersion (Maybe Text)
- managedRuleSet_description :: Lens' ManagedRuleSet (Maybe Text)
- managedRuleSet_labelNamespace :: Lens' ManagedRuleSet (Maybe Text)
- managedRuleSet_publishedVersions :: Lens' ManagedRuleSet (Maybe (HashMap Text ManagedRuleSetVersion))
- managedRuleSet_recommendedVersion :: Lens' ManagedRuleSet (Maybe Text)
- managedRuleSet_name :: Lens' ManagedRuleSet Text
- managedRuleSet_id :: Lens' ManagedRuleSet Text
- managedRuleSet_arn :: Lens' ManagedRuleSet Text
- managedRuleSetSummary_arn :: Lens' ManagedRuleSetSummary (Maybe Text)
- managedRuleSetSummary_description :: Lens' ManagedRuleSetSummary (Maybe Text)
- managedRuleSetSummary_id :: Lens' ManagedRuleSetSummary (Maybe Text)
- managedRuleSetSummary_labelNamespace :: Lens' ManagedRuleSetSummary (Maybe Text)
- managedRuleSetSummary_lockToken :: Lens' ManagedRuleSetSummary (Maybe Text)
- managedRuleSetSummary_name :: Lens' ManagedRuleSetSummary (Maybe Text)
- managedRuleSetVersion_associatedRuleGroupArn :: Lens' ManagedRuleSetVersion (Maybe Text)
- managedRuleSetVersion_capacity :: Lens' ManagedRuleSetVersion (Maybe Natural)
- managedRuleSetVersion_expiryTimestamp :: Lens' ManagedRuleSetVersion (Maybe UTCTime)
- managedRuleSetVersion_forecastedLifetime :: Lens' ManagedRuleSetVersion (Maybe Natural)
- managedRuleSetVersion_lastUpdateTimestamp :: Lens' ManagedRuleSetVersion (Maybe UTCTime)
- managedRuleSetVersion_publishTimestamp :: Lens' ManagedRuleSetVersion (Maybe UTCTime)
- mobileSdkRelease_releaseNotes :: Lens' MobileSdkRelease (Maybe Text)
- mobileSdkRelease_releaseVersion :: Lens' MobileSdkRelease (Maybe Text)
- mobileSdkRelease_tags :: Lens' MobileSdkRelease (Maybe (NonEmpty Tag))
- mobileSdkRelease_timestamp :: Lens' MobileSdkRelease (Maybe UTCTime)
- notStatement_statement :: Lens' NotStatement Statement
- orStatement_statements :: Lens' OrStatement [Statement]
- overrideAction_count :: Lens' OverrideAction (Maybe CountAction)
- overrideAction_none :: Lens' OverrideAction (Maybe NoneAction)
- passwordField_identifier :: Lens' PasswordField Text
- rateBasedStatement_forwardedIPConfig :: Lens' RateBasedStatement (Maybe ForwardedIPConfig)
- rateBasedStatement_scopeDownStatement :: Lens' RateBasedStatement (Maybe Statement)
- rateBasedStatement_limit :: Lens' RateBasedStatement Natural
- rateBasedStatement_aggregateKeyType :: Lens' RateBasedStatement RateBasedStatementAggregateKeyType
- rateBasedStatementManagedKeysIPSet_addresses :: Lens' RateBasedStatementManagedKeysIPSet (Maybe [Text])
- rateBasedStatementManagedKeysIPSet_iPAddressVersion :: Lens' RateBasedStatementManagedKeysIPSet (Maybe IPAddressVersion)
- regex_regexString :: Lens' Regex (Maybe Text)
- regexMatchStatement_regexString :: Lens' RegexMatchStatement Text
- regexMatchStatement_fieldToMatch :: Lens' RegexMatchStatement FieldToMatch
- regexMatchStatement_textTransformations :: Lens' RegexMatchStatement (NonEmpty TextTransformation)
- regexPatternSet_arn :: Lens' RegexPatternSet (Maybe Text)
- regexPatternSet_description :: Lens' RegexPatternSet (Maybe Text)
- regexPatternSet_id :: Lens' RegexPatternSet (Maybe Text)
- regexPatternSet_name :: Lens' RegexPatternSet (Maybe Text)
- regexPatternSet_regularExpressionList :: Lens' RegexPatternSet (Maybe [Regex])
- regexPatternSetReferenceStatement_arn :: Lens' RegexPatternSetReferenceStatement Text
- regexPatternSetReferenceStatement_fieldToMatch :: Lens' RegexPatternSetReferenceStatement FieldToMatch
- regexPatternSetReferenceStatement_textTransformations :: Lens' RegexPatternSetReferenceStatement (NonEmpty TextTransformation)
- regexPatternSetSummary_arn :: Lens' RegexPatternSetSummary (Maybe Text)
- regexPatternSetSummary_description :: Lens' RegexPatternSetSummary (Maybe Text)
- regexPatternSetSummary_id :: Lens' RegexPatternSetSummary (Maybe Text)
- regexPatternSetSummary_lockToken :: Lens' RegexPatternSetSummary (Maybe Text)
- regexPatternSetSummary_name :: Lens' RegexPatternSetSummary (Maybe Text)
- releaseSummary_releaseVersion :: Lens' ReleaseSummary (Maybe Text)
- releaseSummary_timestamp :: Lens' ReleaseSummary (Maybe UTCTime)
- rule_action :: Lens' Rule (Maybe RuleAction)
- rule_captchaConfig :: Lens' Rule (Maybe CaptchaConfig)
- rule_challengeConfig :: Lens' Rule (Maybe ChallengeConfig)
- rule_overrideAction :: Lens' Rule (Maybe OverrideAction)
- rule_ruleLabels :: Lens' Rule (Maybe [Label])
- rule_name :: Lens' Rule Text
- rule_priority :: Lens' Rule Natural
- rule_statement :: Lens' Rule Statement
- rule_visibilityConfig :: Lens' Rule VisibilityConfig
- ruleAction_allow :: Lens' RuleAction (Maybe AllowAction)
- ruleAction_block :: Lens' RuleAction (Maybe BlockAction)
- ruleAction_captcha :: Lens' RuleAction (Maybe CaptchaAction)
- ruleAction_challenge :: Lens' RuleAction (Maybe ChallengeAction)
- ruleAction_count :: Lens' RuleAction (Maybe CountAction)
- ruleActionOverride_name :: Lens' RuleActionOverride Text
- ruleActionOverride_actionToUse :: Lens' RuleActionOverride RuleAction
- ruleGroup_availableLabels :: Lens' RuleGroup (Maybe [LabelSummary])
- ruleGroup_consumedLabels :: Lens' RuleGroup (Maybe [LabelSummary])
- ruleGroup_customResponseBodies :: Lens' RuleGroup (Maybe (HashMap Text CustomResponseBody))
- ruleGroup_description :: Lens' RuleGroup (Maybe Text)
- ruleGroup_labelNamespace :: Lens' RuleGroup (Maybe Text)
- ruleGroup_rules :: Lens' RuleGroup (Maybe [Rule])
- ruleGroup_name :: Lens' RuleGroup Text
- ruleGroup_id :: Lens' RuleGroup Text
- ruleGroup_capacity :: Lens' RuleGroup Natural
- ruleGroup_arn :: Lens' RuleGroup Text
- ruleGroup_visibilityConfig :: Lens' RuleGroup VisibilityConfig
- ruleGroupReferenceStatement_excludedRules :: Lens' RuleGroupReferenceStatement (Maybe [ExcludedRule])
- ruleGroupReferenceStatement_ruleActionOverrides :: Lens' RuleGroupReferenceStatement (Maybe (NonEmpty RuleActionOverride))
- ruleGroupReferenceStatement_arn :: Lens' RuleGroupReferenceStatement Text
- ruleGroupSummary_arn :: Lens' RuleGroupSummary (Maybe Text)
- ruleGroupSummary_description :: Lens' RuleGroupSummary (Maybe Text)
- ruleGroupSummary_id :: Lens' RuleGroupSummary (Maybe Text)
- ruleGroupSummary_lockToken :: Lens' RuleGroupSummary (Maybe Text)
- ruleGroupSummary_name :: Lens' RuleGroupSummary (Maybe Text)
- ruleSummary_action :: Lens' RuleSummary (Maybe RuleAction)
- ruleSummary_name :: Lens' RuleSummary (Maybe Text)
- sampledHTTPRequest_action :: Lens' SampledHTTPRequest (Maybe Text)
- sampledHTTPRequest_captchaResponse :: Lens' SampledHTTPRequest (Maybe CaptchaResponse)
- sampledHTTPRequest_challengeResponse :: Lens' SampledHTTPRequest (Maybe ChallengeResponse)
- sampledHTTPRequest_labels :: Lens' SampledHTTPRequest (Maybe [Label])
- sampledHTTPRequest_overriddenAction :: Lens' SampledHTTPRequest (Maybe Text)
- sampledHTTPRequest_requestHeadersInserted :: Lens' SampledHTTPRequest (Maybe [HTTPHeader])
- sampledHTTPRequest_responseCodeSent :: Lens' SampledHTTPRequest (Maybe Natural)
- sampledHTTPRequest_ruleNameWithinRuleGroup :: Lens' SampledHTTPRequest (Maybe Text)
- sampledHTTPRequest_timestamp :: Lens' SampledHTTPRequest (Maybe UTCTime)
- sampledHTTPRequest_request :: Lens' SampledHTTPRequest HTTPRequest
- sampledHTTPRequest_weight :: Lens' SampledHTTPRequest Natural
- singleHeader_name :: Lens' SingleHeader Text
- singleQueryArgument_name :: Lens' SingleQueryArgument Text
- sizeConstraintStatement_fieldToMatch :: Lens' SizeConstraintStatement FieldToMatch
- sizeConstraintStatement_comparisonOperator :: Lens' SizeConstraintStatement ComparisonOperator
- sizeConstraintStatement_size :: Lens' SizeConstraintStatement Natural
- sizeConstraintStatement_textTransformations :: Lens' SizeConstraintStatement (NonEmpty TextTransformation)
- sqliMatchStatement_sensitivityLevel :: Lens' SqliMatchStatement (Maybe SensitivityLevel)
- sqliMatchStatement_fieldToMatch :: Lens' SqliMatchStatement FieldToMatch
- sqliMatchStatement_textTransformations :: Lens' SqliMatchStatement (NonEmpty TextTransformation)
- statement_andStatement :: Lens' Statement (Maybe AndStatement)
- statement_byteMatchStatement :: Lens' Statement (Maybe ByteMatchStatement)
- statement_geoMatchStatement :: Lens' Statement (Maybe GeoMatchStatement)
- statement_iPSetReferenceStatement :: Lens' Statement (Maybe IPSetReferenceStatement)
- statement_labelMatchStatement :: Lens' Statement (Maybe LabelMatchStatement)
- statement_managedRuleGroupStatement :: Lens' Statement (Maybe ManagedRuleGroupStatement)
- statement_notStatement :: Lens' Statement (Maybe NotStatement)
- statement_orStatement :: Lens' Statement (Maybe OrStatement)
- statement_rateBasedStatement :: Lens' Statement (Maybe RateBasedStatement)
- statement_regexMatchStatement :: Lens' Statement (Maybe RegexMatchStatement)
- statement_regexPatternSetReferenceStatement :: Lens' Statement (Maybe RegexPatternSetReferenceStatement)
- statement_ruleGroupReferenceStatement :: Lens' Statement (Maybe RuleGroupReferenceStatement)
- statement_sizeConstraintStatement :: Lens' Statement (Maybe SizeConstraintStatement)
- statement_sqliMatchStatement :: Lens' Statement (Maybe SqliMatchStatement)
- statement_xssMatchStatement :: Lens' Statement (Maybe XssMatchStatement)
- tag_key :: Lens' Tag Text
- tag_value :: Lens' Tag Text
- tagInfoForResource_resourceARN :: Lens' TagInfoForResource (Maybe Text)
- tagInfoForResource_tagList :: Lens' TagInfoForResource (Maybe (NonEmpty Tag))
- textTransformation_priority :: Lens' TextTransformation Natural
- textTransformation_type :: Lens' TextTransformation TextTransformationType
- timeWindow_startTime :: Lens' TimeWindow UTCTime
- timeWindow_endTime :: Lens' TimeWindow UTCTime
- usernameField_identifier :: Lens' UsernameField Text
- versionToPublish_associatedRuleGroupArn :: Lens' VersionToPublish (Maybe Text)
- versionToPublish_forecastedLifetime :: Lens' VersionToPublish (Maybe Natural)
- visibilityConfig_sampledRequestsEnabled :: Lens' VisibilityConfig Bool
- visibilityConfig_cloudWatchMetricsEnabled :: Lens' VisibilityConfig Bool
- visibilityConfig_metricName :: Lens' VisibilityConfig Text
- webACL_capacity :: Lens' WebACL (Maybe Natural)
- webACL_captchaConfig :: Lens' WebACL (Maybe CaptchaConfig)
- webACL_challengeConfig :: Lens' WebACL (Maybe ChallengeConfig)
- webACL_customResponseBodies :: Lens' WebACL (Maybe (HashMap Text CustomResponseBody))
- webACL_description :: Lens' WebACL (Maybe Text)
- webACL_labelNamespace :: Lens' WebACL (Maybe Text)
- webACL_managedByFirewallManager :: Lens' WebACL (Maybe Bool)
- webACL_postProcessFirewallManagerRuleGroups :: Lens' WebACL (Maybe [FirewallManagerRuleGroup])
- webACL_preProcessFirewallManagerRuleGroups :: Lens' WebACL (Maybe [FirewallManagerRuleGroup])
- webACL_rules :: Lens' WebACL (Maybe [Rule])
- webACL_tokenDomains :: Lens' WebACL (Maybe (NonEmpty Text))
- webACL_name :: Lens' WebACL Text
- webACL_id :: Lens' WebACL Text
- webACL_arn :: Lens' WebACL Text
- webACL_defaultAction :: Lens' WebACL DefaultAction
- webACL_visibilityConfig :: Lens' WebACL VisibilityConfig
- webACLSummary_arn :: Lens' WebACLSummary (Maybe Text)
- webACLSummary_description :: Lens' WebACLSummary (Maybe Text)
- webACLSummary_id :: Lens' WebACLSummary (Maybe Text)
- webACLSummary_lockToken :: Lens' WebACLSummary (Maybe Text)
- webACLSummary_name :: Lens' WebACLSummary (Maybe Text)
- xssMatchStatement_fieldToMatch :: Lens' XssMatchStatement FieldToMatch
- xssMatchStatement_textTransformations :: Lens' XssMatchStatement (NonEmpty TextTransformation)
Operations
AssociateWebACL
associateWebACL_webACLArn :: Lens' AssociateWebACL Text Source #
The Amazon Resource Name (ARN) of the web ACL that you want to associate with the resource.
associateWebACL_resourceArn :: Lens' AssociateWebACL Text Source #
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
- For an Amazon Cognito user pool:
arn:aws:cognito-idp:
region
:
account-id
:userpool/
user-pool-id
associateWebACLResponse_httpStatus :: Lens' AssociateWebACLResponse Int Source #
The response's http status code.
CheckCapacity
checkCapacity_scope :: Lens' CheckCapacity Scope Source #
Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, or an Amazon Cognito user pool.
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.
checkCapacity_rules :: Lens' CheckCapacity [Rule] Source #
An array of Rule that you're configuring to use in a rule group or web ACL.
checkCapacityResponse_capacity :: Lens' CheckCapacityResponse (Maybe Natural) Source #
The capacity required by the rules and scope.
checkCapacityResponse_httpStatus :: Lens' CheckCapacityResponse Int Source #
The response's http status code.
CreateIPSet
createIPSet_description :: Lens' CreateIPSet (Maybe Text) Source #
A description of the IP set that helps with identification.
createIPSet_tags :: Lens' CreateIPSet (Maybe (NonEmpty Tag)) Source #
An array of key:value pairs to associate with the resource.
createIPSet_name :: Lens' CreateIPSet Text Source #
The name of the IP set. You cannot change the name of an IPSet
after
you create it.
createIPSet_scope :: Lens' CreateIPSet Scope Source #
Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, or an Amazon Cognito user pool.
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.
createIPSet_iPAddressVersion :: Lens' CreateIPSet IPAddressVersion Source #
The version of the IP addresses, either IPV4
or IPV6
.
createIPSet_addresses :: Lens' CreateIPSet [Text] Source #
Contains an array of strings that specifies zero or more IP addresses or
blocks of IP addresses. All addresses must be specified using Classless
Inter-Domain Routing (CIDR) notation. WAF supports all IPv4 and IPv6
CIDR ranges except for /0
.
Example address strings:
- 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.
Example JSON Addresses
specifications:
- Empty array:
"Addresses": []
- Array with one address:
"Addresses": ["192.0.2.44/32"]
- Array with three addresses:
"Addresses": ["192.0.2.44/32", "192.0.2.0/24", "192.0.0.0/16"]
- INVALID specification:
"Addresses": [""]
INVALID
createIPSetResponse_summary :: Lens' CreateIPSetResponse (Maybe IPSetSummary) Source #
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.
createIPSetResponse_httpStatus :: Lens' CreateIPSetResponse Int Source #
The response's http status code.
CreateRegexPatternSet
createRegexPatternSet_description :: Lens' CreateRegexPatternSet (Maybe Text) Source #
A description of the set that helps with identification.
createRegexPatternSet_tags :: Lens' CreateRegexPatternSet (Maybe (NonEmpty Tag)) Source #
An array of key:value pairs to associate with the resource.
createRegexPatternSet_name :: Lens' CreateRegexPatternSet Text Source #
The name of the set. You cannot change the name after you create the set.
createRegexPatternSet_scope :: Lens' CreateRegexPatternSet Scope Source #
Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, or an Amazon Cognito user pool.
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.
createRegexPatternSet_regularExpressionList :: Lens' CreateRegexPatternSet [Regex] Source #
Array of regular expression strings.
createRegexPatternSetResponse_summary :: Lens' CreateRegexPatternSetResponse (Maybe RegexPatternSetSummary) Source #
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.
createRegexPatternSetResponse_httpStatus :: Lens' CreateRegexPatternSetResponse Int Source #
The response's http status code.
CreateRuleGroup
createRuleGroup_customResponseBodies :: Lens' CreateRuleGroup (Maybe (HashMap Text CustomResponseBody)) Source #
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.
createRuleGroup_description :: Lens' CreateRuleGroup (Maybe Text) Source #
A description of the rule group that helps with identification.
createRuleGroup_rules :: Lens' CreateRuleGroup (Maybe [Rule]) Source #
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.
createRuleGroup_tags :: Lens' CreateRuleGroup (Maybe (NonEmpty Tag)) Source #
An array of key:value pairs to associate with the resource.
createRuleGroup_name :: Lens' CreateRuleGroup Text Source #
The name of the rule group. You cannot change the name of a rule group after you create it.
createRuleGroup_scope :: Lens' CreateRuleGroup Scope Source #
Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, or an Amazon Cognito user pool.
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.
createRuleGroup_capacity :: Lens' CreateRuleGroup Natural Source #
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.
createRuleGroup_visibilityConfig :: Lens' CreateRuleGroup VisibilityConfig Source #
Defines and enables Amazon CloudWatch metrics and web request sample collection.
createRuleGroupResponse_summary :: Lens' CreateRuleGroupResponse (Maybe RuleGroupSummary) Source #
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.
createRuleGroupResponse_httpStatus :: Lens' CreateRuleGroupResponse Int Source #
The response's http status code.
CreateWebACL
createWebACL_captchaConfig :: Lens' CreateWebACL (Maybe CaptchaConfig) Source #
Specifies how WAF should handle CAPTCHA
evaluations for rules that
don't have their own CaptchaConfig
settings. If you don't specify
this, WAF uses its default settings for CaptchaConfig
.
createWebACL_challengeConfig :: Lens' CreateWebACL (Maybe ChallengeConfig) Source #
Specifies how WAF should handle challenge evaluations for rules that
don't have their own ChallengeConfig
settings. If you don't specify
this, WAF uses its default settings for ChallengeConfig
.
createWebACL_customResponseBodies :: Lens' CreateWebACL (Maybe (HashMap Text CustomResponseBody)) Source #
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.
createWebACL_description :: Lens' CreateWebACL (Maybe Text) Source #
A description of the web ACL that helps with identification.
createWebACL_rules :: Lens' CreateWebACL (Maybe [Rule]) Source #
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.
createWebACL_tags :: Lens' CreateWebACL (Maybe (NonEmpty Tag)) Source #
An array of key:value pairs to associate with the resource.
createWebACL_tokenDomains :: Lens' CreateWebACL (Maybe (NonEmpty Text)) Source #
Specifies the domains that WAF should accept in a web request token. This enables the use of tokens across multiple protected websites. When WAF provides a token, it uses the domain of the Amazon Web Services resource that the web ACL is protecting. If you don't specify a list of token domains, WAF accepts tokens only for the domain of the protected resource. With a token domain list, WAF accepts the resource's host domain plus all domains in the token domain list, including their prefixed subdomains.
Example JSON:
"TokenDomains": { "mywebsite.com", "myotherwebsite.com" }
Public suffixes aren't allowed. For example, you can't use usa.gov
or co.uk
as token domains.
createWebACL_name :: Lens' CreateWebACL Text Source #
The name of the web ACL. You cannot change the name of a web ACL after you create it.
createWebACL_scope :: Lens' CreateWebACL Scope Source #
Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, or an Amazon Cognito user pool.
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.
createWebACL_defaultAction :: Lens' CreateWebACL DefaultAction Source #
The action to perform if none of the Rules
contained in the WebACL
match.
createWebACL_visibilityConfig :: Lens' CreateWebACL VisibilityConfig Source #
Defines and enables Amazon CloudWatch metrics and web request sample collection.
createWebACLResponse_summary :: Lens' CreateWebACLResponse (Maybe WebACLSummary) Source #
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.
createWebACLResponse_httpStatus :: Lens' CreateWebACLResponse Int Source #
The response's http status code.
DeleteFirewallManagerRuleGroups
deleteFirewallManagerRuleGroups_webACLArn :: Lens' DeleteFirewallManagerRuleGroups Text Source #
The Amazon Resource Name (ARN) of the web ACL.
deleteFirewallManagerRuleGroups_webACLLockToken :: Lens' DeleteFirewallManagerRuleGroups Text Source #
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.
deleteFirewallManagerRuleGroupsResponse_nextWebACLLockToken :: Lens' DeleteFirewallManagerRuleGroupsResponse (Maybe Text) Source #
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.
deleteFirewallManagerRuleGroupsResponse_httpStatus :: Lens' DeleteFirewallManagerRuleGroupsResponse Int Source #
The response's http status code.
DeleteIPSet
deleteIPSet_name :: Lens' DeleteIPSet Text Source #
The name of the IP set. You cannot change the name of an IPSet
after
you create it.
deleteIPSet_scope :: Lens' DeleteIPSet Scope Source #
Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, or an Amazon Cognito user pool.
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.
deleteIPSet_id :: Lens' DeleteIPSet Text Source #
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.
deleteIPSet_lockToken :: Lens' DeleteIPSet Text Source #
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.
deleteIPSetResponse_httpStatus :: Lens' DeleteIPSetResponse Int Source #
The response's http status code.
DeleteLoggingConfiguration
deleteLoggingConfiguration_resourceArn :: Lens' DeleteLoggingConfiguration Text Source #
The Amazon Resource Name (ARN) of the web ACL from which you want to delete the LoggingConfiguration.
deleteLoggingConfigurationResponse_httpStatus :: Lens' DeleteLoggingConfigurationResponse Int Source #
The response's http status code.
DeletePermissionPolicy
deletePermissionPolicy_resourceArn :: Lens' DeletePermissionPolicy Text Source #
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.
deletePermissionPolicyResponse_httpStatus :: Lens' DeletePermissionPolicyResponse Int Source #
The response's http status code.
DeleteRegexPatternSet
deleteRegexPatternSet_name :: Lens' DeleteRegexPatternSet Text Source #
The name of the set. You cannot change the name after you create the set.
deleteRegexPatternSet_scope :: Lens' DeleteRegexPatternSet Scope Source #
Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, or an Amazon Cognito user pool.
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.
deleteRegexPatternSet_id :: Lens' DeleteRegexPatternSet Text Source #
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.
deleteRegexPatternSet_lockToken :: Lens' DeleteRegexPatternSet Text Source #
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.
deleteRegexPatternSetResponse_httpStatus :: Lens' DeleteRegexPatternSetResponse Int Source #
The response's http status code.
DeleteRuleGroup
deleteRuleGroup_name :: Lens' DeleteRuleGroup Text Source #
The name of the rule group. You cannot change the name of a rule group after you create it.
deleteRuleGroup_scope :: Lens' DeleteRuleGroup Scope Source #
Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, or an Amazon Cognito user pool.
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.
deleteRuleGroup_id :: Lens' DeleteRuleGroup Text Source #
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.
deleteRuleGroup_lockToken :: Lens' DeleteRuleGroup Text Source #
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.
deleteRuleGroupResponse_httpStatus :: Lens' DeleteRuleGroupResponse Int Source #
The response's http status code.
DeleteWebACL
deleteWebACL_name :: Lens' DeleteWebACL Text Source #
The name of the web ACL. You cannot change the name of a web ACL after you create it.
deleteWebACL_scope :: Lens' DeleteWebACL Scope Source #
Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, or an Amazon Cognito user pool.
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.
deleteWebACL_id :: Lens' DeleteWebACL Text Source #
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.
deleteWebACL_lockToken :: Lens' DeleteWebACL Text Source #
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.
deleteWebACLResponse_httpStatus :: Lens' DeleteWebACLResponse Int Source #
The response's http status code.
DescribeManagedRuleGroup
describeManagedRuleGroup_versionName :: Lens' DescribeManagedRuleGroup (Maybe Text) Source #
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.
describeManagedRuleGroup_vendorName :: Lens' DescribeManagedRuleGroup Text Source #
The name of the managed rule group vendor. You use this, along with the rule group name, to identify the rule group.
describeManagedRuleGroup_name :: Lens' DescribeManagedRuleGroup Text Source #
The name of the managed rule group. You use this, along with the vendor name, to identify the rule group.
describeManagedRuleGroup_scope :: Lens' DescribeManagedRuleGroup Scope Source #
Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, or an Amazon Cognito user pool.
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.
describeManagedRuleGroupResponse_availableLabels :: Lens' DescribeManagedRuleGroupResponse (Maybe [LabelSummary]) Source #
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.
describeManagedRuleGroupResponse_capacity :: Lens' DescribeManagedRuleGroupResponse (Maybe Natural) Source #
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.
describeManagedRuleGroupResponse_consumedLabels :: Lens' DescribeManagedRuleGroupResponse (Maybe [LabelSummary]) Source #
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.
describeManagedRuleGroupResponse_labelNamespace :: Lens' DescribeManagedRuleGroupResponse (Maybe Text) Source #
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>
describeManagedRuleGroupResponse_rules :: Lens' DescribeManagedRuleGroupResponse (Maybe [RuleSummary]) Source #
describeManagedRuleGroupResponse_snsTopicArn :: Lens' DescribeManagedRuleGroupResponse (Maybe Text) Source #
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.
describeManagedRuleGroupResponse_versionName :: Lens' DescribeManagedRuleGroupResponse (Maybe Text) Source #
The managed rule group's version.
describeManagedRuleGroupResponse_httpStatus :: Lens' DescribeManagedRuleGroupResponse Int Source #
The response's http status code.
DisassociateWebACL
disassociateWebACL_resourceArn :: Lens' DisassociateWebACL Text Source #
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
- For an Amazon Cognito user pool:
arn:aws:cognito-idp:
region
:
account-id
:userpool/
user-pool-id
disassociateWebACLResponse_httpStatus :: Lens' DisassociateWebACLResponse Int Source #
The response's http status code.
GenerateMobileSdkReleaseUrl
generateMobileSdkReleaseUrl_platform :: Lens' GenerateMobileSdkReleaseUrl Platform Source #
The device platform.
generateMobileSdkReleaseUrl_releaseVersion :: Lens' GenerateMobileSdkReleaseUrl Text Source #
The release version. For the latest available version, specify LATEST
.
generateMobileSdkReleaseUrlResponse_url :: Lens' GenerateMobileSdkReleaseUrlResponse (Maybe Text) Source #
The presigned download URL for the specified SDK release.
generateMobileSdkReleaseUrlResponse_httpStatus :: Lens' GenerateMobileSdkReleaseUrlResponse Int Source #
The response's http status code.
GetIPSet
getIPSet_name :: Lens' GetIPSet Text Source #
The name of the IP set. You cannot change the name of an IPSet
after
you create it.
getIPSet_scope :: Lens' GetIPSet Scope Source #
Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, or an Amazon Cognito user pool.
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.
getIPSet_id :: Lens' GetIPSet Text Source #
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.
getIPSetResponse_lockToken :: Lens' GetIPSetResponse (Maybe Text) Source #
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.
getIPSetResponse_httpStatus :: Lens' GetIPSetResponse Int Source #
The response's http status code.
GetLoggingConfiguration
getLoggingConfiguration_resourceArn :: Lens' GetLoggingConfiguration Text Source #
The Amazon Resource Name (ARN) of the web ACL for which you want to get the LoggingConfiguration.
getLoggingConfigurationResponse_loggingConfiguration :: Lens' GetLoggingConfigurationResponse (Maybe LoggingConfiguration) Source #
The LoggingConfiguration for the specified web ACL.
getLoggingConfigurationResponse_httpStatus :: Lens' GetLoggingConfigurationResponse Int Source #
The response's http status code.
GetManagedRuleSet
getManagedRuleSet_name :: Lens' GetManagedRuleSet Text Source #
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.
getManagedRuleSet_scope :: Lens' GetManagedRuleSet Scope Source #
Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, or an Amazon Cognito user pool.
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.
getManagedRuleSet_id :: Lens' GetManagedRuleSet Text Source #
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
.
getManagedRuleSetResponse_lockToken :: Lens' GetManagedRuleSetResponse (Maybe Text) Source #
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.
getManagedRuleSetResponse_managedRuleSet :: Lens' GetManagedRuleSetResponse (Maybe ManagedRuleSet) Source #
The managed rule set that you requested.
getManagedRuleSetResponse_httpStatus :: Lens' GetManagedRuleSetResponse Int Source #
The response's http status code.
GetMobileSdkRelease
getMobileSdkRelease_platform :: Lens' GetMobileSdkRelease Platform Source #
The device platform.
getMobileSdkRelease_releaseVersion :: Lens' GetMobileSdkRelease Text Source #
The release version. For the latest available version, specify LATEST
.
getMobileSdkReleaseResponse_mobileSdkRelease :: Lens' GetMobileSdkReleaseResponse (Maybe MobileSdkRelease) Source #
Information for a specified SDK release, including release notes and tags.
getMobileSdkReleaseResponse_httpStatus :: Lens' GetMobileSdkReleaseResponse Int Source #
The response's http status code.
GetPermissionPolicy
getPermissionPolicy_resourceArn :: Lens' GetPermissionPolicy Text Source #
The Amazon Resource Name (ARN) of the rule group for which you want to get the policy.
getPermissionPolicyResponse_policy :: Lens' GetPermissionPolicyResponse (Maybe Text) Source #
The IAM policy that is attached to the specified rule group.
getPermissionPolicyResponse_httpStatus :: Lens' GetPermissionPolicyResponse Int Source #
The response's http status code.
GetRateBasedStatementManagedKeys
getRateBasedStatementManagedKeys_ruleGroupRuleName :: Lens' GetRateBasedStatementManagedKeys (Maybe Text) Source #
The name of the rule group reference statement in your web ACL. This is required only when you have the rate-based rule nested inside a rule group.
getRateBasedStatementManagedKeys_scope :: Lens' GetRateBasedStatementManagedKeys Scope Source #
Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, or an Amazon Cognito user pool.
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.
getRateBasedStatementManagedKeys_webACLName :: Lens' GetRateBasedStatementManagedKeys Text Source #
The name of the web ACL. You cannot change the name of a web ACL after you create it.
getRateBasedStatementManagedKeys_webACLId :: Lens' GetRateBasedStatementManagedKeys Text Source #
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.
getRateBasedStatementManagedKeys_ruleName :: Lens' GetRateBasedStatementManagedKeys Text Source #
The name of the rate-based rule to get the keys for. If you have the
rule defined inside a rule group that you're using in your web ACL,
also provide the name of the rule group reference statement in the
request parameter RuleGroupRuleName
.
getRateBasedStatementManagedKeysResponse_managedKeysIPV4 :: Lens' GetRateBasedStatementManagedKeysResponse (Maybe RateBasedStatementManagedKeysIPSet) Source #
The keys that are of Internet Protocol version 4 (IPv4).
getRateBasedStatementManagedKeysResponse_managedKeysIPV6 :: Lens' GetRateBasedStatementManagedKeysResponse (Maybe RateBasedStatementManagedKeysIPSet) Source #
The keys that are of Internet Protocol version 6 (IPv6).
getRateBasedStatementManagedKeysResponse_httpStatus :: Lens' GetRateBasedStatementManagedKeysResponse Int Source #
The response's http status code.
GetRegexPatternSet
getRegexPatternSet_name :: Lens' GetRegexPatternSet Text Source #
The name of the set. You cannot change the name after you create the set.
getRegexPatternSet_scope :: Lens' GetRegexPatternSet Scope Source #
Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, or an Amazon Cognito user pool.
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.
getRegexPatternSet_id :: Lens' GetRegexPatternSet Text Source #
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.
getRegexPatternSetResponse_lockToken :: Lens' GetRegexPatternSetResponse (Maybe Text) Source #
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.
getRegexPatternSetResponse_regexPatternSet :: Lens' GetRegexPatternSetResponse (Maybe RegexPatternSet) Source #
getRegexPatternSetResponse_httpStatus :: Lens' GetRegexPatternSetResponse Int Source #
The response's http status code.
GetRuleGroup
getRuleGroup_arn :: Lens' GetRuleGroup (Maybe Text) Source #
The Amazon Resource Name (ARN) of the entity.
getRuleGroup_id :: Lens' GetRuleGroup (Maybe Text) Source #
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.
getRuleGroup_name :: Lens' GetRuleGroup (Maybe Text) Source #
The name of the rule group. You cannot change the name of a rule group after you create it.
getRuleGroup_scope :: Lens' GetRuleGroup (Maybe Scope) Source #
Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, or an Amazon Cognito user pool.
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.
getRuleGroupResponse_lockToken :: Lens' GetRuleGroupResponse (Maybe Text) Source #
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.
getRuleGroupResponse_httpStatus :: Lens' GetRuleGroupResponse Int Source #
The response's http status code.
GetSampledRequests
getSampledRequests_webAclArn :: Lens' GetSampledRequests Text Source #
The Amazon resource name (ARN) of the WebACL
for which you want a
sample of requests.
getSampledRequests_ruleMetricName :: Lens' GetSampledRequests Text Source #
The metric name assigned to the Rule
or RuleGroup
for which you want
a sample of requests.
getSampledRequests_scope :: Lens' GetSampledRequests Scope Source #
Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, or an Amazon Cognito user pool.
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.
getSampledRequests_timeWindow :: Lens' GetSampledRequests TimeWindow Source #
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.
getSampledRequests_maxItems :: Lens' GetSampledRequests Natural Source #
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.
getSampledRequestsResponse_populationSize :: Lens' GetSampledRequestsResponse (Maybe Integer) Source #
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.
getSampledRequestsResponse_sampledRequests :: Lens' GetSampledRequestsResponse (Maybe [SampledHTTPRequest]) Source #
A complex type that contains detailed information about each of the requests in the sample.
getSampledRequestsResponse_timeWindow :: Lens' GetSampledRequestsResponse (Maybe TimeWindow) Source #
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.
getSampledRequestsResponse_httpStatus :: Lens' GetSampledRequestsResponse Int Source #
The response's http status code.
GetWebACL
getWebACL_name :: Lens' GetWebACL Text Source #
The name of the web ACL. You cannot change the name of a web ACL after you create it.
getWebACL_scope :: Lens' GetWebACL Scope Source #
Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, or an Amazon Cognito user pool.
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.
getWebACL_id :: Lens' GetWebACL Text Source #
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.
getWebACLResponse_applicationIntegrationURL :: Lens' GetWebACLResponse (Maybe Text) Source #
The URL to use in SDK integrations with Amazon Web Services managed rule
groups. For example, you can use the integration SDKs with the account
takeover prevention managed rule group AWSManagedRulesATPRuleSet
. This
is only populated if you are using a rule group in your web ACL that
integrates with your applications in this way. For more information, see
WAF client application integration
in the WAF Developer Guide.
getWebACLResponse_lockToken :: Lens' GetWebACLResponse (Maybe Text) Source #
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.
getWebACLResponse_webACL :: Lens' GetWebACLResponse (Maybe WebACL) Source #
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.
getWebACLResponse_httpStatus :: Lens' GetWebACLResponse Int Source #
The response's http status code.
GetWebACLForResource
getWebACLForResource_resourceArn :: Lens' GetWebACLForResource Text Source #
The Amazon Resource Name (ARN) of the resource whose web ACL you want to retrieve.
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
- For an Amazon Cognito user pool:
arn:aws:cognito-idp:
region
:
account-id
:userpool/
user-pool-id
getWebACLForResourceResponse_webACL :: Lens' GetWebACLForResourceResponse (Maybe WebACL) Source #
The web ACL that is associated with the resource. If there is no associated resource, WAF returns a null web ACL.
getWebACLForResourceResponse_httpStatus :: Lens' GetWebACLForResourceResponse Int Source #
The response's http status code.
ListAvailableManagedRuleGroupVersions
listAvailableManagedRuleGroupVersions_limit :: Lens' ListAvailableManagedRuleGroupVersions (Maybe Natural) Source #
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.
listAvailableManagedRuleGroupVersions_nextMarker :: Lens' ListAvailableManagedRuleGroupVersions (Maybe Text) Source #
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.
listAvailableManagedRuleGroupVersions_vendorName :: Lens' ListAvailableManagedRuleGroupVersions Text Source #
The name of the managed rule group vendor. You use this, along with the rule group name, to identify the rule group.
listAvailableManagedRuleGroupVersions_name :: Lens' ListAvailableManagedRuleGroupVersions Text Source #
The name of the managed rule group. You use this, along with the vendor name, to identify the rule group.
listAvailableManagedRuleGroupVersions_scope :: Lens' ListAvailableManagedRuleGroupVersions Scope Source #
Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, or an Amazon Cognito user pool.
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.
listAvailableManagedRuleGroupVersionsResponse_currentDefaultVersion :: Lens' ListAvailableManagedRuleGroupVersionsResponse (Maybe Text) Source #
The name of the version that's currently set as the default.
listAvailableManagedRuleGroupVersionsResponse_nextMarker :: Lens' ListAvailableManagedRuleGroupVersionsResponse (Maybe Text) Source #
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.
listAvailableManagedRuleGroupVersionsResponse_versions :: Lens' ListAvailableManagedRuleGroupVersionsResponse (Maybe [ManagedRuleGroupVersion]) Source #
The versions that are currently available for the specified managed rule group.
listAvailableManagedRuleGroupVersionsResponse_httpStatus :: Lens' ListAvailableManagedRuleGroupVersionsResponse Int Source #
The response's http status code.
ListAvailableManagedRuleGroups
listAvailableManagedRuleGroups_limit :: Lens' ListAvailableManagedRuleGroups (Maybe Natural) Source #
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.
listAvailableManagedRuleGroups_nextMarker :: Lens' ListAvailableManagedRuleGroups (Maybe Text) Source #
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.
listAvailableManagedRuleGroups_scope :: Lens' ListAvailableManagedRuleGroups Scope Source #
Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, or an Amazon Cognito user pool.
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.
listAvailableManagedRuleGroupsResponse_managedRuleGroups :: Lens' ListAvailableManagedRuleGroupsResponse (Maybe [ManagedRuleGroupSummary]) Source #
listAvailableManagedRuleGroupsResponse_nextMarker :: Lens' ListAvailableManagedRuleGroupsResponse (Maybe Text) Source #
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.
listAvailableManagedRuleGroupsResponse_httpStatus :: Lens' ListAvailableManagedRuleGroupsResponse Int Source #
The response's http status code.
ListIPSets
listIPSets_limit :: Lens' ListIPSets (Maybe Natural) Source #
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.
listIPSets_nextMarker :: Lens' ListIPSets (Maybe Text) Source #
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.
listIPSets_scope :: Lens' ListIPSets Scope Source #
Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, or an Amazon Cognito user pool.
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.
listIPSetsResponse_iPSets :: Lens' ListIPSetsResponse (Maybe [IPSetSummary]) Source #
Array of IPSets. This may not be the full list of IPSets that you have
defined. See the Limit
specification for this request.
listIPSetsResponse_nextMarker :: Lens' ListIPSetsResponse (Maybe Text) Source #
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.
listIPSetsResponse_httpStatus :: Lens' ListIPSetsResponse Int Source #
The response's http status code.
ListLoggingConfigurations
listLoggingConfigurations_limit :: Lens' ListLoggingConfigurations (Maybe Natural) Source #
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.
listLoggingConfigurations_nextMarker :: Lens' ListLoggingConfigurations (Maybe Text) Source #
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.
listLoggingConfigurations_scope :: Lens' ListLoggingConfigurations Scope Source #
Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, or an Amazon Cognito user pool.
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.
listLoggingConfigurationsResponse_loggingConfigurations :: Lens' ListLoggingConfigurationsResponse (Maybe [LoggingConfiguration]) Source #
listLoggingConfigurationsResponse_nextMarker :: Lens' ListLoggingConfigurationsResponse (Maybe Text) Source #
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.
listLoggingConfigurationsResponse_httpStatus :: Lens' ListLoggingConfigurationsResponse Int Source #
The response's http status code.
ListManagedRuleSets
listManagedRuleSets_limit :: Lens' ListManagedRuleSets (Maybe Natural) Source #
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.
listManagedRuleSets_nextMarker :: Lens' ListManagedRuleSets (Maybe Text) Source #
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.
listManagedRuleSets_scope :: Lens' ListManagedRuleSets Scope Source #
Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, or an Amazon Cognito user pool.
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.
listManagedRuleSetsResponse_managedRuleSets :: Lens' ListManagedRuleSetsResponse (Maybe [ManagedRuleSetSummary]) Source #
Your managed rule sets.
listManagedRuleSetsResponse_nextMarker :: Lens' ListManagedRuleSetsResponse (Maybe Text) Source #
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.
listManagedRuleSetsResponse_httpStatus :: Lens' ListManagedRuleSetsResponse Int Source #
The response's http status code.
ListMobileSdkReleases
listMobileSdkReleases_limit :: Lens' ListMobileSdkReleases (Maybe Natural) Source #
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.
listMobileSdkReleases_nextMarker :: Lens' ListMobileSdkReleases (Maybe Text) Source #
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.
listMobileSdkReleases_platform :: Lens' ListMobileSdkReleases Platform Source #
The device platform to retrieve the list for.
listMobileSdkReleasesResponse_nextMarker :: Lens' ListMobileSdkReleasesResponse (Maybe Text) Source #
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.
listMobileSdkReleasesResponse_releaseSummaries :: Lens' ListMobileSdkReleasesResponse (Maybe [ReleaseSummary]) Source #
High level information for the available SDK releases.
listMobileSdkReleasesResponse_httpStatus :: Lens' ListMobileSdkReleasesResponse Int Source #
The response's http status code.
ListRegexPatternSets
listRegexPatternSets_limit :: Lens' ListRegexPatternSets (Maybe Natural) Source #
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.
listRegexPatternSets_nextMarker :: Lens' ListRegexPatternSets (Maybe Text) Source #
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.
listRegexPatternSets_scope :: Lens' ListRegexPatternSets Scope Source #
Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, or an Amazon Cognito user pool.
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.
listRegexPatternSetsResponse_nextMarker :: Lens' ListRegexPatternSetsResponse (Maybe Text) Source #
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.
listRegexPatternSetsResponse_regexPatternSets :: Lens' ListRegexPatternSetsResponse (Maybe [RegexPatternSetSummary]) Source #
listRegexPatternSetsResponse_httpStatus :: Lens' ListRegexPatternSetsResponse Int Source #
The response's http status code.
ListResourcesForWebACL
listResourcesForWebACL_resourceType :: Lens' ListResourcesForWebACL (Maybe ResourceType) Source #
Used for web ACLs that are scoped for regional applications. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, or an Amazon Cognito user pool.
If you don't provide a resource type, the call uses the resource type
APPLICATION_LOAD_BALANCER
.
Default: APPLICATION_LOAD_BALANCER
listResourcesForWebACL_webACLArn :: Lens' ListResourcesForWebACL Text Source #
The Amazon Resource Name (ARN) of the web ACL.
listResourcesForWebACLResponse_resourceArns :: Lens' ListResourcesForWebACLResponse (Maybe [Text]) Source #
The array of Amazon Resource Names (ARNs) of the associated resources.
listResourcesForWebACLResponse_httpStatus :: Lens' ListResourcesForWebACLResponse Int Source #
The response's http status code.
ListRuleGroups
listRuleGroups_limit :: Lens' ListRuleGroups (Maybe Natural) Source #
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.
listRuleGroups_nextMarker :: Lens' ListRuleGroups (Maybe Text) Source #
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.
listRuleGroups_scope :: Lens' ListRuleGroups Scope Source #
Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, or an Amazon Cognito user pool.
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.
listRuleGroupsResponse_nextMarker :: Lens' ListRuleGroupsResponse (Maybe Text) Source #
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.
listRuleGroupsResponse_ruleGroups :: Lens' ListRuleGroupsResponse (Maybe [RuleGroupSummary]) Source #
listRuleGroupsResponse_httpStatus :: Lens' ListRuleGroupsResponse Int Source #
The response's http status code.
ListTagsForResource
listTagsForResource_limit :: Lens' ListTagsForResource (Maybe Natural) Source #
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.
listTagsForResource_nextMarker :: Lens' ListTagsForResource (Maybe Text) Source #
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.
listTagsForResource_resourceARN :: Lens' ListTagsForResource Text Source #
The Amazon Resource Name (ARN) of the resource.
listTagsForResourceResponse_nextMarker :: Lens' ListTagsForResourceResponse (Maybe Text) Source #
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.
listTagsForResourceResponse_tagInfoForResource :: Lens' ListTagsForResourceResponse (Maybe TagInfoForResource) Source #
The collection of tagging definitions for the resource.
listTagsForResourceResponse_httpStatus :: Lens' ListTagsForResourceResponse Int Source #
The response's http status code.
ListWebACLs
listWebACLs_limit :: Lens' ListWebACLs (Maybe Natural) Source #
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.
listWebACLs_nextMarker :: Lens' ListWebACLs (Maybe Text) Source #
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.
listWebACLs_scope :: Lens' ListWebACLs Scope Source #
Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, or an Amazon Cognito user pool.
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.
listWebACLsResponse_nextMarker :: Lens' ListWebACLsResponse (Maybe Text) Source #
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.
listWebACLsResponse_httpStatus :: Lens' ListWebACLsResponse Int Source #
The response's http status code.
PutLoggingConfiguration
putLoggingConfiguration_loggingConfiguration :: Lens' PutLoggingConfiguration LoggingConfiguration Source #
putLoggingConfigurationResponse_loggingConfiguration :: Lens' PutLoggingConfigurationResponse (Maybe LoggingConfiguration) Source #
putLoggingConfigurationResponse_httpStatus :: Lens' PutLoggingConfigurationResponse Int Source #
The response's http status code.
PutManagedRuleSetVersions
putManagedRuleSetVersions_recommendedVersion :: Lens' PutManagedRuleSetVersions (Maybe Text) Source #
The version of the named managed rule group that you'd like your customers to choose, from among your version offerings.
putManagedRuleSetVersions_versionsToPublish :: Lens' PutManagedRuleSetVersions (Maybe (HashMap Text VersionToPublish)) Source #
The versions of the named managed rule group that you want to offer to your customers.
putManagedRuleSetVersions_name :: Lens' PutManagedRuleSetVersions Text Source #
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.
putManagedRuleSetVersions_scope :: Lens' PutManagedRuleSetVersions Scope Source #
Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, or an Amazon Cognito user pool.
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.
putManagedRuleSetVersions_id :: Lens' PutManagedRuleSetVersions Text Source #
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
.
putManagedRuleSetVersions_lockToken :: Lens' PutManagedRuleSetVersions Text Source #
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.
putManagedRuleSetVersionsResponse_nextLockToken :: Lens' PutManagedRuleSetVersionsResponse (Maybe Text) Source #
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.
putManagedRuleSetVersionsResponse_httpStatus :: Lens' PutManagedRuleSetVersionsResponse Int Source #
The response's http status code.
PutPermissionPolicy
putPermissionPolicy_resourceArn :: Lens' PutPermissionPolicy Text Source #
The Amazon Resource Name (ARN) of the RuleGroup to which you want to attach the policy.
putPermissionPolicy_policy :: Lens' PutPermissionPolicy Text Source #
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
, andPrincipal
. Effect
must specifyAllow
.Action
must specifywafv2:CreateWebACL
,wafv2:UpdateWebACL
, andwafv2:PutFirewallManagerRuleGroups
and may optionally specifywafv2:GetRuleGroup
. 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.
putPermissionPolicyResponse_httpStatus :: Lens' PutPermissionPolicyResponse Int Source #
The response's http status code.
TagResource
tagResource_resourceARN :: Lens' TagResource Text Source #
The Amazon Resource Name (ARN) of the resource.
tagResource_tags :: Lens' TagResource (NonEmpty Tag) Source #
An array of key:value pairs to associate with the resource.
tagResourceResponse_httpStatus :: Lens' TagResourceResponse Int Source #
The response's http status code.
UntagResource
untagResource_resourceARN :: Lens' UntagResource Text Source #
The Amazon Resource Name (ARN) of the resource.
untagResource_tagKeys :: Lens' UntagResource (NonEmpty Text) Source #
An array of keys identifying the tags to disassociate from the resource.
untagResourceResponse_httpStatus :: Lens' UntagResourceResponse Int Source #
The response's http status code.
UpdateIPSet
updateIPSet_description :: Lens' UpdateIPSet (Maybe Text) Source #
A description of the IP set that helps with identification.
updateIPSet_name :: Lens' UpdateIPSet Text Source #
The name of the IP set. You cannot change the name of an IPSet
after
you create it.
updateIPSet_scope :: Lens' UpdateIPSet Scope Source #
Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, or an Amazon Cognito user pool.
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.
updateIPSet_id :: Lens' UpdateIPSet Text Source #
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.
updateIPSet_addresses :: Lens' UpdateIPSet [Text] Source #
Contains an array of strings that specifies zero or more IP addresses or
blocks of IP addresses. All addresses must be specified using Classless
Inter-Domain Routing (CIDR) notation. WAF supports all IPv4 and IPv6
CIDR ranges except for /0
.
Example address strings:
- 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.
Example JSON Addresses
specifications:
- Empty array:
"Addresses": []
- Array with one address:
"Addresses": ["192.0.2.44/32"]
- Array with three addresses:
"Addresses": ["192.0.2.44/32", "192.0.2.0/24", "192.0.0.0/16"]
- INVALID specification:
"Addresses": [""]
INVALID
updateIPSet_lockToken :: Lens' UpdateIPSet Text Source #
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.
updateIPSetResponse_nextLockToken :: Lens' UpdateIPSetResponse (Maybe Text) Source #
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
.
updateIPSetResponse_httpStatus :: Lens' UpdateIPSetResponse Int Source #
The response's http status code.
UpdateManagedRuleSetVersionExpiryDate
updateManagedRuleSetVersionExpiryDate_name :: Lens' UpdateManagedRuleSetVersionExpiryDate Text Source #
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.
updateManagedRuleSetVersionExpiryDate_scope :: Lens' UpdateManagedRuleSetVersionExpiryDate Scope Source #
Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, or an Amazon Cognito user pool.
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.
updateManagedRuleSetVersionExpiryDate_id :: Lens' UpdateManagedRuleSetVersionExpiryDate Text Source #
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
.
updateManagedRuleSetVersionExpiryDate_lockToken :: Lens' UpdateManagedRuleSetVersionExpiryDate Text Source #
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.
updateManagedRuleSetVersionExpiryDate_versionToExpire :: Lens' UpdateManagedRuleSetVersionExpiryDate Text Source #
The version that you want to remove from your list of offerings for the named managed rule group.
updateManagedRuleSetVersionExpiryDate_expiryTimestamp :: Lens' UpdateManagedRuleSetVersionExpiryDate UTCTime Source #
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".
updateManagedRuleSetVersionExpiryDateResponse_expiringVersion :: Lens' UpdateManagedRuleSetVersionExpiryDateResponse (Maybe Text) Source #
The version that is set to expire.
updateManagedRuleSetVersionExpiryDateResponse_expiryTimestamp :: Lens' UpdateManagedRuleSetVersionExpiryDateResponse (Maybe UTCTime) Source #
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".
updateManagedRuleSetVersionExpiryDateResponse_nextLockToken :: Lens' UpdateManagedRuleSetVersionExpiryDateResponse (Maybe Text) Source #
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.
updateManagedRuleSetVersionExpiryDateResponse_httpStatus :: Lens' UpdateManagedRuleSetVersionExpiryDateResponse Int Source #
The response's http status code.
UpdateRegexPatternSet
updateRegexPatternSet_description :: Lens' UpdateRegexPatternSet (Maybe Text) Source #
A description of the set that helps with identification.
updateRegexPatternSet_name :: Lens' UpdateRegexPatternSet Text Source #
The name of the set. You cannot change the name after you create the set.
updateRegexPatternSet_scope :: Lens' UpdateRegexPatternSet Scope Source #
Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, or an Amazon Cognito user pool.
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.
updateRegexPatternSet_id :: Lens' UpdateRegexPatternSet Text Source #
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.
updateRegexPatternSet_lockToken :: Lens' UpdateRegexPatternSet Text Source #
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.
updateRegexPatternSetResponse_nextLockToken :: Lens' UpdateRegexPatternSetResponse (Maybe Text) Source #
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
.
updateRegexPatternSetResponse_httpStatus :: Lens' UpdateRegexPatternSetResponse Int Source #
The response's http status code.
UpdateRuleGroup
updateRuleGroup_customResponseBodies :: Lens' UpdateRuleGroup (Maybe (HashMap Text CustomResponseBody)) Source #
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.
updateRuleGroup_description :: Lens' UpdateRuleGroup (Maybe Text) Source #
A description of the rule group that helps with identification.
updateRuleGroup_rules :: Lens' UpdateRuleGroup (Maybe [Rule]) Source #
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.
updateRuleGroup_name :: Lens' UpdateRuleGroup Text Source #
The name of the rule group. You cannot change the name of a rule group after you create it.
updateRuleGroup_scope :: Lens' UpdateRuleGroup Scope Source #
Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, or an Amazon Cognito user pool.
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.
updateRuleGroup_id :: Lens' UpdateRuleGroup Text Source #
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.
updateRuleGroup_visibilityConfig :: Lens' UpdateRuleGroup VisibilityConfig Source #
Defines and enables Amazon CloudWatch metrics and web request sample collection.
updateRuleGroup_lockToken :: Lens' UpdateRuleGroup Text Source #
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.
updateRuleGroupResponse_nextLockToken :: Lens' UpdateRuleGroupResponse (Maybe Text) Source #
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
.
updateRuleGroupResponse_httpStatus :: Lens' UpdateRuleGroupResponse Int Source #
The response's http status code.
UpdateWebACL
updateWebACL_captchaConfig :: Lens' UpdateWebACL (Maybe CaptchaConfig) Source #
Specifies how WAF should handle CAPTCHA
evaluations for rules that
don't have their own CaptchaConfig
settings. If you don't specify
this, WAF uses its default settings for CaptchaConfig
.
updateWebACL_challengeConfig :: Lens' UpdateWebACL (Maybe ChallengeConfig) Source #
Specifies how WAF should handle challenge evaluations for rules that
don't have their own ChallengeConfig
settings. If you don't specify
this, WAF uses its default settings for ChallengeConfig
.
updateWebACL_customResponseBodies :: Lens' UpdateWebACL (Maybe (HashMap Text CustomResponseBody)) Source #
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.
updateWebACL_description :: Lens' UpdateWebACL (Maybe Text) Source #
A description of the web ACL that helps with identification.
updateWebACL_rules :: Lens' UpdateWebACL (Maybe [Rule]) Source #
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.
updateWebACL_tokenDomains :: Lens' UpdateWebACL (Maybe (NonEmpty Text)) Source #
Specifies the domains that WAF should accept in a web request token. This enables the use of tokens across multiple protected websites. When WAF provides a token, it uses the domain of the Amazon Web Services resource that the web ACL is protecting. If you don't specify a list of token domains, WAF accepts tokens only for the domain of the protected resource. With a token domain list, WAF accepts the resource's host domain plus all domains in the token domain list, including their prefixed subdomains.
Example JSON:
"TokenDomains": { "mywebsite.com", "myotherwebsite.com" }
Public suffixes aren't allowed. For example, you can't use usa.gov
or co.uk
as token domains.
updateWebACL_name :: Lens' UpdateWebACL Text Source #
The name of the web ACL. You cannot change the name of a web ACL after you create it.
updateWebACL_scope :: Lens' UpdateWebACL Scope Source #
Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, or an Amazon Cognito user pool.
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.
updateWebACL_id :: Lens' UpdateWebACL Text Source #
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.
updateWebACL_defaultAction :: Lens' UpdateWebACL DefaultAction Source #
The action to perform if none of the Rules
contained in the WebACL
match.
updateWebACL_visibilityConfig :: Lens' UpdateWebACL VisibilityConfig Source #
Defines and enables Amazon CloudWatch metrics and web request sample collection.
updateWebACL_lockToken :: Lens' UpdateWebACL Text Source #
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.
updateWebACLResponse_nextLockToken :: Lens' UpdateWebACLResponse (Maybe Text) Source #
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
.
updateWebACLResponse_httpStatus :: Lens' UpdateWebACLResponse Int Source #
The response's http status code.
Types
AWSManagedRulesBotControlRuleSet
aWSManagedRulesBotControlRuleSet_inspectionLevel :: Lens' AWSManagedRulesBotControlRuleSet InspectionLevel Source #
The inspection level to use for the Bot Control rule group. The common level is the least expensive. The targeted level includes all common level rules and adds rules with more advanced inspection criteria. For details, see WAF Bot Control rule group.
ActionCondition
actionCondition_action :: Lens' ActionCondition ActionValue Source #
The action setting that a log record must contain in order to meet the condition. This is the action that WAF applied to the web request.
For rule groups, this is either the configured rule action setting, or
if you've applied a rule action override to the rule, it's the
override action. The value EXCLUDED_AS_COUNT
matches on excluded rules
and also on rules that have a rule action override of Count.
All
AllQueryArguments
AllowAction
allowAction_customRequestHandling :: Lens' AllowAction (Maybe CustomRequestHandling) Source #
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.
AndStatement
andStatement_statements :: Lens' AndStatement [Statement] Source #
The statements to combine with AND logic. You can use any statements that can be nested.
BlockAction
blockAction_customResponse :: Lens' BlockAction (Maybe CustomResponse) Source #
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.
Body
body_oversizeHandling :: Lens' Body (Maybe OversizeHandling) Source #
What WAF should do if the body is larger than WAF can inspect. WAF does not support inspecting the entire contents of the body of a web request when the body exceeds 8 KB (8192 bytes). Only the first 8 KB of the request body are forwarded to WAF by the underlying host service.
The options for oversize handling are the following:
CONTINUE
- Inspect the body normally, according to the rule inspection criteria.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.
You can combine the MATCH
or NO_MATCH
settings for oversize handling
with your rule and web ACL action settings, so that you block any
request whose body is over 8 KB.
Default: CONTINUE
ByteMatchStatement
byteMatchStatement_searchString :: Lens' ByteMatchStatement ByteString Source #
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.--
-- Note: This Lens
automatically encodes and decodes Base64 data.
-- The underlying isomorphism will encode to Base64 representation during
-- serialisation, and decode from Base64 representation during deserialisation.
-- This Lens
accepts and returns only raw unencoded data.
byteMatchStatement_fieldToMatch :: Lens' ByteMatchStatement FieldToMatch Source #
The part of the web request that you want WAF to inspect.
byteMatchStatement_textTransformations :: Lens' ByteMatchStatement (NonEmpty TextTransformation) Source #
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.
byteMatchStatement_positionalConstraint :: Lens' ByteMatchStatement PositionalConstraint Source #
The area within the portion of the 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.
CaptchaAction
captchaAction_customRequestHandling :: Lens' CaptchaAction (Maybe CustomRequestHandling) Source #
Defines custom handling for the web request, used when the CAPTCHA
inspection determines that the request's token is valid and unexpired.
For information about customizing web requests and responses, see Customizing web requests and responses in WAF in the WAF Developer Guide.
CaptchaConfig
captchaConfig_immunityTimeProperty :: Lens' CaptchaConfig (Maybe ImmunityTimeProperty) Source #
Determines how long a CAPTCHA
timestamp in the token remains valid
after the client successfully solves a CAPTCHA
puzzle.
CaptchaResponse
captchaResponse_failureReason :: Lens' CaptchaResponse (Maybe FailureReason) Source #
The reason for failure, populated when the evaluation of the token fails.
captchaResponse_responseCode :: Lens' CaptchaResponse (Maybe Int) Source #
The HTTP response code indicating the status of the CAPTCHA
token in
the web request. If the token is missing, invalid, or expired, this code
is 405 Method Not Allowed
.
captchaResponse_solveTimestamp :: Lens' CaptchaResponse (Maybe Integer) Source #
The time that the CAPTCHA
was last solved for the supplied token.
ChallengeAction
challengeAction_customRequestHandling :: Lens' ChallengeAction (Maybe CustomRequestHandling) Source #
Defines custom handling for the web request, used when the challenge inspection determines that the request's token is valid and unexpired.
For information about customizing web requests and responses, see Customizing web requests and responses in WAF in the WAF Developer Guide.
ChallengeConfig
challengeConfig_immunityTimeProperty :: Lens' ChallengeConfig (Maybe ImmunityTimeProperty) Source #
Determines how long a challenge timestamp in the token remains valid after the client successfully responds to a challenge.
ChallengeResponse
challengeResponse_failureReason :: Lens' ChallengeResponse (Maybe FailureReason) Source #
The reason for failure, populated when the evaluation of the token fails.
challengeResponse_responseCode :: Lens' ChallengeResponse (Maybe Int) Source #
The HTTP response code indicating the status of the challenge token in
the web request. If the token is missing, invalid, or expired, this code
is 202 Request Accepted
.
challengeResponse_solveTimestamp :: Lens' ChallengeResponse (Maybe Integer) Source #
The time that the challenge was last solved for the supplied token.
Condition
condition_actionCondition :: Lens' Condition (Maybe ActionCondition) Source #
A single action condition. This is the action setting that a log record must contain in order to meet the condition.
condition_labelNameCondition :: Lens' Condition (Maybe LabelNameCondition) Source #
A single label name condition. This is the fully qualified label name that a log record must contain in order to meet the condition. 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.
CookieMatchPattern
cookieMatchPattern_all :: Lens' CookieMatchPattern (Maybe All) Source #
Inspect all cookies.
cookieMatchPattern_excludedCookies :: Lens' CookieMatchPattern (Maybe (NonEmpty Text)) Source #
Inspect only the cookies whose keys don't match any of the strings specified here.
cookieMatchPattern_includedCookies :: Lens' CookieMatchPattern (Maybe (NonEmpty Text)) Source #
Inspect only the cookies that have a key that matches one of the strings specified here.
Cookies
cookies_matchPattern :: Lens' Cookies CookieMatchPattern Source #
The filter to use to identify the subset of cookies to inspect in a web request.
You must specify exactly one setting: either All
, IncludedCookies
,
or ExcludedCookies
.
Example JSON:
"MatchPattern": { "IncludedCookies": {"KeyToInclude1", "KeyToInclude2", "KeyToInclude3"} }
cookies_matchScope :: Lens' Cookies MapMatchScope Source #
The parts of the cookies to inspect with the rule inspection criteria.
If you specify All
, WAF inspects both keys and values.
cookies_oversizeHandling :: Lens' Cookies OversizeHandling Source #
What WAF should do if the cookies of the request are larger than WAF can inspect. WAF does not support inspecting the entire contents of request cookies when they exceed 8 KB (8192 bytes) or 200 total cookies. The underlying host service forwards a maximum of 200 cookies and at most 8 KB of cookie contents to WAF.
The options for oversize handling are the following:
CONTINUE
- Inspect the cookies normally, according to the rule inspection criteria.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.
CountAction
countAction_customRequestHandling :: Lens' CountAction (Maybe CustomRequestHandling) Source #
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.
CustomHTTPHeader
customHTTPHeader_name :: Lens' CustomHTTPHeader Text Source #
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
.
customHTTPHeader_value :: Lens' CustomHTTPHeader Text Source #
The value of the custom header.
CustomRequestHandling
customRequestHandling_insertHeaders :: Lens' CustomRequestHandling (NonEmpty CustomHTTPHeader) Source #
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.
CustomResponse
customResponse_customResponseBodyKey :: Lens' CustomResponse (Maybe Text) Source #
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.
customResponse_responseHeaders :: Lens' CustomResponse (Maybe (NonEmpty CustomHTTPHeader)) Source #
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.
customResponse_responseCode :: Lens' CustomResponse Natural Source #
The HTTP status code to return to the client.
For a list of status codes that you can use in your custom responses, see Supported status codes for custom response in the WAF Developer Guide.
CustomResponseBody
customResponseBody_contentType :: Lens' CustomResponseBody ResponseContentType Source #
The type of content in the payload that you are defining in the
Content
string.
customResponseBody_content :: Lens' CustomResponseBody Text Source #
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.
DefaultAction
defaultAction_allow :: Lens' DefaultAction (Maybe AllowAction) Source #
Specifies that WAF should allow requests by default.
defaultAction_block :: Lens' DefaultAction (Maybe BlockAction) Source #
Specifies that WAF should block requests by default.
ExcludedRule
excludedRule_name :: Lens' ExcludedRule Text Source #
The name of the rule whose action you want to override to Count
.
FieldToMatch
fieldToMatch_allQueryArguments :: Lens' FieldToMatch (Maybe AllQueryArguments) Source #
Inspect all query arguments.
fieldToMatch_body :: Lens' FieldToMatch (Maybe Body) Source #
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.
Only the first 8 KB (8192 bytes) of the request body are forwarded to
WAF for inspection by the underlying host service. For information about
how to handle oversized request bodies, see the Body
object
configuration.
fieldToMatch_cookies :: Lens' FieldToMatch (Maybe Cookies) Source #
Inspect the request cookies. You must configure scope and pattern
matching filters in the Cookies
object, to define the set of cookies
and the parts of the cookies that WAF inspects.
Only the first 8 KB (8192 bytes) of a request's cookies and only the
first 200 cookies are forwarded to WAF for inspection by the underlying
host service. You must configure how to handle any oversize cookie
content in the Cookies
object. WAF applies the pattern matching
filters to the cookies that it receives from the underlying host
service.
fieldToMatch_headers :: Lens' FieldToMatch (Maybe Headers) Source #
Inspect the request headers. You must configure scope and pattern
matching filters in the Headers
object, to define the set of headers
to and the parts of the headers that WAF inspects.
Only the first 8 KB (8192 bytes) of a request's headers and only the
first 200 headers are forwarded to WAF for inspection by the underlying
host service. You must configure how to handle any oversize header
content in the Headers
object. WAF applies the pattern matching
filters to the headers that it receives from the underlying host
service.
fieldToMatch_jsonBody :: Lens' FieldToMatch (Maybe JsonBody) Source #
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.
Only the first 8 KB (8192 bytes) of the request body are forwarded to
WAF for inspection by the underlying host service. For information about
how to handle oversized request bodies, see the JsonBody
object
configuration.
fieldToMatch_method :: Lens' FieldToMatch (Maybe Method) Source #
Inspect the HTTP method. The method indicates the type of operation that the request is asking the origin to perform.
fieldToMatch_queryString :: Lens' FieldToMatch (Maybe QueryString) Source #
Inspect the query string. This is the part of a URL that appears after a
?
character, if any.
fieldToMatch_singleHeader :: Lens' FieldToMatch (Maybe SingleHeader) Source #
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" }
Alternately, you can filter and inspect all headers with the Headers
FieldToMatch
setting.
fieldToMatch_singleQueryArgument :: Lens' FieldToMatch (Maybe SingleQueryArgument) Source #
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.
Example JSON: "SingleQueryArgument": { "Name": "myArgument" }
fieldToMatch_uriPath :: Lens' FieldToMatch (Maybe UriPath) Source #
Inspect the request URI path. This is the part of the web request that
identifies a resource, for example, /images/daily-ad.jpg
.
Filter
filter_behavior :: Lens' Filter FilterBehavior Source #
How to handle logs that satisfy the filter's conditions and requirement.
filter_requirement :: Lens' Filter FilterRequirement Source #
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.
FirewallManagerRuleGroup
firewallManagerRuleGroup_name :: Lens' FirewallManagerRuleGroup Text Source #
The name of the rule group. You cannot change the name of a rule group after you create it.
firewallManagerRuleGroup_priority :: Lens' FirewallManagerRuleGroup Natural Source #
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.
firewallManagerRuleGroup_firewallManagerStatement :: Lens' FirewallManagerRuleGroup FirewallManagerStatement Source #
The processing guidance for an Firewall Manager rule. This is like a regular rule Statement, but it can only contain a rule group reference.
firewallManagerRuleGroup_overrideAction :: Lens' FirewallManagerRuleGroup OverrideAction Source #
The action to use in the place of the action that results from the rule group evaluation. Set the override action to none to leave the result of the rule group alone. Set it to count to override the result to count only.
You can only use this for rule statements that reference a rule group,
like RuleGroupReferenceStatement
and ManagedRuleGroupStatement
.
This option is usually set to none. It does not affect how the rules in
the rule group are evaluated. If you want the rules in the rule group to
only count matches, do not use this and instead use the rule action
override option, with Count
action, in your rule group reference
statement settings.
firewallManagerRuleGroup_visibilityConfig :: Lens' FirewallManagerRuleGroup VisibilityConfig Source #
Defines and enables Amazon CloudWatch metrics and web request sample collection.
FirewallManagerStatement
firewallManagerStatement_managedRuleGroupStatement :: Lens' FirewallManagerStatement (Maybe ManagedRuleGroupStatement) Source #
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.
You are charged additional fees when you use the WAF Bot Control managed
rule group AWSManagedRulesBotControlRuleSet
or the WAF Fraud Control
account takeover prevention (ATP) managed rule group
AWSManagedRulesATPRuleSet
. For more information, see
WAF Pricing.
firewallManagerStatement_ruleGroupReferenceStatement :: Lens' FirewallManagerStatement (Maybe RuleGroupReferenceStatement) Source #
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
. You can only use a rule group
reference statement at the top level inside a web ACL.
ForwardedIPConfig
forwardedIPConfig_headerName :: Lens' ForwardedIPConfig Text Source #
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.
forwardedIPConfig_fallbackBehavior :: Lens' ForwardedIPConfig FallbackBehavior Source #
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.
GeoMatchStatement
geoMatchStatement_countryCodes :: Lens' GeoMatchStatement (Maybe (NonEmpty CountryCode)) Source #
An array of two-character country codes that you want to match against,
for example, [ "US", "CN" ]
, from the alpha-2 country ISO codes of
the ISO 3166 international standard.
When you use a geo match statement just for the region and country labels that it adds to requests, you still have to supply a country code for the rule to evaluate. In this case, you configure the rule to only count matching requests, but it will still generate logging and count metrics for any matches. You can reduce the logging and metrics that the rule produces by specifying a country that's unlikely to be a source of traffic to your site.
geoMatchStatement_forwardedIPConfig :: Lens' GeoMatchStatement (Maybe ForwardedIPConfig) Source #
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.
HTTPHeader
hTTPHeader_name :: Lens' HTTPHeader (Maybe Text) Source #
The name of the HTTP header.
hTTPHeader_value :: Lens' HTTPHeader (Maybe Text) Source #
The value of the HTTP header.
HTTPRequest
hTTPRequest_clientIP :: Lens' HTTPRequest (Maybe Text) Source #
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 requestx-forwarded-for
, if the viewer did use an HTTP proxy or a load balancer to send the request
hTTPRequest_country :: Lens' HTTPRequest (Maybe Text) Source #
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.
hTTPRequest_hTTPVersion :: Lens' HTTPRequest (Maybe Text) Source #
The HTTP version specified in the sampled web request, for example,
HTTP/1.1
.
hTTPRequest_headers :: Lens' HTTPRequest (Maybe [HTTPHeader]) Source #
A complex type that contains the name and value for each header in the sampled web request.
hTTPRequest_method :: Lens' HTTPRequest (Maybe Text) Source #
The HTTP method specified in the sampled web request.
hTTPRequest_uri :: Lens' HTTPRequest (Maybe Text) Source #
The URI path of the request, which identifies the resource, for example,
/images/daily-ad.jpg
.
HeaderMatchPattern
headerMatchPattern_all :: Lens' HeaderMatchPattern (Maybe All) Source #
Inspect all headers.
headerMatchPattern_excludedHeaders :: Lens' HeaderMatchPattern (Maybe (NonEmpty Text)) Source #
Inspect only the headers whose keys don't match any of the strings specified here.
headerMatchPattern_includedHeaders :: Lens' HeaderMatchPattern (Maybe (NonEmpty Text)) Source #
Inspect only the headers that have a key that matches one of the strings specified here.
Headers
headers_matchPattern :: Lens' Headers HeaderMatchPattern Source #
The filter to use to identify the subset of headers to inspect in a web request.
You must specify exactly one setting: either All
, IncludedHeaders
,
or ExcludedHeaders
.
Example JSON:
"MatchPattern": { "ExcludedHeaders": {"KeyToExclude1", "KeyToExclude2"} }
headers_matchScope :: Lens' Headers MapMatchScope Source #
The parts of the headers to match with the rule inspection criteria. If
you specify All
, WAF inspects both keys and values.
headers_oversizeHandling :: Lens' Headers OversizeHandling Source #
What WAF should do if the headers of the request are larger than WAF can inspect. WAF does not support inspecting the entire contents of request headers when they exceed 8 KB (8192 bytes) or 200 total headers. The underlying host service forwards a maximum of 200 headers and at most 8 KB of header contents to WAF.
The options for oversize handling are the following:
CONTINUE
- Inspect the headers normally, according to the rule inspection criteria.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.
IPSet
iPSet_description :: Lens' IPSet (Maybe Text) Source #
A description of the IP set that helps with identification.
iPSet_name :: Lens' IPSet Text Source #
The name of the IP set. You cannot change the name of an IPSet
after
you create it.
iPSet_id :: Lens' IPSet Text Source #
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.
iPSet_iPAddressVersion :: Lens' IPSet IPAddressVersion Source #
The version of the IP addresses, either IPV4
or IPV6
.
iPSet_addresses :: Lens' IPSet [Text] Source #
Contains an array of strings that specifies zero or more IP addresses or
blocks of IP addresses. All addresses must be specified using Classless
Inter-Domain Routing (CIDR) notation. WAF supports all IPv4 and IPv6
CIDR ranges except for /0
.
Example address strings:
- 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.
Example JSON Addresses
specifications:
- Empty array:
"Addresses": []
- Array with one address:
"Addresses": ["192.0.2.44/32"]
- Array with three addresses:
"Addresses": ["192.0.2.44/32", "192.0.2.0/24", "192.0.0.0/16"]
- INVALID specification:
"Addresses": [""]
INVALID
IPSetForwardedIPConfig
iPSetForwardedIPConfig_headerName :: Lens' IPSetForwardedIPConfig Text Source #
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.
iPSetForwardedIPConfig_fallbackBehavior :: Lens' IPSetForwardedIPConfig FallbackBehavior Source #
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.
iPSetForwardedIPConfig_position :: Lens' IPSetForwardedIPConfig ForwardedIPPosition Source #
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.
IPSetReferenceStatement
iPSetReferenceStatement_iPSetForwardedIPConfig :: Lens' IPSetReferenceStatement (Maybe IPSetForwardedIPConfig) Source #
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.
iPSetReferenceStatement_arn :: Lens' IPSetReferenceStatement Text Source #
The Amazon Resource Name (ARN) of the IPSet that this statement references.
IPSetSummary
iPSetSummary_arn :: Lens' IPSetSummary (Maybe Text) Source #
The Amazon Resource Name (ARN) of the entity.
iPSetSummary_description :: Lens' IPSetSummary (Maybe Text) Source #
A description of the IP set that helps with identification.
iPSetSummary_id :: Lens' IPSetSummary (Maybe Text) Source #
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.
iPSetSummary_lockToken :: Lens' IPSetSummary (Maybe Text) Source #
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.
iPSetSummary_name :: Lens' IPSetSummary (Maybe Text) Source #
The name of the IP set. You cannot change the name of an IPSet
after
you create it.
ImmunityTimeProperty
immunityTimeProperty_immunityTime :: Lens' ImmunityTimeProperty Natural Source #
The amount of time, in seconds, that a CAPTCHA
or challenge timestamp
is considered valid by WAF. The default setting is 300.
For the Challenge action, the minimum setting is 300.
JsonBody
jsonBody_invalidFallbackBehavior :: Lens' JsonBody (Maybe BodyParsingFallbackBehavior) Source #
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"}
jsonBody_oversizeHandling :: Lens' JsonBody (Maybe OversizeHandling) Source #
What WAF should do if the body is larger than WAF can inspect. WAF does not support inspecting the entire contents of the body of a web request when the body exceeds 8 KB (8192 bytes). Only the first 8 KB of the request body are forwarded to WAF by the underlying host service.
The options for oversize handling are the following:
CONTINUE
- Inspect the body normally, according to the rule inspection criteria.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.
You can combine the MATCH
or NO_MATCH
settings for oversize handling
with your rule and web ACL action settings, so that you block any
request whose body is over 8 KB.
Default: CONTINUE
jsonBody_matchPattern :: Lens' JsonBody JsonMatchPattern Source #
The patterns to look for in the JSON body. WAF inspects the results of these pattern matches against the rule inspection criteria.
jsonBody_matchScope :: Lens' JsonBody JsonMatchScope Source #
The parts of the JSON to match against using the MatchPattern
. If you
specify All
, WAF matches against keys and values.
JsonMatchPattern
jsonMatchPattern_all :: Lens' JsonMatchPattern (Maybe All) Source #
Match all of the elements. See also MatchScope
in JsonBody.
You must specify either this setting or the IncludedPaths
setting, but
not both.
jsonMatchPattern_includedPaths :: Lens' JsonMatchPattern (Maybe (NonEmpty Text)) Source #
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.
Label
LabelMatchStatement
labelMatchStatement_scope :: Lens' LabelMatchStatement LabelMatchScope Source #
Specify whether you want to match using the label name or just the namespace.
labelMatchStatement_key :: Lens' LabelMatchStatement Text Source #
The string to match against. The setting you provide for this depends on
the match statement's Scope
setting:
- If the
Scope
indicatesLABEL
, 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
indicatesNAMESPACE
, 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
.
LabelNameCondition
labelNameCondition_labelName :: Lens' LabelNameCondition Text Source #
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.
LabelSummary
labelSummary_name :: Lens' LabelSummary (Maybe Text) Source #
An individual label specification.
LoggingConfiguration
loggingConfiguration_loggingFilter :: Lens' LoggingConfiguration (Maybe LoggingFilter) Source #
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.
loggingConfiguration_managedByFirewallManager :: Lens' LoggingConfiguration (Maybe Bool) Source #
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.
loggingConfiguration_redactedFields :: Lens' LoggingConfiguration (Maybe [FieldToMatch]) Source #
The parts of the request that you want to keep out of the logs. For
example, if you redact the SingleHeader
field, the HEADER
field in
the logs will be xxx
.
You can specify only the following fields for redaction: UriPath
,
QueryString
, SingleHeader
, Method
, and JsonBody
.
loggingConfiguration_resourceArn :: Lens' LoggingConfiguration Text Source #
The Amazon Resource Name (ARN) of the web ACL that you want to associate
with LogDestinationConfigs
.
loggingConfiguration_logDestinationConfigs :: Lens' LoggingConfiguration (NonEmpty Text) Source #
The logging destination configuration that you want to associate with the web ACL.
You can associate one logging destination to a web ACL.
LoggingFilter
loggingFilter_filters :: Lens' LoggingFilter (NonEmpty Filter) Source #
The filters that you want to apply to the logs.
loggingFilter_defaultBehavior :: Lens' LoggingFilter FilterBehavior Source #
Default handling for logs that don't match any of the specified filtering conditions.
ManagedRuleGroupConfig
managedRuleGroupConfig_aWSManagedRulesBotControlRuleSet :: Lens' ManagedRuleGroupConfig (Maybe AWSManagedRulesBotControlRuleSet) Source #
Additional configuration for using the Bot Control managed rule group. Use this to specify the inspection level that you want to use. For information about using the Bot Control managed rule group, see WAF Bot Control rule group and WAF Bot Control in the WAF Developer Guide.
managedRuleGroupConfig_loginPath :: Lens' ManagedRuleGroupConfig (Maybe Text) Source #
The path of the login endpoint for your application. For example, for
the URL https://example.com/web/login
, you would provide the path
/web/login
.
managedRuleGroupConfig_passwordField :: Lens' ManagedRuleGroupConfig (Maybe PasswordField) Source #
Details about your login page password field.
managedRuleGroupConfig_payloadType :: Lens' ManagedRuleGroupConfig (Maybe PayloadType) Source #
The payload type for your login endpoint, either JSON or form encoded.
managedRuleGroupConfig_usernameField :: Lens' ManagedRuleGroupConfig (Maybe UsernameField) Source #
Details about your login page username field.
ManagedRuleGroupStatement
managedRuleGroupStatement_excludedRules :: Lens' ManagedRuleGroupStatement (Maybe [ExcludedRule]) Source #
Rules in the referenced rule group whose actions are set to Count
.
Instead of this option, use RuleActionOverrides
. It accepts any valid
action setting, including Count
.
managedRuleGroupStatement_managedRuleGroupConfigs :: Lens' ManagedRuleGroupStatement (Maybe (NonEmpty ManagedRuleGroupConfig)) Source #
Additional information that's used by a managed rule group. Many managed rule groups don't require this.
Use the AWSManagedRulesBotControlRuleSet
configuration object to
configure the protection level that you want the Bot Control rule group
to use.
managedRuleGroupStatement_ruleActionOverrides :: Lens' ManagedRuleGroupStatement (Maybe (NonEmpty RuleActionOverride)) Source #
Action settings to use in the place of the rule actions that are configured inside the rule group. You specify one override for each rule whose action you want to change.
You can use overrides for testing, for example you can override all of
rule actions to Count
and then monitor the resulting count metrics to
understand how the rule group would handle your web traffic. You can
also permanently override some or all actions, to modify how the rule
group manages your web traffic.
managedRuleGroupStatement_scopeDownStatement :: Lens' ManagedRuleGroupStatement (Maybe Statement) Source #
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.
managedRuleGroupStatement_version :: Lens' ManagedRuleGroupStatement (Maybe Text) Source #
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.
managedRuleGroupStatement_vendorName :: Lens' ManagedRuleGroupStatement Text Source #
The name of the managed rule group vendor. You use this, along with the rule group name, to identify the rule group.
managedRuleGroupStatement_name :: Lens' ManagedRuleGroupStatement Text Source #
The name of the managed rule group. You use this, along with the vendor name, to identify the rule group.
ManagedRuleGroupSummary
managedRuleGroupSummary_description :: Lens' ManagedRuleGroupSummary (Maybe Text) Source #
The description of the managed rule group, provided by Amazon Web Services Managed Rules or the Amazon Web Services Marketplace seller who manages it.
managedRuleGroupSummary_name :: Lens' ManagedRuleGroupSummary (Maybe Text) Source #
The name of the managed rule group. You use this, along with the vendor name, to identify the rule group.
managedRuleGroupSummary_vendorName :: Lens' ManagedRuleGroupSummary (Maybe Text) Source #
The name of the managed rule group vendor. You use this, along with the rule group name, to identify the rule group.
managedRuleGroupSummary_versioningSupported :: Lens' ManagedRuleGroupSummary (Maybe Bool) Source #
Indicates whether the managed rule group is versioned. If it is, you can retrieve the versions list by calling ListAvailableManagedRuleGroupVersions.
ManagedRuleGroupVersion
managedRuleGroupVersion_lastUpdateTimestamp :: Lens' ManagedRuleGroupVersion (Maybe UTCTime) Source #
The date and time that the managed rule group owner updated the rule group version information.
managedRuleGroupVersion_name :: Lens' ManagedRuleGroupVersion (Maybe Text) Source #
The version name.
ManagedRuleSet
managedRuleSet_description :: Lens' ManagedRuleSet (Maybe Text) Source #
A description of the set that helps with identification.
managedRuleSet_labelNamespace :: Lens' ManagedRuleSet (Maybe Text) Source #
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>
managedRuleSet_publishedVersions :: Lens' ManagedRuleSet (Maybe (HashMap Text ManagedRuleSetVersion)) Source #
The versions of this managed rule set that are available for use by customers.
managedRuleSet_recommendedVersion :: Lens' ManagedRuleSet (Maybe Text) Source #
The version that you would like your customers to use.
managedRuleSet_name :: Lens' ManagedRuleSet Text Source #
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.
managedRuleSet_id :: Lens' ManagedRuleSet Text Source #
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
.
managedRuleSet_arn :: Lens' ManagedRuleSet Text Source #
The Amazon Resource Name (ARN) of the entity.
ManagedRuleSetSummary
managedRuleSetSummary_arn :: Lens' ManagedRuleSetSummary (Maybe Text) Source #
The Amazon Resource Name (ARN) of the entity.
managedRuleSetSummary_description :: Lens' ManagedRuleSetSummary (Maybe Text) Source #
A description of the set that helps with identification.
managedRuleSetSummary_id :: Lens' ManagedRuleSetSummary (Maybe Text) Source #
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
.
managedRuleSetSummary_labelNamespace :: Lens' ManagedRuleSetSummary (Maybe Text) Source #
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>
managedRuleSetSummary_lockToken :: Lens' ManagedRuleSetSummary (Maybe Text) Source #
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.
managedRuleSetSummary_name :: Lens' ManagedRuleSetSummary (Maybe Text) Source #
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.
ManagedRuleSetVersion
managedRuleSetVersion_associatedRuleGroupArn :: Lens' ManagedRuleSetVersion (Maybe Text) Source #
The Amazon Resource Name (ARN) of the vendor rule group that's used to define the published version of your managed rule group.
managedRuleSetVersion_capacity :: Lens' ManagedRuleSetVersion (Maybe Natural) Source #
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.
managedRuleSetVersion_expiryTimestamp :: Lens' ManagedRuleSetVersion (Maybe UTCTime) Source #
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".
managedRuleSetVersion_forecastedLifetime :: Lens' ManagedRuleSetVersion (Maybe Natural) Source #
The amount of time you expect this version of your managed rule group to last, in days.
managedRuleSetVersion_lastUpdateTimestamp :: Lens' ManagedRuleSetVersion (Maybe UTCTime) Source #
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".
managedRuleSetVersion_publishTimestamp :: Lens' ManagedRuleSetVersion (Maybe UTCTime) Source #
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".
Method
MobileSdkRelease
mobileSdkRelease_releaseNotes :: Lens' MobileSdkRelease (Maybe Text) Source #
Notes describing the release.
mobileSdkRelease_releaseVersion :: Lens' MobileSdkRelease (Maybe Text) Source #
The release version.
mobileSdkRelease_tags :: Lens' MobileSdkRelease (Maybe (NonEmpty Tag)) Source #
Tags that are associated with the release.
mobileSdkRelease_timestamp :: Lens' MobileSdkRelease (Maybe UTCTime) Source #
The timestamp of the release.
NoneAction
NotStatement
notStatement_statement :: Lens' NotStatement Statement Source #
The statement to negate. You can use any statement that can be nested.
OrStatement
orStatement_statements :: Lens' OrStatement [Statement] Source #
The statements to combine with OR logic. You can use any statements that can be nested.
OverrideAction
overrideAction_count :: Lens' OverrideAction (Maybe CountAction) Source #
Override the rule group evaluation result to count only.
This option is usually set to none. It does not affect how the rules in
the rule group are evaluated. If you want the rules in the rule group to
only count matches, do not use this and instead use the rule action
override option, with Count
action, in your rule group reference
statement settings.
overrideAction_none :: Lens' OverrideAction (Maybe NoneAction) Source #
Don't override the rule group evaluation result. This is the most common setting.
PasswordField
passwordField_identifier :: Lens' PasswordField Text Source #
The name of the password field. For example /form/password
.
QueryString
RateBasedStatement
rateBasedStatement_forwardedIPConfig :: Lens' RateBasedStatement (Maybe ForwardedIPConfig) Source #
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
.
rateBasedStatement_scopeDownStatement :: Lens' RateBasedStatement (Maybe Statement) Source #
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.
rateBasedStatement_limit :: Lens' RateBasedStatement Natural Source #
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.
rateBasedStatement_aggregateKeyType :: Lens' RateBasedStatement RateBasedStatementAggregateKeyType Source #
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.
RateBasedStatementManagedKeysIPSet
rateBasedStatementManagedKeysIPSet_addresses :: Lens' RateBasedStatementManagedKeysIPSet (Maybe [Text]) Source #
The IP addresses that are currently blocked.
rateBasedStatementManagedKeysIPSet_iPAddressVersion :: Lens' RateBasedStatementManagedKeysIPSet (Maybe IPAddressVersion) Source #
The version of the IP addresses, either IPV4
or IPV6
.
Regex
regex_regexString :: Lens' Regex (Maybe Text) Source #
The string representing the regular expression.
RegexMatchStatement
regexMatchStatement_regexString :: Lens' RegexMatchStatement Text Source #
The string representing the regular expression.
regexMatchStatement_fieldToMatch :: Lens' RegexMatchStatement FieldToMatch Source #
The part of the web request that you want WAF to inspect.
regexMatchStatement_textTransformations :: Lens' RegexMatchStatement (NonEmpty TextTransformation) Source #
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.
RegexPatternSet
regexPatternSet_arn :: Lens' RegexPatternSet (Maybe Text) Source #
The Amazon Resource Name (ARN) of the entity.
regexPatternSet_description :: Lens' RegexPatternSet (Maybe Text) Source #
A description of the set that helps with identification.
regexPatternSet_id :: Lens' RegexPatternSet (Maybe Text) Source #
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.
regexPatternSet_name :: Lens' RegexPatternSet (Maybe Text) Source #
The name of the set. You cannot change the name after you create the set.
regexPatternSet_regularExpressionList :: Lens' RegexPatternSet (Maybe [Regex]) Source #
The regular expression patterns in the set.
RegexPatternSetReferenceStatement
regexPatternSetReferenceStatement_arn :: Lens' RegexPatternSetReferenceStatement Text Source #
The Amazon Resource Name (ARN) of the RegexPatternSet that this statement references.
regexPatternSetReferenceStatement_fieldToMatch :: Lens' RegexPatternSetReferenceStatement FieldToMatch Source #
The part of the web request that you want WAF to inspect.
regexPatternSetReferenceStatement_textTransformations :: Lens' RegexPatternSetReferenceStatement (NonEmpty TextTransformation) Source #
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.
RegexPatternSetSummary
regexPatternSetSummary_arn :: Lens' RegexPatternSetSummary (Maybe Text) Source #
The Amazon Resource Name (ARN) of the entity.
regexPatternSetSummary_description :: Lens' RegexPatternSetSummary (Maybe Text) Source #
A description of the set that helps with identification.
regexPatternSetSummary_id :: Lens' RegexPatternSetSummary (Maybe Text) Source #
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.
regexPatternSetSummary_lockToken :: Lens' RegexPatternSetSummary (Maybe Text) Source #
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.
regexPatternSetSummary_name :: Lens' RegexPatternSetSummary (Maybe Text) Source #
The name of the data type instance. You cannot change the name after you create the instance.
ReleaseSummary
releaseSummary_releaseVersion :: Lens' ReleaseSummary (Maybe Text) Source #
The release version.
releaseSummary_timestamp :: Lens' ReleaseSummary (Maybe UTCTime) Source #
The timestamp of the release.
Rule
rule_action :: Lens' Rule (Maybe RuleAction) Source #
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.
rule_captchaConfig :: Lens' Rule (Maybe CaptchaConfig) Source #
Specifies how WAF should handle CAPTCHA
evaluations. If you don't
specify this, WAF uses the CAPTCHA
configuration that's defined for
the web ACL.
rule_challengeConfig :: Lens' Rule (Maybe ChallengeConfig) Source #
Specifies how WAF should handle Challenge
evaluations. If you don't
specify this, WAF uses the challenge configuration that's defined for
the web ACL.
rule_overrideAction :: Lens' Rule (Maybe OverrideAction) Source #
The action to use in the place of the action that results from the rule group evaluation. Set the override action to none to leave the result of the rule group alone. Set it to count to override the result to count only.
You can only use this for rule statements that reference a rule group,
like RuleGroupReferenceStatement
and ManagedRuleGroupStatement
.
This option is usually set to none. It does not affect how the rules in
the rule group are evaluated. If you want the rules in the rule group to
only count matches, do not use this and instead use the rule action
override option, with Count
action, in your rule group reference
statement settings.
rule_ruleLabels :: Lens' Rule (Maybe [Label]) Source #
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
, oripset
.
For example, myLabelName
or nameSpace1:nameSpace2:myLabelName
.
rule_name :: Lens' Rule Text Source #
The name of the rule. You can't change the name of a Rule
after you
create it.
rule_priority :: Lens' Rule Natural Source #
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.
rule_statement :: Lens' Rule Statement Source #
The WAF processing statement for the rule, for example ByteMatchStatement or SizeConstraintStatement.
rule_visibilityConfig :: Lens' Rule VisibilityConfig Source #
Defines and enables Amazon CloudWatch metrics and web request sample collection.
RuleAction
ruleAction_allow :: Lens' RuleAction (Maybe AllowAction) Source #
Instructs WAF to allow the web request.
ruleAction_block :: Lens' RuleAction (Maybe BlockAction) Source #
Instructs WAF to block the web request.
ruleAction_captcha :: Lens' RuleAction (Maybe CaptchaAction) Source #
Instructs WAF to run a CAPTCHA
check against the web request.
ruleAction_challenge :: Lens' RuleAction (Maybe ChallengeAction) Source #
Instructs WAF to run a Challenge
check against the web request.
ruleAction_count :: Lens' RuleAction (Maybe CountAction) Source #
Instructs WAF to count the web request and then continue evaluating the request using the remaining rules in the web ACL.
RuleActionOverride
ruleActionOverride_name :: Lens' RuleActionOverride Text Source #
The name of the rule to override.
ruleActionOverride_actionToUse :: Lens' RuleActionOverride RuleAction Source #
The override action to use, in place of the configured action of the rule in the rule group.
RuleGroup
ruleGroup_availableLabels :: Lens' RuleGroup (Maybe [LabelSummary]) Source #
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.
ruleGroup_consumedLabels :: Lens' RuleGroup (Maybe [LabelSummary]) Source #
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.
ruleGroup_customResponseBodies :: Lens' RuleGroup (Maybe (HashMap Text CustomResponseBody)) Source #
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.
ruleGroup_description :: Lens' RuleGroup (Maybe Text) Source #
A description of the rule group that helps with identification.
ruleGroup_labelNamespace :: Lens' RuleGroup (Maybe Text) Source #
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>
ruleGroup_rules :: Lens' RuleGroup (Maybe [Rule]) Source #
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.
ruleGroup_name :: Lens' RuleGroup Text Source #
The name of the rule group. You cannot change the name of a rule group after you create it.
ruleGroup_id :: Lens' RuleGroup Text Source #
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.
ruleGroup_capacity :: Lens' RuleGroup Natural Source #
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.
ruleGroup_visibilityConfig :: Lens' RuleGroup VisibilityConfig Source #
Defines and enables Amazon CloudWatch metrics and web request sample collection.
RuleGroupReferenceStatement
ruleGroupReferenceStatement_excludedRules :: Lens' RuleGroupReferenceStatement (Maybe [ExcludedRule]) Source #
Rules in the referenced rule group whose actions are set to Count
.
Instead of this option, use RuleActionOverrides
. It accepts any valid
action setting, including Count
.
ruleGroupReferenceStatement_ruleActionOverrides :: Lens' RuleGroupReferenceStatement (Maybe (NonEmpty RuleActionOverride)) Source #
Action settings to use in the place of the rule actions that are configured inside the rule group. You specify one override for each rule whose action you want to change.
You can use overrides for testing, for example you can override all of
rule actions to Count
and then monitor the resulting count metrics to
understand how the rule group would handle your web traffic. You can
also permanently override some or all actions, to modify how the rule
group manages your web traffic.
ruleGroupReferenceStatement_arn :: Lens' RuleGroupReferenceStatement Text Source #
The Amazon Resource Name (ARN) of the entity.
RuleGroupSummary
ruleGroupSummary_arn :: Lens' RuleGroupSummary (Maybe Text) Source #
The Amazon Resource Name (ARN) of the entity.
ruleGroupSummary_description :: Lens' RuleGroupSummary (Maybe Text) Source #
A description of the rule group that helps with identification.
ruleGroupSummary_id :: Lens' RuleGroupSummary (Maybe Text) Source #
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.
ruleGroupSummary_lockToken :: Lens' RuleGroupSummary (Maybe Text) Source #
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.
ruleGroupSummary_name :: Lens' RuleGroupSummary (Maybe Text) Source #
The name of the data type instance. You cannot change the name after you create the instance.
RuleSummary
ruleSummary_action :: Lens' RuleSummary (Maybe RuleAction) Source #
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.
ruleSummary_name :: Lens' RuleSummary (Maybe Text) Source #
The name of the rule.
SampledHTTPRequest
sampledHTTPRequest_action :: Lens' SampledHTTPRequest (Maybe Text) Source #
The action that WAF applied to the request.
sampledHTTPRequest_captchaResponse :: Lens' SampledHTTPRequest (Maybe CaptchaResponse) Source #
The CAPTCHA
response for the request.
sampledHTTPRequest_challengeResponse :: Lens' SampledHTTPRequest (Maybe ChallengeResponse) Source #
The Challenge
response for the request.
sampledHTTPRequest_labels :: Lens' SampledHTTPRequest (Maybe [Label]) Source #
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
.
sampledHTTPRequest_overriddenAction :: Lens' SampledHTTPRequest (Maybe Text) Source #
Used only for rule group rules that have a rule action override in place
in the web ACL. This is the action that the rule group rule is
configured for, and not the action that was applied to the request. The
action that WAF applied is the Action
value.
sampledHTTPRequest_requestHeadersInserted :: Lens' SampledHTTPRequest (Maybe [HTTPHeader]) Source #
Custom request headers inserted by WAF into the request, according to the custom request configuration for the matching rule action.
sampledHTTPRequest_responseCodeSent :: Lens' SampledHTTPRequest (Maybe Natural) Source #
The response code that was sent for the request.
sampledHTTPRequest_ruleNameWithinRuleGroup :: Lens' SampledHTTPRequest (Maybe Text) Source #
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.
sampledHTTPRequest_timestamp :: Lens' SampledHTTPRequest (Maybe UTCTime) Source #
The time at which WAF received the request from your Amazon Web Services resource, in Unix time format (in seconds).
sampledHTTPRequest_request :: Lens' SampledHTTPRequest HTTPRequest Source #
A complex type that contains detailed information about the request.
sampledHTTPRequest_weight :: Lens' SampledHTTPRequest Natural Source #
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
.
SingleHeader
singleHeader_name :: Lens' SingleHeader Text Source #
The name of the query header to inspect.
SingleQueryArgument
singleQueryArgument_name :: Lens' SingleQueryArgument Text Source #
The name of the query argument to inspect.
SizeConstraintStatement
sizeConstraintStatement_fieldToMatch :: Lens' SizeConstraintStatement FieldToMatch Source #
The part of the web request that you want WAF to inspect.
sizeConstraintStatement_comparisonOperator :: Lens' SizeConstraintStatement ComparisonOperator Source #
The operator to use to compare the request part to the size setting.
sizeConstraintStatement_size :: Lens' SizeConstraintStatement Natural Source #
The size, in byte, to compare to the request part, after any transformations.
sizeConstraintStatement_textTransformations :: Lens' SizeConstraintStatement (NonEmpty TextTransformation) Source #
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.
SqliMatchStatement
sqliMatchStatement_sensitivityLevel :: Lens' SqliMatchStatement (Maybe SensitivityLevel) Source #
The sensitivity that you want WAF to use to inspect for SQL injection attacks.
HIGH
detects more attacks, but might generate more false positives,
especially if your web requests frequently contain unusual strings. For
information about identifying and mitigating false positives, see
Testing and tuning
in the WAF Developer Guide.
LOW
is generally a better choice for resources that already have other
protections against SQL injection attacks or that have a low tolerance
for false positives.
Default: LOW
sqliMatchStatement_fieldToMatch :: Lens' SqliMatchStatement FieldToMatch Source #
The part of the web request that you want WAF to inspect.
sqliMatchStatement_textTransformations :: Lens' SqliMatchStatement (NonEmpty TextTransformation) Source #
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.
Statement
statement_andStatement :: Lens' Statement (Maybe AndStatement) Source #
A logical rule statement used to combine other rule statements with AND
logic. You provide more than one Statement within the AndStatement
.
statement_byteMatchStatement :: Lens' Statement (Maybe ByteMatchStatement) Source #
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 called a string match statement.
statement_geoMatchStatement :: Lens' Statement (Maybe GeoMatchStatement) Source #
A rule statement that labels web requests by country and region and that matches against web requests based on country code. A geo match rule labels every request that it inspects regardless of whether it finds a match.
- To manage requests only by country, you can use this statement by
itself and specify the countries that you want to match against in
the
CountryCodes
array. - Otherwise, configure your geo match rule with Count action so that it only labels requests. Then, add one or more label match rules to run after the geo match rule and configure them to match against the geographic labels and handle the requests as needed.
WAF labels requests using the alpha-2 country and region codes from the
International Organization for Standardization (ISO) 3166 standard. WAF
determines the codes using either the IP address in the web request
origin or, if you specify it, the address in the geo match
ForwardedIPConfig
.
If you use the web request origin, the label formats are
awswaf:clientip:geo:region:<ISO country code>-<ISO region code>
and
awswaf:clientip:geo:country:<ISO country code>
.
If you use a forwarded IP address, the label formats are
awswaf:forwardedip:geo:region:<ISO country code>-<ISO region code>
and awswaf:forwardedip:geo:country:<ISO country code>
.
For additional details, see Geographic match rule statement in the WAF Developer Guide.
statement_iPSetReferenceStatement :: Lens' Statement (Maybe IPSetReferenceStatement) Source #
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.
statement_labelMatchStatement :: Lens' Statement (Maybe LabelMatchStatement) Source #
A rule statement to match 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.
statement_managedRuleGroupStatement :: Lens' Statement (Maybe ManagedRuleGroupStatement) Source #
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.
You are charged additional fees when you use the WAF Bot Control managed
rule group AWSManagedRulesBotControlRuleSet
or the WAF Fraud Control
account takeover prevention (ATP) managed rule group
AWSManagedRulesATPRuleSet
. For more information, see
WAF Pricing.
statement_notStatement :: Lens' Statement (Maybe NotStatement) Source #
A logical rule statement used to negate the results of another rule
statement. You provide one Statement within the NotStatement
.
statement_orStatement :: Lens' Statement (Maybe OrStatement) Source #
A logical rule statement used to combine other rule statements with OR
logic. You provide more than one Statement within the OrStatement
.
statement_rateBasedStatement :: Lens' Statement (Maybe RateBasedStatement) Source #
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.
WAF tracks and manages web requests separately for each instance of a rate-based rule that you use. For example, if you provide the same rate-based rule settings in two web ACLs, each of the two rule statements represents a separate instance of the rate-based rule and gets its own tracking and management by WAF. If you define a rate-based rule inside a rule group, and then use that rule group in multiple places, each use creates a separate instance of the rate-based rule that gets its own tracking and management by WAF.
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 the criteria of both of the nested statements are counted. If the count exceeds 1,000 requests per five minutes, the rule action triggers. Requests that do not meet the criteria of both of the nested statements are not counted towards the rate limit and are not affected by this rule.
You cannot nest a RateBasedStatement
inside another statement, for
example inside a NotStatement
or OrStatement
. You can define a
RateBasedStatement
inside a web ACL and inside a rule group.
statement_regexMatchStatement :: Lens' Statement (Maybe RegexMatchStatement) Source #
A rule statement used to search web request components for a match against a single regular expression.
statement_regexPatternSetReferenceStatement :: Lens' Statement (Maybe RegexPatternSetReferenceStatement) Source #
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.
statement_ruleGroupReferenceStatement :: Lens' Statement (Maybe RuleGroupReferenceStatement) Source #
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
. You can only use a rule group
reference statement at the top level inside a web ACL.
statement_sizeConstraintStatement :: Lens' Statement (Maybe SizeConstraintStatement) Source #
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 could use a size constraint statement to 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.
statement_sqliMatchStatement :: Lens' Statement (Maybe SqliMatchStatement) Source #
A rule statement that inspects for malicious SQL code. Attackers insert malicious SQL code into web requests to do things like modify your database or extract data from it.
statement_xssMatchStatement :: Lens' Statement (Maybe XssMatchStatement) Source #
A rule statement that inspects for cross-site scripting (XSS) attacks. In XSS attacks, the attacker uses vulnerabilities in a benign website as a vehicle to inject malicious client-site scripts into other legitimate web browsers.
Tag
tag_key :: Lens' Tag Text Source #
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.
tag_value :: Lens' Tag Text Source #
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.
TagInfoForResource
tagInfoForResource_resourceARN :: Lens' TagInfoForResource (Maybe Text) Source #
The Amazon Resource Name (ARN) of the resource.
tagInfoForResource_tagList :: Lens' TagInfoForResource (Maybe (NonEmpty Tag)) Source #
The array of Tag objects defined for the resource.
TextTransformation
textTransformation_priority :: Lens' TextTransformation Natural Source #
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.
textTransformation_type :: Lens' TextTransformation TextTransformationType Source #
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.
TimeWindow
timeWindow_startTime :: Lens' TimeWindow UTCTime Source #
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.
timeWindow_endTime :: Lens' TimeWindow UTCTime Source #
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.
UriPath
UsernameField
usernameField_identifier :: Lens' UsernameField Text Source #
The name of the username field. For example /form/username
.
VersionToPublish
versionToPublish_associatedRuleGroupArn :: Lens' VersionToPublish (Maybe Text) Source #
The Amazon Resource Name (ARN) of the vendor's rule group that's used in the published managed rule group version.
versionToPublish_forecastedLifetime :: Lens' VersionToPublish (Maybe Natural) Source #
The amount of time the vendor expects this version of the managed rule group to last, in days.
VisibilityConfig
visibilityConfig_sampledRequestsEnabled :: Lens' VisibilityConfig Bool Source #
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.
visibilityConfig_cloudWatchMetricsEnabled :: Lens' VisibilityConfig Bool Source #
A boolean indicating whether the associated resource sends metrics to Amazon CloudWatch. For the list of available metrics, see WAF Metrics.
visibilityConfig_metricName :: Lens' VisibilityConfig Text Source #
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
.
WebACL
webACL_capacity :: Lens' WebACL (Maybe Natural) Source #
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.
webACL_captchaConfig :: Lens' WebACL (Maybe CaptchaConfig) Source #
Specifies how WAF should handle CAPTCHA
evaluations for rules that
don't have their own CaptchaConfig
settings. If you don't specify
this, WAF uses its default settings for CaptchaConfig
.
webACL_challengeConfig :: Lens' WebACL (Maybe ChallengeConfig) Source #
Specifies how WAF should handle challenge evaluations for rules that
don't have their own ChallengeConfig
settings. If you don't specify
this, WAF uses its default settings for ChallengeConfig
.
webACL_customResponseBodies :: Lens' WebACL (Maybe (HashMap Text CustomResponseBody)) Source #
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.
webACL_description :: Lens' WebACL (Maybe Text) Source #
A description of the web ACL that helps with identification.
webACL_labelNamespace :: Lens' WebACL (Maybe Text) Source #
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>
webACL_managedByFirewallManager :: Lens' WebACL (Maybe Bool) Source #
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.
webACL_postProcessFirewallManagerRuleGroups :: Lens' WebACL (Maybe [FirewallManagerRuleGroup]) Source #
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.
webACL_preProcessFirewallManagerRuleGroups :: Lens' WebACL (Maybe [FirewallManagerRuleGroup]) Source #
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.
webACL_rules :: Lens' WebACL (Maybe [Rule]) Source #
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.
webACL_tokenDomains :: Lens' WebACL (Maybe (NonEmpty Text)) Source #
Specifies the domains that WAF should accept in a web request token. This enables the use of tokens across multiple protected websites. When WAF provides a token, it uses the domain of the Amazon Web Services resource that the web ACL is protecting. If you don't specify a list of token domains, WAF accepts tokens only for the domain of the protected resource. With a token domain list, WAF accepts the resource's host domain plus all domains in the token domain list, including their prefixed subdomains.
webACL_name :: Lens' WebACL Text Source #
The name of the web ACL. You cannot change the name of a web ACL after you create it.
webACL_id :: Lens' WebACL Text Source #
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
.
webACL_arn :: Lens' WebACL Text Source #
The Amazon Resource Name (ARN) of the web ACL that you want to associate with the resource.
webACL_defaultAction :: Lens' WebACL DefaultAction Source #
The action to perform if none of the Rules
contained in the WebACL
match.
webACL_visibilityConfig :: Lens' WebACL VisibilityConfig Source #
Defines and enables Amazon CloudWatch metrics and web request sample collection.
WebACLSummary
webACLSummary_arn :: Lens' WebACLSummary (Maybe Text) Source #
The Amazon Resource Name (ARN) of the entity.
webACLSummary_description :: Lens' WebACLSummary (Maybe Text) Source #
A description of the web ACL that helps with identification.
webACLSummary_id :: Lens' WebACLSummary (Maybe Text) Source #
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.
webACLSummary_lockToken :: Lens' WebACLSummary (Maybe Text) Source #
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.
webACLSummary_name :: Lens' WebACLSummary (Maybe Text) Source #
The name of the web ACL. You cannot change the name of a web ACL after you create it.
XssMatchStatement
xssMatchStatement_fieldToMatch :: Lens' XssMatchStatement FieldToMatch Source #
The part of the web request that you want WAF to inspect.
xssMatchStatement_textTransformations :: Lens' XssMatchStatement (NonEmpty TextTransformation) Source #
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.