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.WAF.CreateXssMatchSet

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

Creates an XssMatchSet, which you use to allow, block, or count requests that contain cross-site scripting attacks in the specified part of web requests. AWS WAF searches for character sequences that are likely to be malicious strings.

To create and configure an XssMatchSet, perform the following steps:

Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a CreateXssMatchSet request.
Submit a CreateXssMatchSet request.
Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateXssMatchSet request.
Submit an UpdateXssMatchSet request to specify the parts of web requests in which you want to allow, block, or count cross-site scripting attacks.

For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.

Creating a Request

data CreateXssMatchSet Source #

A request to create an XssMatchSet.

See: newCreateXssMatchSet smart constructor.

Constructors

CreateXssMatchSet'
Fields name :: Text A friendly name or description for the XssMatchSet that you're creating. You can't change `Name` after you create the `XssMatchSet`. changeToken :: Text The value returned by the most recent call to GetChangeToken.

Instances

Instances details

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

newCreateXssMatchSet Source #

Arguments

:: Text	`CreateXssMatchSet`
-> Text	`CreateXssMatchSet`
-> CreateXssMatchSet

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

CreateXssMatchSet, createXssMatchSet_name - A friendly name or description for the XssMatchSet that you're creating. You can't change Name after you create the XssMatchSet.

CreateXssMatchSet, createXssMatchSet_changeToken - The value returned by the most recent call to GetChangeToken.

Request Lenses

createXssMatchSet_name :: Lens' CreateXssMatchSet Text Source #

A friendly name or description for the XssMatchSet that you're creating. You can't change Name after you create the XssMatchSet.

createXssMatchSet_changeToken :: Lens' CreateXssMatchSet Text Source #

The value returned by the most recent call to GetChangeToken.

Destructuring the Response

data CreateXssMatchSetResponse Source #

The response to a CreateXssMatchSet request.

See: newCreateXssMatchSetResponse smart constructor.

Constructors

CreateXssMatchSetResponse'
Fields changeToken :: Maybe Text The `ChangeToken` that you used to submit the `CreateXssMatchSet` request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus. xssMatchSet :: Maybe XssMatchSet An XssMatchSet. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic CreateXssMatchSetResponse Source #
Instance details Defined in Amazonka.WAF.CreateXssMatchSet Associated Types type Rep CreateXssMatchSetResponse :: Type -> Type # Methods from :: CreateXssMatchSetResponse -> Rep CreateXssMatchSetResponse x # to :: Rep CreateXssMatchSetResponse x -> CreateXssMatchSetResponse #
Read CreateXssMatchSetResponse Source #
Instance details Defined in Amazonka.WAF.CreateXssMatchSet Methods readsPrec :: Int -> ReadS CreateXssMatchSetResponse # readList :: ReadS [CreateXssMatchSetResponse] # readPrec :: ReadPrec CreateXssMatchSetResponse # readListPrec :: ReadPrec [CreateXssMatchSetResponse] #
Show CreateXssMatchSetResponse Source #
Instance details Defined in Amazonka.WAF.CreateXssMatchSet Methods showsPrec :: Int -> CreateXssMatchSetResponse -> ShowS # show :: CreateXssMatchSetResponse -> String # showList :: [CreateXssMatchSetResponse] -> ShowS #
NFData CreateXssMatchSetResponse Source #
Instance details Defined in Amazonka.WAF.CreateXssMatchSet Methods rnf :: CreateXssMatchSetResponse -> () #
Eq CreateXssMatchSetResponse Source #
Instance details Defined in Amazonka.WAF.CreateXssMatchSet Methods (==) :: CreateXssMatchSetResponse -> CreateXssMatchSetResponse -> Bool # (/=) :: CreateXssMatchSetResponse -> CreateXssMatchSetResponse -> Bool #
type Rep CreateXssMatchSetResponse Source #
Instance details Defined in Amazonka.WAF.CreateXssMatchSet type Rep CreateXssMatchSetResponse = D1 ('MetaData "CreateXssMatchSetResponse" "Amazonka.WAF.CreateXssMatchSet" "amazonka-waf-2.0-7D7QOxIEZeF1ayfX9AzEZC" 'False) (C1 ('MetaCons "CreateXssMatchSetResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "changeToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "xssMatchSet") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe XssMatchSet)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newCreateXssMatchSetResponse Source #

Arguments

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

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

CreateXssMatchSet, createXssMatchSetResponse_changeToken - The ChangeToken that you used to submit the CreateXssMatchSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.

$sel:xssMatchSet:CreateXssMatchSetResponse', createXssMatchSetResponse_xssMatchSet - An XssMatchSet.

$sel:httpStatus:CreateXssMatchSetResponse', createXssMatchSetResponse_httpStatus - The response's http status code.

Response Lenses

createXssMatchSetResponse_changeToken :: Lens' CreateXssMatchSetResponse (Maybe Text) Source #

The ChangeToken that you used to submit the CreateXssMatchSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.

createXssMatchSetResponse_xssMatchSet :: Lens' CreateXssMatchSetResponse (Maybe XssMatchSet) Source #

An XssMatchSet.

createXssMatchSetResponse_httpStatus :: Lens' CreateXssMatchSetResponse Int Source #

The response's http status code.