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

Description

Synopsis

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

Documentation

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

See: newIPSetSummary smart constructor.

Constructors

IPSetSummary'

Fields

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

Instances

Instances details

FromJSON IPSetSummary Source #
Instance details Defined in Amazonka.WAFV2.Types.IPSetSummary Methods parseJSON :: Value -> Parser IPSetSummary # parseJSONList :: Value -> Parser [IPSetSummary] #
Generic IPSetSummary Source #
Instance details Defined in Amazonka.WAFV2.Types.IPSetSummary Associated Types type Rep IPSetSummary :: Type -> Type # Methods from :: IPSetSummary -> Rep IPSetSummary x # to :: Rep IPSetSummary x -> IPSetSummary #
Read IPSetSummary Source #
Instance details Defined in Amazonka.WAFV2.Types.IPSetSummary Methods readsPrec :: Int -> ReadS IPSetSummary # readList :: ReadS [IPSetSummary] # readPrec :: ReadPrec IPSetSummary # readListPrec :: ReadPrec [IPSetSummary] #
Show IPSetSummary Source #
Instance details Defined in Amazonka.WAFV2.Types.IPSetSummary Methods showsPrec :: Int -> IPSetSummary -> ShowS # show :: IPSetSummary -> String # showList :: [IPSetSummary] -> ShowS #
NFData IPSetSummary Source #
Instance details Defined in Amazonka.WAFV2.Types.IPSetSummary Methods rnf :: IPSetSummary -> () #
Eq IPSetSummary Source #
Instance details Defined in Amazonka.WAFV2.Types.IPSetSummary Methods (==) :: IPSetSummary -> IPSetSummary -> Bool # (/=) :: IPSetSummary -> IPSetSummary -> Bool #
Hashable IPSetSummary Source #
Instance details Defined in Amazonka.WAFV2.Types.IPSetSummary Methods hashWithSalt :: Int -> IPSetSummary -> Int # hash :: IPSetSummary -> Int #
type Rep IPSetSummary Source #
Instance details Defined in Amazonka.WAFV2.Types.IPSetSummary type Rep IPSetSummary = D1 ('MetaData "IPSetSummary" "Amazonka.WAFV2.Types.IPSetSummary" "amazonka-wafv2-2.0-3v3WgpYn7RT5hSd6MsT5dN" 'False) (C1 ('MetaCons "IPSetSummary'" '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))))))

newIPSetSummary :: IPSetSummary Source #

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

$sel:description:IPSetSummary', iPSetSummary_description - A description of the IP set that helps with identification.

$sel:id:IPSetSummary', iPSetSummary_id - 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.

$sel:lockToken:IPSetSummary', iPSetSummary_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:IPSetSummary', iPSetSummary_name - The name of the IP set. You cannot change the name of an IPSet after you create it.

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.