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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates a RegexPatternSet, which you reference in a RegexPatternSetReferenceStatement, to have WAF inspect a web request component for the specified patterns.

Synopsis

data CreateRegexPatternSet = CreateRegexPatternSet' {
- description :: Maybe Text
- tags :: Maybe (NonEmpty Tag)
- name :: Text
- scope :: Scope
- regularExpressionList :: [Regex]
}
newCreateRegexPatternSet :: Text -> Scope -> CreateRegexPatternSet
createRegexPatternSet_description :: Lens' CreateRegexPatternSet (Maybe Text)
createRegexPatternSet_tags :: Lens' CreateRegexPatternSet (Maybe (NonEmpty Tag))
createRegexPatternSet_name :: Lens' CreateRegexPatternSet Text
createRegexPatternSet_scope :: Lens' CreateRegexPatternSet Scope
createRegexPatternSet_regularExpressionList :: Lens' CreateRegexPatternSet [Regex]
data CreateRegexPatternSetResponse = CreateRegexPatternSetResponse' {
- summary :: Maybe RegexPatternSetSummary
- httpStatus :: Int
}
newCreateRegexPatternSetResponse :: Int -> CreateRegexPatternSetResponse
createRegexPatternSetResponse_summary :: Lens' CreateRegexPatternSetResponse (Maybe RegexPatternSetSummary)
createRegexPatternSetResponse_httpStatus :: Lens' CreateRegexPatternSetResponse Int

Creating a Request

data CreateRegexPatternSet Source #

See: newCreateRegexPatternSet smart constructor.

Constructors

CreateRegexPatternSet'

Fields

description :: Maybe Text
A description of the set that helps with identification.
tags :: Maybe (NonEmpty Tag)
An array of key:value pairs to associate with the resource.
name :: Text
The name of the set. You cannot change the name after you create the set.
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.
regularExpressionList :: [Regex]
Array of regular expression strings.

Instances

Instances details

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

newCreateRegexPatternSet Source #

Arguments

:: Text	`CreateRegexPatternSet`
-> Scope	`CreateRegexPatternSet`
-> CreateRegexPatternSet

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

CreateRegexPatternSet, createRegexPatternSet_description - A description of the set that helps with identification.

CreateRegexPatternSet, createRegexPatternSet_tags - An array of key:value pairs to associate with the resource.

CreateRegexPatternSet, createRegexPatternSet_name - The name of the set. You cannot change the name after you create the set.

CreateRegexPatternSet, createRegexPatternSet_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.

CreateRegexPatternSet, createRegexPatternSet_regularExpressionList - Array of regular expression strings.

Request Lenses

createRegexPatternSet_description :: Lens' CreateRegexPatternSet (Maybe Text) Source #

A description of the set that helps with identification.

createRegexPatternSet_tags :: Lens' CreateRegexPatternSet (Maybe (NonEmpty Tag)) Source #

An array of key:value pairs to associate with the resource.

createRegexPatternSet_name :: Lens' CreateRegexPatternSet Text Source #

The name of the set. You cannot change the name after you create the set.

createRegexPatternSet_scope :: Lens' CreateRegexPatternSet 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.

createRegexPatternSet_regularExpressionList :: Lens' CreateRegexPatternSet [Regex] Source #

Array of regular expression strings.

Destructuring the Response

data CreateRegexPatternSetResponse Source #

See: newCreateRegexPatternSetResponse smart constructor.

Constructors

CreateRegexPatternSetResponse'
Fields summary :: Maybe RegexPatternSetSummary High-level information about a RegexPatternSet, returned by operations like create and list. This provides information like the ID, that you can use to retrieve and manage a `RegexPatternSet`, and the ARN, that you provide to the RegexPatternSetReferenceStatement to use the pattern set in a Rule. httpStatus :: Int The response's http status code.

Instances

Instances details

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

newCreateRegexPatternSetResponse Source #

Arguments

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

Create a value of CreateRegexPatternSetResponse 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:summary:CreateRegexPatternSetResponse', createRegexPatternSetResponse_summary - High-level information about a RegexPatternSet, returned by operations like create and list. This provides information like the ID, that you can use to retrieve and manage a RegexPatternSet, and the ARN, that you provide to the RegexPatternSetReferenceStatement to use the pattern set in a Rule.

$sel:httpStatus:CreateRegexPatternSetResponse', createRegexPatternSetResponse_httpStatus - The response's http status code.

Response Lenses

createRegexPatternSetResponse_summary :: Lens' CreateRegexPatternSetResponse (Maybe RegexPatternSetSummary) Source #

High-level information about a RegexPatternSet, returned by operations like create and list. This provides information like the ID, that you can use to retrieve and manage a RegexPatternSet, and the ARN, that you provide to the RegexPatternSetReferenceStatement to use the pattern set in a Rule.

createRegexPatternSetResponse_httpStatus :: Lens' CreateRegexPatternSetResponse Int Source #

The response's http status code.