com.amazonaws.services.identitymanagement.model

Class PutUserPolicyRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.identitymanagement.model.PutUserPolicyRequest

All Implemented Interfaces:

Serializable

public class PutUserPolicyRequest
extends AmazonWebServiceRequest
implements Serializable

Container for the parameters to the PutUserPolicy operation.

Adds (or updates) a policy document associated with the specified user. For information about policies, refer to Overview of Policies in Using AWS Identity and Access Management .

For information about limits on the number of policies you can associate with a user, see Limitations on IAM Entities in Using AWS Identity and Access Management .

NOTE:Because policy documents can be large, you should use POST rather than GET when calling PutUserPolicy. 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 Using IAM.

See Also:

AmazonIdentityManagement.putUserPolicy(PutUserPolicyRequest), Serialized Form

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getPolicyDocument() The policy document.
String	getPolicyName() Name of the policy document.
String	getUserName() Name of the user to associate the policy with.
int	hashCode()
void	setPolicyDocument(String policyDocument) The policy document.
void	setPolicyName(String policyName) Name of the policy document.
void	setUserName(String userName) Name of the user to associate the policy with.
String	toString() Returns a string representation of this object; useful for testing and debugging.
PutUserPolicyRequest	withPolicyDocument(String policyDocument) The policy document.
PutUserPolicyRequest	withPolicyName(String policyName) Name of the policy document.
PutUserPolicyRequest	withUserName(String userName) Name of the user to associate the policy with.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

copyPrivateRequestParameters, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setRequestCredentials, setRequestMetricCollector, withRequestMetricCollector

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

PutUserPolicyRequest

public PutUserPolicyRequest()

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

PutUserPolicyRequest

public PutUserPolicyRequest(String userName,
                    String policyName,
                    String policyDocument)

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

Parameters:

userName - Name of the user to associate the policy with.

policyName - Name of the policy document.

policyDocument - The policy document.

Method Detail

getUserName

public String getUserName()

Name of the user to associate the policy with.

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

Returns:

Name of the user to associate the policy with.

setUserName

public void setUserName(String userName)

Name of the user to associate the policy with.

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

Parameters:

userName - Name of the user to associate the policy with.

withUserName

public PutUserPolicyRequest withUserName(String userName)

Name of the user 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:

userName - Name of the user to associate the policy with.

Returns:

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

getPolicyName

public String getPolicyName()

Name of the policy document.

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

Returns:

Name of the policy document.

setPolicyName

public void setPolicyName(String policyName)

Name of the policy document.

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

Parameters:

policyName - Name of the policy document.

withPolicyName

public PutUserPolicyRequest withPolicyName(String policyName)

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 - 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: [ -ÿ]+

Returns:

The policy document.

setPolicyDocument

public void setPolicyDocument(String policyDocument)

The policy document.

Constraints:
Length: 1 - 131072
Pattern: [ -ÿ]+

Parameters:

policyDocument - The policy document.

withPolicyDocument

public PutUserPolicyRequest 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: [ -ÿ]+

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