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.Types.WebACLSummary

Description

Synopsis

data WebACLSummary = WebACLSummary' {
- arn :: Maybe Text
- description :: Maybe Text
- id :: Maybe Text
- lockToken :: Maybe Text
- name :: Maybe Text
}
newWebACLSummary :: WebACLSummary
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)

Documentation

data 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.

See: newWebACLSummary smart constructor.

Constructors

WebACLSummary'

Fields

arn :: Maybe Text
The Amazon Resource Name (ARN) of the entity.
description :: Maybe Text
A description of the web ACL that helps with identification.
id :: Maybe 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 :: Maybe 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.
name :: Maybe Text
The name of the web ACL. You cannot change the name of a web ACL after you create it.

Instances

Instances details

FromJSON WebACLSummary Source #
Instance details Defined in Amazonka.WAFV2.Types.WebACLSummary Methods parseJSON :: Value -> Parser WebACLSummary # parseJSONList :: Value -> Parser [WebACLSummary] #
Generic WebACLSummary Source #
Instance details Defined in Amazonka.WAFV2.Types.WebACLSummary Associated Types type Rep WebACLSummary :: Type -> Type # Methods from :: WebACLSummary -> Rep WebACLSummary x # to :: Rep WebACLSummary x -> WebACLSummary #
Read WebACLSummary Source #
Instance details Defined in Amazonka.WAFV2.Types.WebACLSummary Methods readsPrec :: Int -> ReadS WebACLSummary # readList :: ReadS [WebACLSummary] # readPrec :: ReadPrec WebACLSummary # readListPrec :: ReadPrec [WebACLSummary] #
Show WebACLSummary Source #
Instance details Defined in Amazonka.WAFV2.Types.WebACLSummary Methods showsPrec :: Int -> WebACLSummary -> ShowS # show :: WebACLSummary -> String # showList :: [WebACLSummary] -> ShowS #
NFData WebACLSummary Source #
Instance details Defined in Amazonka.WAFV2.Types.WebACLSummary Methods rnf :: WebACLSummary -> () #
Eq WebACLSummary Source #
Instance details Defined in Amazonka.WAFV2.Types.WebACLSummary Methods (==) :: WebACLSummary -> WebACLSummary -> Bool # (/=) :: WebACLSummary -> WebACLSummary -> Bool #
Hashable WebACLSummary Source #
Instance details Defined in Amazonka.WAFV2.Types.WebACLSummary Methods hashWithSalt :: Int -> WebACLSummary -> Int # hash :: WebACLSummary -> Int #
type Rep WebACLSummary Source #
Instance details Defined in Amazonka.WAFV2.Types.WebACLSummary type Rep WebACLSummary = D1 ('MetaData "WebACLSummary" "Amazonka.WAFV2.Types.WebACLSummary" "amazonka-wafv2-2.0-3v3WgpYn7RT5hSd6MsT5dN" 'False) (C1 ('MetaCons "WebACLSummary'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "arn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "lockToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))))

newWebACLSummary :: WebACLSummary Source #

Create a value of WebACLSummary 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:arn:WebACLSummary', webACLSummary_arn - The Amazon Resource Name (ARN) of the entity.

$sel:description:WebACLSummary', webACLSummary_description - A description of the web ACL that helps with identification.

$sel:id:WebACLSummary', webACLSummary_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.

$sel:lockToken:WebACLSummary', webACLSummary_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:name:WebACLSummary', webACLSummary_name - The name of the web ACL. You cannot change the name of a web ACL after you create it.

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.