com.amazonaws.services.identitymanagement.model

Class PutGroupPolicyRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.identitymanagement.model.PutGroupPolicyRequest

All Implemented Interfaces:

Serializable

public class PutGroupPolicyRequest
extends AmazonWebServiceRequest
implements Serializable

Container for the parameters to the PutGroupPolicy operation.

Adds (or updates) a policy document associated with the specified group. For information about policies, refer to Overview of Policies in the Using IAM guide.

For information about limits on the number of policies you can associate with a group, see Limitations on IAM Entities in the Using IAM guide.

NOTE: Because policy documents can be large, you should use POST rather than GET when calling PutGroupPolicy. For information about setting up signatures and authorization through the API, go to Signing AWS API Requests in the AWS General Reference. For general information about using the Query API with IAM, go to Making Query Requests in the Using IAM guide.

See Also:

AmazonIdentityManagement.putGroupPolicy(PutGroupPolicyRequest), Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
PutGroupPolicyRequest() Default constructor for a new PutGroupPolicyRequest object.
PutGroupPolicyRequest(String groupName, String policyName, String policyDocument) Constructs a new PutGroupPolicyRequest object.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getGroupName() The name of the group to associate the policy with.
String	getPolicyDocument() The policy document.
String	getPolicyName() The name of the policy document.
int	hashCode()
void	setGroupName(String groupName) The name of the group to associate the policy with.
void	setPolicyDocument(String policyDocument) The policy document.
void	setPolicyName(String policyName) The name of the policy document.
String	toString() Returns a string representation of this object; useful for testing and debugging.
PutGroupPolicyRequest	withGroupName(String groupName) The name of the group to associate the policy with.
PutGroupPolicyRequest	withPolicyDocument(String policyDocument) The policy document.
PutGroupPolicyRequest	withPolicyName(String policyName) The name of the policy document.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

copyBaseTo, copyPrivateRequestParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

PutGroupPolicyRequest

public PutGroupPolicyRequest()

Default constructor for a new PutGroupPolicyRequest object. Callers should use the setter or fluent setter (with...) methods to initialize this object after creating it.

PutGroupPolicyRequest

public PutGroupPolicyRequest(String groupName,
                     String policyName,
                     String policyDocument)

Constructs a new PutGroupPolicyRequest object. Callers should use the setter or fluent setter (with...) methods to initialize any additional object members.

Parameters:

groupName - The name of the group to associate the policy with.

policyName - The name of the policy document.

policyDocument - The policy document.

Method Detail

getGroupName

public String getGroupName()

The name of the group to associate the policy with.

Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]*

Returns:

The name of the group to associate the policy with.

setGroupName

public void setGroupName(String groupName)

The name of the group to associate the policy with.

Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]*

Parameters:

groupName - The name of the group to associate the policy with.

withGroupName

public PutGroupPolicyRequest withGroupName(String groupName)

The name of the group to associate the policy with.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]*

Parameters:

groupName - The name of the group to associate the policy with.

Returns:

A reference to this updated object so that method calls can be chained together.

getPolicyName

public String getPolicyName()

The name of the policy document.

Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]*

Returns:

The name of the policy document.

setPolicyName

public void setPolicyName(String policyName)

The name of the policy document.

Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]*

Parameters:

policyName - The name of the policy document.

withPolicyName

public PutGroupPolicyRequest withPolicyName(String policyName)

The name of the policy document.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 1 - 128
Pattern: [\w+=,.@-]*

Parameters:

policyName - The name of the policy document.

Returns:

A reference to this updated object so that method calls can be chained together.

getPolicyDocument

public String getPolicyDocument()

The policy document.

Constraints:
Length: 1 - 131072
Pattern: [\u0009\u000A\u000D\u0020-\u00FF]+

Returns:

The policy document.

setPolicyDocument

public void setPolicyDocument(String policyDocument)

The policy document.

Constraints:
Length: 1 - 131072
Pattern: [\u0009\u000A\u000D\u0020-\u00FF]+

Parameters:

policyDocument - The policy document.

withPolicyDocument

public PutGroupPolicyRequest withPolicyDocument(String policyDocument)

The policy document.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 1 - 131072
Pattern: [\u0009\u000A\u000D\u0020-\u00FF]+

Parameters:

policyDocument - The policy document.

Returns:

A reference to this updated object so that method calls can be chained together.

toString

public String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object