amazonka-wafv2-2.0: Amazon WAFV2 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.WAFV2.PutPermissionPolicy

Description

Attaches an IAM policy to the specified resource. Use this to share a rule group across accounts.

You must be the owner of the rule group to perform this operation.

This action is subject to the following restrictions:

  • You can attach only one policy with each PutPermissionPolicy request.
  • The ARN in the request must be a valid WAF RuleGroup ARN and the rule group must exist in the same Region.
  • The user making the request must be the owner of the rule group.
Synopsis

Creating a Request

data PutPermissionPolicy Source #

See: newPutPermissionPolicy smart constructor.

Constructors

PutPermissionPolicy' 

Fields

  • resourceArn :: Text

    The Amazon Resource Name (ARN) of the RuleGroup to which you want to attach the policy.

  • policy :: Text

    The policy to attach to the specified rule group.

    The policy specifications must conform to the following:

    • The policy must be composed using IAM Policy version 2012-10-17 or version 2015-01-01.
    • The policy must include specifications for Effect, Action, and Principal.
    • Effect must specify Allow.
    • Action must specify wafv2:CreateWebACL, wafv2:UpdateWebACL, and wafv2:PutFirewallManagerRuleGroups and may optionally specify wafv2:GetRuleGroup. WAF rejects any extra actions or wildcard actions in the policy.
    • The policy must not include a Resource parameter.

    For more information, see IAM Policies.

Instances

Instances details
ToJSON PutPermissionPolicy Source # 
Instance details

Defined in Amazonka.WAFV2.PutPermissionPolicy

Methods

toJSON :: PutPermissionPolicy -> Value #

toEncoding :: PutPermissionPolicy -> Encoding #

toJSONList :: [PutPermissionPolicy] -> Value #

toEncodingList :: [PutPermissionPolicy] -> Encoding #

ToHeaders PutPermissionPolicy Source # 
Instance details

Defined in Amazonka.WAFV2.PutPermissionPolicy

Methods

toHeaders :: PutPermissionPolicy -> [Header] #

ToPath PutPermissionPolicy Source # 
Instance details

Defined in Amazonka.WAFV2.PutPermissionPolicy

Methods

toPath :: PutPermissionPolicy -> ByteString #

ToQuery PutPermissionPolicy Source # 
Instance details

Defined in Amazonka.WAFV2.PutPermissionPolicy

Methods

toQuery :: PutPermissionPolicy -> QueryString #

AWSRequest PutPermissionPolicy Source # 
Instance details

Defined in Amazonka.WAFV2.PutPermissionPolicy

Associated Types

type AWSResponse PutPermissionPolicy #

Methods

request :: (Service -> Service) -> PutPermissionPolicy -> Request PutPermissionPolicy #

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy PutPermissionPolicy -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse PutPermissionPolicy))) #

Generic PutPermissionPolicy Source # 
Instance details

Defined in Amazonka.WAFV2.PutPermissionPolicy

Associated Types

type Rep PutPermissionPolicy :: Type -> Type #

Methods

from :: PutPermissionPolicy -> Rep PutPermissionPolicy x #

to :: Rep PutPermissionPolicy x -> PutPermissionPolicy #

Read PutPermissionPolicy Source # 
Instance details

Defined in Amazonka.WAFV2.PutPermissionPolicy

Methods

readsPrec :: Int -> ReadS PutPermissionPolicy #

readList :: ReadS [PutPermissionPolicy] #

readPrec :: ReadPrec PutPermissionPolicy #

readListPrec :: ReadPrec [PutPermissionPolicy] #

Show PutPermissionPolicy Source # 
Instance details

Defined in Amazonka.WAFV2.PutPermissionPolicy

Methods

showsPrec :: Int -> PutPermissionPolicy -> ShowS #

show :: PutPermissionPolicy -> String #

showList :: [PutPermissionPolicy] -> ShowS #

NFData PutPermissionPolicy Source # 
Instance details

Defined in Amazonka.WAFV2.PutPermissionPolicy

Methods

rnf :: PutPermissionPolicy -> () #

Eq PutPermissionPolicy Source # 
Instance details

Defined in Amazonka.WAFV2.PutPermissionPolicy

Methods

(==) :: PutPermissionPolicy -> PutPermissionPolicy -> Bool #

(/=) :: PutPermissionPolicy -> PutPermissionPolicy -> Bool #

Hashable PutPermissionPolicy Source # 
Instance details

Defined in Amazonka.WAFV2.PutPermissionPolicy

Methods

hashWithSalt :: Int -> PutPermissionPolicy -> Int #

hash :: PutPermissionPolicy -> Int #

type AWSResponse PutPermissionPolicy Source # 
Instance details

Defined in Amazonka.WAFV2.PutPermissionPolicy

type AWSResponse PutPermissionPolicy = PutPermissionPolicyResponse
type Rep PutPermissionPolicy Source # 
Instance details

Defined in Amazonka.WAFV2.PutPermissionPolicy

type Rep PutPermissionPolicy = D1 ('MetaData "PutPermissionPolicy" "Amazonka.WAFV2.PutPermissionPolicy" "amazonka-wafv2-2.0-3v3WgpYn7RT5hSd6MsT5dN" 'False) (C1 ('MetaCons "PutPermissionPolicy'" 'PrefixI 'True) (S1 ('MetaSel ('Just "resourceArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "policy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newPutPermissionPolicy Source #

Arguments

:: Text

PutPermissionPolicy

-> Text

$sel:policy:PutPermissionPolicy'

-> PutPermissionPolicy 

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

PutPermissionPolicy, putPermissionPolicy_resourceArn - The Amazon Resource Name (ARN) of the RuleGroup to which you want to attach the policy.

$sel:policy:PutPermissionPolicy', putPermissionPolicy_policy - The policy to attach to the specified rule group.

The policy specifications must conform to the following:

  • The policy must be composed using IAM Policy version 2012-10-17 or version 2015-01-01.
  • The policy must include specifications for Effect, Action, and Principal.
  • Effect must specify Allow.
  • Action must specify wafv2:CreateWebACL, wafv2:UpdateWebACL, and wafv2:PutFirewallManagerRuleGroups and may optionally specify wafv2:GetRuleGroup. WAF rejects any extra actions or wildcard actions in the policy.
  • The policy must not include a Resource parameter.

For more information, see IAM Policies.

Request Lenses

putPermissionPolicy_resourceArn :: Lens' PutPermissionPolicy Text Source #

The Amazon Resource Name (ARN) of the RuleGroup to which you want to attach the policy.

putPermissionPolicy_policy :: Lens' PutPermissionPolicy Text Source #

The policy to attach to the specified rule group.

The policy specifications must conform to the following:

  • The policy must be composed using IAM Policy version 2012-10-17 or version 2015-01-01.
  • The policy must include specifications for Effect, Action, and Principal.
  • Effect must specify Allow.
  • Action must specify wafv2:CreateWebACL, wafv2:UpdateWebACL, and wafv2:PutFirewallManagerRuleGroups and may optionally specify wafv2:GetRuleGroup. WAF rejects any extra actions or wildcard actions in the policy.
  • The policy must not include a Resource parameter.

For more information, see IAM Policies.

Destructuring the Response

data PutPermissionPolicyResponse Source #

See: newPutPermissionPolicyResponse smart constructor.

Constructors

PutPermissionPolicyResponse' 

Fields

Instances

Instances details
Generic PutPermissionPolicyResponse Source # 
Instance details

Defined in Amazonka.WAFV2.PutPermissionPolicy

Associated Types

type Rep PutPermissionPolicyResponse :: Type -> Type #

Methods

from :: PutPermissionPolicyResponse -> Rep PutPermissionPolicyResponse x #

to :: Rep PutPermissionPolicyResponse x -> PutPermissionPolicyResponse #

Read PutPermissionPolicyResponse Source # 
Instance details

Defined in Amazonka.WAFV2.PutPermissionPolicy

Methods

readsPrec :: Int -> ReadS PutPermissionPolicyResponse #

readList :: ReadS [PutPermissionPolicyResponse] #

readPrec :: ReadPrec PutPermissionPolicyResponse #

readListPrec :: ReadPrec [PutPermissionPolicyResponse] #

Show PutPermissionPolicyResponse Source # 
Instance details

Defined in Amazonka.WAFV2.PutPermissionPolicy

Methods

showsPrec :: Int -> PutPermissionPolicyResponse -> ShowS #

show :: PutPermissionPolicyResponse -> String #

showList :: [PutPermissionPolicyResponse] -> ShowS #

NFData PutPermissionPolicyResponse Source # 
Instance details

Defined in Amazonka.WAFV2.PutPermissionPolicy

Methods

rnf :: PutPermissionPolicyResponse -> () #

Eq PutPermissionPolicyResponse Source # 
Instance details

Defined in Amazonka.WAFV2.PutPermissionPolicy

Methods

(==) :: PutPermissionPolicyResponse -> PutPermissionPolicyResponse -> Bool #

(/=) :: PutPermissionPolicyResponse -> PutPermissionPolicyResponse -> Bool #

type Rep PutPermissionPolicyResponse Source # 
Instance details

Defined in Amazonka.WAFV2.PutPermissionPolicy

type Rep PutPermissionPolicyResponse = D1 ('MetaData "PutPermissionPolicyResponse" "Amazonka.WAFV2.PutPermissionPolicy" "amazonka-wafv2-2.0-3v3WgpYn7RT5hSd6MsT5dN" 'False) (C1 ('MetaCons "PutPermissionPolicyResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newPutPermissionPolicyResponse Source #

Arguments

:: Int

$sel:httpStatus:PutPermissionPolicyResponse'

-> PutPermissionPolicyResponse 

Create a value of PutPermissionPolicyResponse 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:httpStatus:PutPermissionPolicyResponse', putPermissionPolicyResponse_httpStatus - The response's http status code.

Response Lenses

putPermissionPolicyResponse_httpStatus :: Lens' PutPermissionPolicyResponse Int Source #

The response's http status code.