com.amazonaws.services.identitymanagement.model

Class PutUserPolicyRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.identitymanagement.model.PutUserPolicyRequest

All Implemented Interfaces:

ReadLimitInfo, Serializable, Cloneable

public class PutUserPolicyRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

Container for the parameters to the PutUserPolicy operation.

Adds (or updates) an inline policy document that is embedded in the specified user.

A user can also have a managed policy attached to it. To attach a managed policy to a user, use AttachUserPolicy. To create a new managed policy, use CreatePolicy. For information about policies, refer to Managed Policies and Inline Policies in the Using IAM guide.

For information about limits on the number of inline policies that you can embed in a user, 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 PutUserPolicy. For general information about using the Query API with IAM, go to Making Query Requests in the Using IAM guide.

See Also:

AmazonIdentityManagement.putUserPolicy(PutUserPolicyRequest), Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

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
PutUserPolicyRequest	clone() Creates a shallow clone of this request.
boolean	equals(Object obj)
String	getPolicyDocument() The policy document.
String	getPolicyName() The name of the policy document.
String	getUserName() The name of the user to associate the policy with.
int	hashCode()
void	setPolicyDocument(String policyDocument) The policy document.
void	setPolicyName(String policyName) The name of the policy document.
void	setUserName(String userName) The 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) The name of the policy document.
PutUserPolicyRequest	withUserName(String userName) The name of the user to associate the policy with.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

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

Methods inherited from class java.lang.Object

finalize, 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 - The name of the user to associate the policy with.

policyName - The name of the policy document.

policyDocument - The policy document.

Method Detail

getUserName

public String getUserName()

The name of the user to associate the policy with.

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

Returns:

The name of the user to associate the policy with.

setUserName

public void setUserName(String userName)

The name of the user to associate the policy with.

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

Parameters:

userName - The name of the user to associate the policy with.

withUserName

public PutUserPolicyRequest withUserName(String userName)

The 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 - The 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()

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 PutUserPolicyRequest 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 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: [\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

clone

public PutUserPolicyRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this request. Explicitly does not clone the deep structure of the request object.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()