libZSservicesZSamazonka-wafZSamazonka-waf
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.WAF.PutPermissionPolicy

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.

Attaches an IAM policy to the specified resource. The only supported use for this action is to share a RuleGroup across accounts.

The PutPermissionPolicy is subject to the following restrictions:

  • You can attach only one policy with each PutPermissionPolicy request.
  • The policy must include an Effect, Action and Principal.
  • Effect must specify Allow.
  • The Action in the policy must be waf:UpdateWebACL, waf-regional:UpdateWebACL, waf:GetRuleGroup and waf-regional:GetRuleGroup . Any extra or wildcard actions in the policy will be rejected.
  • The policy cannot include a Resource parameter.
  • The ARN in the request must be a valid WAF RuleGroup ARN and the RuleGroup must exist in the same region.
  • The user making the request must be the owner of the RuleGroup.
  • Your policy must be composed using IAM Policy version 2012-10-17.

For more information, see IAM Policies.

An example of a valid policy parameter is shown in the Examples section below.

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

Instances

Instances details
Eq PutPermissionPolicy Source # 
Instance details

Defined in Amazonka.WAF.PutPermissionPolicy

Methods

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

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

Read PutPermissionPolicy Source # 
Instance details

Defined in Amazonka.WAF.PutPermissionPolicy

Methods

readsPrec :: Int -> ReadS PutPermissionPolicy #

readList :: ReadS [PutPermissionPolicy] #

readPrec :: ReadPrec PutPermissionPolicy #

readListPrec :: ReadPrec [PutPermissionPolicy] #

Show PutPermissionPolicy Source # 
Instance details

Defined in Amazonka.WAF.PutPermissionPolicy

Methods

showsPrec :: Int -> PutPermissionPolicy -> ShowS #

show :: PutPermissionPolicy -> String #

showList :: [PutPermissionPolicy] -> ShowS #

Generic PutPermissionPolicy Source # 
Instance details

Defined in Amazonka.WAF.PutPermissionPolicy

Associated Types

type Rep PutPermissionPolicy :: Type -> Type #

Methods

from :: PutPermissionPolicy -> Rep PutPermissionPolicy x #

to :: Rep PutPermissionPolicy x -> PutPermissionPolicy #

NFData PutPermissionPolicy Source # 
Instance details

Defined in Amazonka.WAF.PutPermissionPolicy

Methods

rnf :: PutPermissionPolicy -> () #

Hashable PutPermissionPolicy Source # 
Instance details

Defined in Amazonka.WAF.PutPermissionPolicy

Methods

hashWithSalt :: Int -> PutPermissionPolicy -> Int #

hash :: PutPermissionPolicy -> Int #

ToJSON PutPermissionPolicy Source # 
Instance details

Defined in Amazonka.WAF.PutPermissionPolicy

Methods

toJSON :: PutPermissionPolicy -> Value #

toEncoding :: PutPermissionPolicy -> Encoding #

toJSONList :: [PutPermissionPolicy] -> Value #

toEncodingList :: [PutPermissionPolicy] -> Encoding #

AWSRequest PutPermissionPolicy Source # 
Instance details

Defined in Amazonka.WAF.PutPermissionPolicy

Associated Types

type AWSResponse PutPermissionPolicy #

Methods

request :: PutPermissionPolicy -> Request PutPermissionPolicy #

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

ToHeaders PutPermissionPolicy Source # 
Instance details

Defined in Amazonka.WAF.PutPermissionPolicy

Methods

toHeaders :: PutPermissionPolicy -> [Header] #

ToPath PutPermissionPolicy Source # 
Instance details

Defined in Amazonka.WAF.PutPermissionPolicy

Methods

toPath :: PutPermissionPolicy -> ByteString #

ToQuery PutPermissionPolicy Source # 
Instance details

Defined in Amazonka.WAF.PutPermissionPolicy

Methods

toQuery :: PutPermissionPolicy -> QueryString #

type Rep PutPermissionPolicy Source # 
Instance details

Defined in Amazonka.WAF.PutPermissionPolicy

type Rep PutPermissionPolicy = D1 ('MetaData "PutPermissionPolicy" "Amazonka.WAF.PutPermissionPolicy" "libZSservicesZSamazonka-wafZSamazonka-waf" 'False) (C1 ('MetaCons "PutPermissionPolicy'" 'PrefixI 'True) (S1 ('MetaSel ('Just "resourceArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "policy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))
type AWSResponse PutPermissionPolicy Source # 
Instance details

Defined in Amazonka.WAF.PutPermissionPolicy

type AWSResponse PutPermissionPolicy = PutPermissionPolicyResponse

newPutPermissionPolicy Source #

Arguments

:: Text

$sel:resourceArn: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:

$sel:resourceArn: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 RuleGroup.

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

Destructuring the Response

data PutPermissionPolicyResponse Source #

See: newPutPermissionPolicyResponse smart constructor.

Constructors

PutPermissionPolicyResponse' 

Fields

Instances

Instances details
Eq PutPermissionPolicyResponse Source # 
Instance details

Defined in Amazonka.WAF.PutPermissionPolicy

Methods

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

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

Read PutPermissionPolicyResponse Source # 
Instance details

Defined in Amazonka.WAF.PutPermissionPolicy

Methods

readsPrec :: Int -> ReadS PutPermissionPolicyResponse #

readList :: ReadS [PutPermissionPolicyResponse] #

readPrec :: ReadPrec PutPermissionPolicyResponse #

readListPrec :: ReadPrec [PutPermissionPolicyResponse] #

Show PutPermissionPolicyResponse Source # 
Instance details

Defined in Amazonka.WAF.PutPermissionPolicy

Methods

showsPrec :: Int -> PutPermissionPolicyResponse -> ShowS #

show :: PutPermissionPolicyResponse -> String #

showList :: [PutPermissionPolicyResponse] -> ShowS #

Generic PutPermissionPolicyResponse Source # 
Instance details

Defined in Amazonka.WAF.PutPermissionPolicy

Associated Types

type Rep PutPermissionPolicyResponse :: Type -> Type #

Methods

from :: PutPermissionPolicyResponse -> Rep PutPermissionPolicyResponse x #

to :: Rep PutPermissionPolicyResponse x -> PutPermissionPolicyResponse #

NFData PutPermissionPolicyResponse Source # 
Instance details

Defined in Amazonka.WAF.PutPermissionPolicy

Methods

rnf :: PutPermissionPolicyResponse -> () #

type Rep PutPermissionPolicyResponse Source # 
Instance details

Defined in Amazonka.WAF.PutPermissionPolicy

type Rep PutPermissionPolicyResponse = D1 ('MetaData "PutPermissionPolicyResponse" "Amazonka.WAF.PutPermissionPolicy" "libZSservicesZSamazonka-wafZSamazonka-waf" '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.