AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Container for the parameters to the PutGroupPolicy operation. 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.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.IdentityManagement.AmazonIdentityManagementServiceRequest
      Amazon.IdentityManagement.Model.PutGroupPolicyRequest

Namespace: Amazon.IdentityManagement.Model
Assembly: AWSSDK.IdentityManagement.dll
Version: 3.x.y.z

Syntax

C# 
public class PutGroupPolicyRequest : AmazonIdentityManagementServiceRequest
         IAmazonWebServiceRequest

The PutGroupPolicyRequest type exposes the following members

Constructors

NameDescription
Public Method PutGroupPolicyRequest()

Empty constructor used to set properties independently even when a simple constructor is available

Public Method PutGroupPolicyRequest(string, string, string)

Instantiates PutGroupPolicyRequest with the parameterized properties

Properties

NameTypeDescription
Public Property GroupName System.String

Gets and sets the property 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: _+=,.@-.

Public Property 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:

  • 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)

Public Property 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: _+=,.@-

Examples

The following command adds a policy named AllPerms to the IAM group named Admins.

To add a policy to a group


var client = new AmazonIdentityManagementServiceClient();
var response = client.PutGroupPolicy(new PutGroupPolicyRequest 
{
    GroupName = "Admins",
    PolicyDocument = "{\"Version\":\"2012-10-17\",\"Statement\":{\"Effect\":\"Allow\",\"Action\":\"*\",\"Resource\":\"*\"}}",
    PolicyName = "AllPerms"
});

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