| Copyright | (c) 2013-2021 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
Amazonka.IAM.PutGroupPolicy
Description
Adds or updates an inline policy document that is embedded in the specified IAM group.
A user can also have managed policies attached to it. To attach a managed policy to a group, use AttachGroupPolicy. To create a new managed policy, use CreatePolicy. For information about policies, see Managed policies and inline policies in the IAM User Guide.
For information about the maximum number of inline policies that you can embed in a group, see IAM and STS quotas in the IAM User Guide.
Because policy documents can be large, you should use POST rather than
GET when calling PutGroupPolicy. For general information about using
the Query API with IAM, see
Making query requests
in the IAM User Guide.
Synopsis
- data PutGroupPolicy = PutGroupPolicy' {
- groupName :: Text
- policyName :: Text
- policyDocument :: Text
- newPutGroupPolicy :: Text -> Text -> Text -> PutGroupPolicy
- putGroupPolicy_groupName :: Lens' PutGroupPolicy Text
- putGroupPolicy_policyName :: Lens' PutGroupPolicy Text
- putGroupPolicy_policyDocument :: Lens' PutGroupPolicy Text
- data PutGroupPolicyResponse = PutGroupPolicyResponse' {
- newPutGroupPolicyResponse :: PutGroupPolicyResponse
Creating a Request
data PutGroupPolicy Source #
See: newPutGroupPolicy smart constructor.
Constructors
| PutGroupPolicy' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> Text | |
| -> PutGroupPolicy |
Create a value of PutGroupPolicy 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:groupName:PutGroupPolicy', putGroupPolicy_groupName - The name of the group to associate the policy with.
This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-.
$sel:policyName:PutGroupPolicy', putGroupPolicy_policyName - The name of the policy document.
This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
$sel:policyDocument:PutGroupPolicy', putGroupPolicy_policyDocument - The policy document.
You must provide policies in JSON format in IAM. However, for CloudFormation templates formatted in YAML, you can provide the policy in JSON or YAML format. CloudFormation always converts a YAML policy to JSON format before submitting it to = IAM.
The regex pattern used to validate this parameter is a string of characters consisting of the following:
- Any printable ASCII character ranging from the space character
(
\u0020) through the end of the ASCII character range - The printable characters in the Basic Latin and Latin-1 Supplement
character set (through
\u00FF) - The special characters tab (
\u0009), line feed (\u000A), and carriage return (\u000D)
Request Lenses
putGroupPolicy_groupName :: Lens' PutGroupPolicy Text Source #
The name of the group to associate the policy with.
This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-.
putGroupPolicy_policyName :: Lens' PutGroupPolicy Text Source #
The name of the policy document.
This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
putGroupPolicy_policyDocument :: Lens' PutGroupPolicy Text Source #
The policy document.
You must provide policies in JSON format in IAM. However, for CloudFormation templates formatted in YAML, you can provide the policy in JSON or YAML format. CloudFormation always converts a YAML policy to JSON format before submitting it to = IAM.
The regex pattern used to validate this parameter is a string of characters consisting of the following:
- Any printable ASCII character ranging from the space character
(
\u0020) through the end of the ASCII character range - The printable characters in the Basic Latin and Latin-1 Supplement
character set (through
\u00FF) - The special characters tab (
\u0009), line feed (\u000A), and carriage return (\u000D)
Destructuring the Response
data PutGroupPolicyResponse Source #
See: newPutGroupPolicyResponse smart constructor.
Constructors
| PutGroupPolicyResponse' | |
Instances
| Eq PutGroupPolicyResponse Source # | |
Defined in Amazonka.IAM.PutGroupPolicy Methods (==) :: PutGroupPolicyResponse -> PutGroupPolicyResponse -> Bool # (/=) :: PutGroupPolicyResponse -> PutGroupPolicyResponse -> Bool # | |
| Read PutGroupPolicyResponse Source # | |
Defined in Amazonka.IAM.PutGroupPolicy | |
| Show PutGroupPolicyResponse Source # | |
Defined in Amazonka.IAM.PutGroupPolicy Methods showsPrec :: Int -> PutGroupPolicyResponse -> ShowS # show :: PutGroupPolicyResponse -> String # showList :: [PutGroupPolicyResponse] -> ShowS # | |
| Generic PutGroupPolicyResponse Source # | |
Defined in Amazonka.IAM.PutGroupPolicy Associated Types type Rep PutGroupPolicyResponse :: Type -> Type # Methods from :: PutGroupPolicyResponse -> Rep PutGroupPolicyResponse x # to :: Rep PutGroupPolicyResponse x -> PutGroupPolicyResponse # | |
| NFData PutGroupPolicyResponse Source # | |
Defined in Amazonka.IAM.PutGroupPolicy Methods rnf :: PutGroupPolicyResponse -> () # | |
| type Rep PutGroupPolicyResponse Source # | |
newPutGroupPolicyResponse :: PutGroupPolicyResponse Source #
Create a value of PutGroupPolicyResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.