Container for the parameters to the PutRolePolicy operation. 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 CreateRole. You can update a role's trust policy using UpdateAssumeRolePolicy. 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 AttachRolePolicy. 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 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
PutRolePolicy. For general information about using the Query API with IAM,
see Making
query requests in the IAM User Guide.
Inheritance Hierarchy
Amazon.Runtime.AmazonWebServiceRequest
Amazon.IdentityManagement.AmazonIdentityManagementServiceRequest
Amazon.IdentityManagement.Model.PutRolePolicyRequest
Namespace: Amazon.IdentityManagement.Model
Assembly: AWSSDK.IdentityManagement.dll
Version: 3.x.y.z
Syntax
public class PutRolePolicyRequest : AmazonIdentityManagementServiceRequest IAmazonWebServiceRequest
The PutRolePolicyRequest type exposes the following members
Constructors
| Name | Description | |
|---|---|---|
|
PutRolePolicyRequest() |
Properties
| Name | Type | Description | |
|---|---|---|---|
|
|
PolicyDocument | System.String |
Gets and sets the property 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:
|
|
|
PolicyName | System.String |
Gets and sets the property 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: _+=,.@- |
|
|
RoleName | System.String |
Gets and sets the property RoleName. 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: _+=,.@- |
Examples
The following command adds a permissions policy to the role named Test-Role.
To attach a permissions policy to an IAM role
var client = new AmazonIdentityManagementServiceClient();
var response = client.PutRolePolicy(new PutRolePolicyRequest
{
PolicyDocument = "{\"Version\":\"2012-10-17\",\"Statement\":{\"Effect\":\"Allow\",\"Action\":\"s3:*\",\"Resource\":\"*\"}}",
PolicyName = "S3AccessPolicy",
RoleName = "S3Access"
});
Version Information
.NET Core App:
Supported in: 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5, 4.0, 3.5