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

Amazonka.WAFV2.DeleteWebACL

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Deletes the specified WebACL.

You can only use this if ManagedByFirewallManager is false in the specified WebACL.

Before deleting any web ACL, first disassociate it from all resources.

To retrieve a list of the resources that are associated with a web ACL, use the following calls:
- For regional resources, call ListResourcesForWebACL.
- For Amazon CloudFront distributions, use the CloudFront call ListDistributionsByWebACLId. For information, see ListDistributionsByWebACLId.
To disassociate a resource from a web ACL, use the following calls:
- For regional resources, call DisassociateWebACL.
- For Amazon CloudFront distributions, provide an empty web ACL ID in the CloudFront call UpdateDistribution. For information, see UpdateDistribution.

Synopsis

data DeleteWebACL = DeleteWebACL' {
- name :: Text
- scope :: Scope
- id :: Text
- lockToken :: Text
}
newDeleteWebACL :: Text -> Scope -> Text -> Text -> DeleteWebACL
deleteWebACL_name :: Lens' DeleteWebACL Text
deleteWebACL_scope :: Lens' DeleteWebACL Scope
deleteWebACL_id :: Lens' DeleteWebACL Text
deleteWebACL_lockToken :: Lens' DeleteWebACL Text
data DeleteWebACLResponse = DeleteWebACLResponse' {
- httpStatus :: Int
}
newDeleteWebACLResponse :: Int -> DeleteWebACLResponse
deleteWebACLResponse_httpStatus :: Lens' DeleteWebACLResponse Int

Creating a Request

data DeleteWebACL Source #

See: newDeleteWebACL smart constructor.

Constructors

DeleteWebACL'

Fields

name :: Text
The name of the web ACL. You cannot change the name of a web ACL after you create it.
scope :: 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.
id :: Text
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.
lockToken :: Text
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.

Instances

Instances details

ToJSON DeleteWebACL Source #
Instance details Defined in Amazonka.WAFV2.DeleteWebACL Methods toJSON :: DeleteWebACL -> Value # toEncoding :: DeleteWebACL -> Encoding # toJSONList :: [DeleteWebACL] -> Value # toEncodingList :: [DeleteWebACL] -> Encoding #
ToHeaders DeleteWebACL Source #
Instance details Defined in Amazonka.WAFV2.DeleteWebACL Methods toHeaders :: DeleteWebACL -> [Header] #
ToPath DeleteWebACL Source #
Instance details Defined in Amazonka.WAFV2.DeleteWebACL Methods toPath :: DeleteWebACL -> ByteString #
ToQuery DeleteWebACL Source #
Instance details Defined in Amazonka.WAFV2.DeleteWebACL Methods toQuery :: DeleteWebACL -> QueryString #
AWSRequest DeleteWebACL Source #
Instance details Defined in Amazonka.WAFV2.DeleteWebACL Associated Types type AWSResponse DeleteWebACL # Methods request :: (Service -> Service) -> DeleteWebACL -> Request DeleteWebACL # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DeleteWebACL -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DeleteWebACL))) #
Generic DeleteWebACL Source #
Instance details Defined in Amazonka.WAFV2.DeleteWebACL Associated Types type Rep DeleteWebACL :: Type -> Type # Methods from :: DeleteWebACL -> Rep DeleteWebACL x # to :: Rep DeleteWebACL x -> DeleteWebACL #
Read DeleteWebACL Source #
Instance details Defined in Amazonka.WAFV2.DeleteWebACL Methods readsPrec :: Int -> ReadS DeleteWebACL # readList :: ReadS [DeleteWebACL] # readPrec :: ReadPrec DeleteWebACL # readListPrec :: ReadPrec [DeleteWebACL] #
Show DeleteWebACL Source #
Instance details Defined in Amazonka.WAFV2.DeleteWebACL Methods showsPrec :: Int -> DeleteWebACL -> ShowS # show :: DeleteWebACL -> String # showList :: [DeleteWebACL] -> ShowS #
NFData DeleteWebACL Source #
Instance details Defined in Amazonka.WAFV2.DeleteWebACL Methods rnf :: DeleteWebACL -> () #
Eq DeleteWebACL Source #
Instance details Defined in Amazonka.WAFV2.DeleteWebACL Methods (==) :: DeleteWebACL -> DeleteWebACL -> Bool # (/=) :: DeleteWebACL -> DeleteWebACL -> Bool #
Hashable DeleteWebACL Source #
Instance details Defined in Amazonka.WAFV2.DeleteWebACL Methods hashWithSalt :: Int -> DeleteWebACL -> Int # hash :: DeleteWebACL -> Int #
type AWSResponse DeleteWebACL Source #
Instance details Defined in Amazonka.WAFV2.DeleteWebACL type AWSResponse DeleteWebACL = DeleteWebACLResponse
type Rep DeleteWebACL Source #
Instance details Defined in Amazonka.WAFV2.DeleteWebACL type Rep DeleteWebACL = D1 ('MetaData "DeleteWebACL" "Amazonka.WAFV2.DeleteWebACL" "amazonka-wafv2-2.0-3v3WgpYn7RT5hSd6MsT5dN" 'False) (C1 ('MetaCons "DeleteWebACL'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "scope") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Scope)) :: (S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "lockToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newDeleteWebACL Source #

Arguments

:: Text	`DeleteWebACL`
-> Scope	`DeleteWebACL`
-> Text	`DeleteWebACL`
-> Text	`DeleteWebACL`
-> DeleteWebACL

Create a value of DeleteWebACL 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:

DeleteWebACL, deleteWebACL_name - The name of the web ACL. You cannot change the name of a web ACL after you create it.

DeleteWebACL, deleteWebACL_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.

DeleteWebACL, deleteWebACL_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.

DeleteWebACL, deleteWebACL_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.

Request Lenses

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.

Destructuring the Response

data DeleteWebACLResponse Source #

See: newDeleteWebACLResponse smart constructor.

Constructors

DeleteWebACLResponse'
Fields httpStatus :: Int The response's http status code.

Instances

Instances details

Generic DeleteWebACLResponse Source #
Instance details Defined in Amazonka.WAFV2.DeleteWebACL Associated Types type Rep DeleteWebACLResponse :: Type -> Type # Methods from :: DeleteWebACLResponse -> Rep DeleteWebACLResponse x # to :: Rep DeleteWebACLResponse x -> DeleteWebACLResponse #
Read DeleteWebACLResponse Source #
Instance details Defined in Amazonka.WAFV2.DeleteWebACL Methods readsPrec :: Int -> ReadS DeleteWebACLResponse # readList :: ReadS [DeleteWebACLResponse] # readPrec :: ReadPrec DeleteWebACLResponse # readListPrec :: ReadPrec [DeleteWebACLResponse] #
Show DeleteWebACLResponse Source #
Instance details Defined in Amazonka.WAFV2.DeleteWebACL Methods showsPrec :: Int -> DeleteWebACLResponse -> ShowS # show :: DeleteWebACLResponse -> String # showList :: [DeleteWebACLResponse] -> ShowS #
NFData DeleteWebACLResponse Source #
Instance details Defined in Amazonka.WAFV2.DeleteWebACL Methods rnf :: DeleteWebACLResponse -> () #
Eq DeleteWebACLResponse Source #
Instance details Defined in Amazonka.WAFV2.DeleteWebACL Methods (==) :: DeleteWebACLResponse -> DeleteWebACLResponse -> Bool # (/=) :: DeleteWebACLResponse -> DeleteWebACLResponse -> Bool #
type Rep DeleteWebACLResponse Source #
Instance details Defined in Amazonka.WAFV2.DeleteWebACL type Rep DeleteWebACLResponse = D1 ('MetaData "DeleteWebACLResponse" "Amazonka.WAFV2.DeleteWebACL" "amazonka-wafv2-2.0-3v3WgpYn7RT5hSd6MsT5dN" 'False) (C1 ('MetaCons "DeleteWebACLResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newDeleteWebACLResponse Source #

Arguments

:: Int	`$sel:httpStatus:DeleteWebACLResponse'`
-> DeleteWebACLResponse

Create a value of DeleteWebACLResponse 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:httpStatus:DeleteWebACLResponse', deleteWebACLResponse_httpStatus - The response's http status code.

Response Lenses

deleteWebACLResponse_httpStatus :: Lens' DeleteWebACLResponse Int Source #

The response's http status code.