com.amazonaws.services.identitymanagement.model

Class PutUserPolicyRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.identitymanagement.model.PutUserPolicyRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class PutUserPolicyRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
PutUserPolicyRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
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.
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

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

PutUserPolicyRequest

public PutUserPolicyRequest()

Default constructor for PutUserPolicyRequest object. Callers should use the setter or fluent setter (with...) methods to initialize the 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.

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

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

policyDocument - The policy document.

You must provide policies in JSON format in IAM. However, for AWS CloudFormation templates formatted in YAML, you can provide the policy in JSON or YAML format. AWS 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 ( ) through the end of the ASCII character range

• The printable characters in the Basic Latin and Latin-1 Supplement character set (through ÿ)

• The special characters tab ( ), line feed ( ), and carriage return ( )

Method Detail

setUserName

public void setUserName(String userName)

The name of the user 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: _+=,.@-

Parameters:

userName - The name of the user 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: _+=,.@-

getUserName

public String getUserName()

The name of the user 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: _+=,.@-

Returns:

The name of the user 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: _+=,.@-

withUserName

public PutUserPolicyRequest withUserName(String userName)

The name of the user 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: _+=,.@-

Parameters:

userName - The name of the user 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: _+=,.@-

Returns:

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

setPolicyName

public void setPolicyName(String 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: _+=,.@-

Parameters:

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

getPolicyName

public String getPolicyName()

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

Returns:

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

withPolicyName

public PutUserPolicyRequest withPolicyName(String 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: _+=,.@-

Parameters:

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

Returns:

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

setPolicyDocument

public void setPolicyDocument(String policyDocument)

The policy document.

You must provide policies in JSON format in IAM. However, for AWS CloudFormation templates formatted in YAML, you can provide the policy in JSON or YAML format. AWS 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 ( ) through the end of the ASCII character range

• The printable characters in the Basic Latin and Latin-1 Supplement character set (through ÿ)

• The special characters tab ( ), line feed ( ), and carriage return ( )

Parameters:

policyDocument - The policy document.

You must provide policies in JSON format in IAM. However, for AWS CloudFormation templates formatted in YAML, you can provide the policy in JSON or YAML format. AWS 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 ( ) through the end of the ASCII character range

• The printable characters in the Basic Latin and Latin-1 Supplement character set (through ÿ)

• The special characters tab ( ), line feed ( ), and carriage return ( )

getPolicyDocument

public String getPolicyDocument()

The policy document.

You must provide policies in JSON format in IAM. However, for AWS CloudFormation templates formatted in YAML, you can provide the policy in JSON or YAML format. AWS 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 ( ) through the end of the ASCII character range

• The printable characters in the Basic Latin and Latin-1 Supplement character set (through ÿ)

• The special characters tab ( ), line feed ( ), and carriage return ( )

Returns:

The policy document.

You must provide policies in JSON format in IAM. However, for AWS CloudFormation templates formatted in YAML, you can provide the policy in JSON or YAML format. AWS 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 ( ) through the end of the ASCII character range

• The printable characters in the Basic Latin and Latin-1 Supplement character set (through ÿ)

• The special characters tab ( ), line feed ( ), and carriage return ( )

withPolicyDocument

public PutUserPolicyRequest withPolicyDocument(String policyDocument)

The policy document.

You must provide policies in JSON format in IAM. However, for AWS CloudFormation templates formatted in YAML, you can provide the policy in JSON or YAML format. AWS 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 ( ) through the end of the ASCII character range

• The printable characters in the Basic Latin and Latin-1 Supplement character set (through ÿ)

• The special characters tab ( ), line feed ( ), and carriage return ( )

Parameters:

policyDocument - The policy document.

You must provide policies in JSON format in IAM. However, for AWS CloudFormation templates formatted in YAML, you can provide the policy in JSON or YAML format. AWS 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 ( ) through the end of the ASCII character range

• The printable characters in the Basic Latin and Latin-1 Supplement character set (through ÿ)

• The special characters tab ( ), line feed ( ), and carriage return ( )

Returns:

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

toString

public String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public PutUserPolicyRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()