amazonka-waf-2.0: Amazon WAF SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.WAF.CreateXssMatchSet

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:

  1. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a CreateXssMatchSet request.
  2. Submit a CreateXssMatchSet request.
  3. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateXssMatchSet request.
  4. 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.

Synopsis

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

ToHeaders CreateXssMatchSet Source # 
Instance details

Defined in Amazonka.WAF.CreateXssMatchSet

ToPath CreateXssMatchSet Source # 
Instance details

Defined in Amazonka.WAF.CreateXssMatchSet

ToQuery CreateXssMatchSet Source # 
Instance details

Defined in Amazonka.WAF.CreateXssMatchSet

AWSRequest CreateXssMatchSet Source # 
Instance details

Defined in Amazonka.WAF.CreateXssMatchSet

Associated Types

type AWSResponse CreateXssMatchSet #

Generic CreateXssMatchSet Source # 
Instance details

Defined in Amazonka.WAF.CreateXssMatchSet

Associated Types

type Rep CreateXssMatchSet :: Type -> Type #

Read CreateXssMatchSet Source # 
Instance details

Defined in Amazonka.WAF.CreateXssMatchSet

Show CreateXssMatchSet Source # 
Instance details

Defined in Amazonka.WAF.CreateXssMatchSet

NFData CreateXssMatchSet Source # 
Instance details

Defined in Amazonka.WAF.CreateXssMatchSet

Methods

rnf :: CreateXssMatchSet -> () #

Eq CreateXssMatchSet Source # 
Instance details

Defined in Amazonka.WAF.CreateXssMatchSet

Hashable CreateXssMatchSet Source # 
Instance details

Defined in Amazonka.WAF.CreateXssMatchSet

type AWSResponse CreateXssMatchSet Source # 
Instance details

Defined in Amazonka.WAF.CreateXssMatchSet

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 #

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 #

Read CreateXssMatchSetResponse Source # 
Instance details

Defined in Amazonka.WAF.CreateXssMatchSet

Show CreateXssMatchSetResponse Source # 
Instance details

Defined in Amazonka.WAF.CreateXssMatchSet

NFData CreateXssMatchSetResponse Source # 
Instance details

Defined in Amazonka.WAF.CreateXssMatchSet

Eq CreateXssMatchSetResponse Source # 
Instance details

Defined in Amazonka.WAF.CreateXssMatchSet

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 #

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.