Amazonka.WAF.PutPermissionPolicy

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.

Creating a Request

data PutPermissionPolicy

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

ToJSON PutPermissionPolicy

Defined in Amazonka.WAF.PutPermissionPolicy

Methods

toJSON :: PutPermissionPolicy -> Value

toEncoding :: PutPermissionPolicy -> Encoding

toJSONList :: [PutPermissionPolicy] -> Value

toEncodingList :: [PutPermissionPolicy] -> Encoding

ToHeaders PutPermissionPolicy

Defined in Amazonka.WAF.PutPermissionPolicy

Methods

toHeaders :: PutPermissionPolicy -> [Header]

ToPath PutPermissionPolicy

Defined in Amazonka.WAF.PutPermissionPolicy

Methods

toPath :: PutPermissionPolicy -> ByteString

ToQuery PutPermissionPolicy

Defined in Amazonka.WAF.PutPermissionPolicy

Methods

toQuery :: PutPermissionPolicy -> QueryString

AWSRequest PutPermissionPolicy

Defined in Amazonka.WAF.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

Defined in Amazonka.WAF.PutPermissionPolicy

Associated Types

type Rep PutPermissionPolicy :: Type -> Type

Methods

from :: PutPermissionPolicy -> Rep PutPermissionPolicy x

to :: Rep PutPermissionPolicy x -> PutPermissionPolicy

Read PutPermissionPolicy

Defined in Amazonka.WAF.PutPermissionPolicy

Methods

readsPrec :: Int -> ReadS PutPermissionPolicy

readList :: ReadS [PutPermissionPolicy]

readPrec :: ReadPrec PutPermissionPolicy

readListPrec :: ReadPrec [PutPermissionPolicy]

Show PutPermissionPolicy

Defined in Amazonka.WAF.PutPermissionPolicy

Methods

showsPrec :: Int -> PutPermissionPolicy -> ShowS

show :: PutPermissionPolicy -> String

showList :: [PutPermissionPolicy] -> ShowS

NFData PutPermissionPolicy

Defined in Amazonka.WAF.PutPermissionPolicy

Methods

rnf :: PutPermissionPolicy -> ()

Eq PutPermissionPolicy

Defined in Amazonka.WAF.PutPermissionPolicy

Methods

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

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

Hashable PutPermissionPolicy

Defined in Amazonka.WAF.PutPermissionPolicy

Methods

hashWithSalt :: Int -> PutPermissionPolicy -> Int

hash :: PutPermissionPolicy -> Int

type AWSResponse PutPermissionPolicy

Defined in Amazonka.WAF.PutPermissionPolicy

type AWSResponse PutPermissionPolicy = PutPermissionPolicyResponse

type Rep PutPermissionPolicy

Defined in Amazonka.WAF.PutPermissionPolicy

type Rep PutPermissionPolicy = D1 ('MetaData "PutPermissionPolicy" "Amazonka.WAF.PutPermissionPolicy" "amazonka-waf-2.0-7D7QOxIEZeF1ayfX9AzEZC" '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

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

Request Lenses

putPermissionPolicy_resourceArn :: Lens' PutPermissionPolicy Text

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

putPermissionPolicy_policy :: Lens' PutPermissionPolicy Text

The policy to attach to the specified RuleGroup.

Destructuring the Response

data PutPermissionPolicyResponse

See: newPutPermissionPolicyResponse smart constructor.

Constructors

PutPermissionPolicyResponse'

Fields

• httpStatus :: Int

  The response's http status code.

Instances

Generic PutPermissionPolicyResponse

Defined in Amazonka.WAF.PutPermissionPolicy

Associated Types

type Rep PutPermissionPolicyResponse :: Type -> Type

Methods

from :: PutPermissionPolicyResponse -> Rep PutPermissionPolicyResponse x

to :: Rep PutPermissionPolicyResponse x -> PutPermissionPolicyResponse

Read PutPermissionPolicyResponse

Defined in Amazonka.WAF.PutPermissionPolicy

Methods

readsPrec :: Int -> ReadS PutPermissionPolicyResponse

readList :: ReadS [PutPermissionPolicyResponse]

readPrec :: ReadPrec PutPermissionPolicyResponse

readListPrec :: ReadPrec [PutPermissionPolicyResponse]

Show PutPermissionPolicyResponse

Defined in Amazonka.WAF.PutPermissionPolicy

Methods

showsPrec :: Int -> PutPermissionPolicyResponse -> ShowS

show :: PutPermissionPolicyResponse -> String

showList :: [PutPermissionPolicyResponse] -> ShowS

NFData PutPermissionPolicyResponse

Defined in Amazonka.WAF.PutPermissionPolicy

Methods

rnf :: PutPermissionPolicyResponse -> ()

Eq PutPermissionPolicyResponse

Defined in Amazonka.WAF.PutPermissionPolicy

Methods

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

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

type Rep PutPermissionPolicyResponse

Defined in Amazonka.WAF.PutPermissionPolicy

type Rep PutPermissionPolicyResponse = D1 ('MetaData "PutPermissionPolicyResponse" "Amazonka.WAF.PutPermissionPolicy" "amazonka-waf-2.0-7D7QOxIEZeF1ayfX9AzEZC" 'False) (C1 ('MetaCons "PutPermissionPolicyResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newPutPermissionPolicyResponse

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

The response's http status code.