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 |
Retrieves the specified WebACL.
Synopsis
- data GetWebACL = GetWebACL' {}
- newGetWebACL :: Text -> Scope -> Text -> GetWebACL
- getWebACL_name :: Lens' GetWebACL Text
- getWebACL_scope :: Lens' GetWebACL Scope
- getWebACL_id :: Lens' GetWebACL Text
- data GetWebACLResponse = GetWebACLResponse' {}
- newGetWebACLResponse :: Int -> GetWebACLResponse
- getWebACLResponse_applicationIntegrationURL :: Lens' GetWebACLResponse (Maybe Text)
- getWebACLResponse_lockToken :: Lens' GetWebACLResponse (Maybe Text)
- getWebACLResponse_webACL :: Lens' GetWebACLResponse (Maybe WebACL)
- getWebACLResponse_httpStatus :: Lens' GetWebACLResponse Int
Creating a Request
See: newGetWebACL
smart constructor.
GetWebACL' | |
|
Instances
Create a value of GetWebACL
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
GetWebACL
, getWebACL_name
- The name of the web ACL. You cannot change the name of a web ACL after
you create it.
GetWebACL
, getWebACL_scope
- 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
, getWebACL_id
- 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.
Request Lenses
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.
Destructuring the Response
data GetWebACLResponse Source #
See: newGetWebACLResponse
smart constructor.
GetWebACLResponse' | |
|
Instances
Create a value of GetWebACLResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:applicationIntegrationURL:GetWebACLResponse'
, getWebACLResponse_applicationIntegrationURL
- 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
, getWebACLResponse_lockToken
- 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.
$sel:webACL:GetWebACLResponse'
, getWebACLResponse_webACL
- 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.
$sel:httpStatus:GetWebACLResponse'
, getWebACLResponse_httpStatus
- The response's http status code.
Response Lenses
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.