com.amazonaws.services.identitymanagement.model

Class PutRolePolicyRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.identitymanagement.model.PutRolePolicyRequest

All Implemented Interfaces:

ReadLimitInfo, Serializable, Cloneable

public class PutRolePolicyRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

Container for the parameters to the PutRolePolicy operation.

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

When you embed an inline policy in a role, the inline policy is used as 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, go to Using Roles to Delegate Permissions and Federate Identities .

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, refer to Managed Policies and Inline Policies in the IAM User Guide .

For information about limits on the number of inline policies that you can embed with a role, see Limitations on IAM Entities in the IAM User Guide .

NOTE: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, go to Making Query Requests in the Using IAM guide.

See Also:

AmazonIdentityManagement.putRolePolicy(PutRolePolicyRequest), Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
PutRolePolicyRequest()

Method Summary

Methods

Modifier and Type	Method and Description
PutRolePolicyRequest	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	getRoleName() The name of the role 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	setRoleName(String roleName) The name of the role to associate the policy with.
String	toString() Returns a string representation of this object; useful for testing and debugging.
PutRolePolicyRequest	withPolicyDocument(String policyDocument) The policy document.
PutRolePolicyRequest	withPolicyName(String policyName) The name of the policy document.
PutRolePolicyRequest	withRoleName(String roleName) The name of the role to associate the policy with.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

copyBaseTo, getCloneRoot, getCloneSource, 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

PutRolePolicyRequest

public PutRolePolicyRequest()

Method Detail

getRoleName

public String getRoleName()

The name of the role to associate the policy with.

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

Returns:

The name of the role to associate the policy with.

setRoleName

public void setRoleName(String roleName)

The name of the role to associate the policy with.

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

Parameters:

roleName - The name of the role to associate the policy with.

withRoleName

public PutRolePolicyRequest withRoleName(String roleName)

The name of the role to associate the policy with.

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

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

Parameters:

roleName - The name of the role 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 PutRolePolicyRequest 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 PutRolePolicyRequest 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 PutRolePolicyRequest 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()