Put Role Policy
iam_put_role_policy | R Documentation |
Adds or updates an inline policy document that is embedded in the specified IAM role¶
Description¶
Adds or updates an inline policy document that is embedded in the specified IAM role.
When you embed an inline policy in a role, the inline policy is used as
part of the role's access (permissions) policy. The role's trust policy
is created at the same time as the role, using
create_role
. You can update a role's trust policy using
update_assume_role_policy
. For more information about roles, see IAM
roles
in the IAM User Guide.
A role can also have a managed policy attached to it. To attach a
managed policy to a role, use
attach_role_policy
. To create a new managed policy, use
create_policy
. 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 with a role, 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 put_role_policy
. For general information about using
the Query API with IAM, see Making query
requests
in the IAM User Guide.
Usage¶
Arguments¶
RoleName
[required] The name of the role 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: _+=,.@-
PolicyName
[required] 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: _+=,.@-
PolicyDocument
[required] 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 (
U+0020
) through the end of the ASCII character rangeThe printable characters in the Basic Latin and Latin-1 Supplement character set (through
U+00FF
)The special characters tab (
U+0009
), line feed (U+000A
), and carriage return (U+000D
)
Value¶
An empty list.