Package com.amazonaws.services.identitymanagement.model

Class CreatePolicyRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.identitymanagement.model.CreatePolicyRequest

All Implemented Interfaces:

ReadLimitInfo, Serializable, Cloneable

public class CreatePolicyRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor	Description
CreatePolicyRequest()

Method Summary

Modifier and Type	Method	Description
CreatePolicyRequest	clone()	Creates a shallow clone of this request.
boolean	equals(Object obj)
String	getDescription()	A friendly description of the policy.
String	getPath()	The path for the policy.
String	getPolicyDocument()	The JSON policy document that you want to use as the content for the new policy.
String	getPolicyName()	The friendly name of the policy.
int	hashCode()
void	setDescription(String description)	A friendly description of the policy.
void	setPath(String path)	The path for the policy.
void	setPolicyDocument(String policyDocument)	The JSON policy document that you want to use as the content for the new policy.
void	setPolicyName(String policyName)	The friendly name of the policy.
String	toString()	Returns a string representation of this object; useful for testing and debugging.
CreatePolicyRequest	withDescription(String description)	A friendly description of the policy.
CreatePolicyRequest	withPath(String path)	The path for the policy.
CreatePolicyRequest	withPolicyDocument(String policyDocument)	The JSON policy document that you want to use as the content for the new policy.
CreatePolicyRequest	withPolicyName(String policyName)	The friendly name of the policy.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

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

Methods inherited from class java.lang.Object

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

Constructor Detail

CreatePolicyRequest

public CreatePolicyRequest()

Method Detail

setPolicyName

public void setPolicyName(String policyName)

The friendly name of the policy.

The regex pattern for this parameter is 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 friendly name of the policy.

The regex pattern for this parameter is 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 friendly name of the policy.

The regex pattern for this parameter is 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 friendly name of the policy.

The regex pattern for this parameter is 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 CreatePolicyRequest withPolicyName(String policyName)

The friendly name of the policy.

The regex pattern for this parameter is 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 friendly name of the policy.

The regex pattern for this parameter is 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.

setPath

public void setPath(String path)

The path for the policy.

For more information about paths, see IAM Identifiers in the IAM User Guide.

This parameter is optional. If it is not included, it defaults to a slash (/).

The regex pattern for this parameter is a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes, containing any ASCII character from the ! (!) thru the DEL character (), including most punctuation characters, digits, and upper and lowercased letters.

Parameters:

path - The path for the policy.

For more information about paths, see IAM Identifiers in the IAM User Guide.

This parameter is optional. If it is not included, it defaults to a slash (/).

The regex pattern for this parameter is a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes, containing any ASCII character from the ! (!) thru the DEL character (), including most punctuation characters, digits, and upper and lowercased letters.

getPath

public String getPath()

The path for the policy.

For more information about paths, see IAM Identifiers in the IAM User Guide.

This parameter is optional. If it is not included, it defaults to a slash (/).

The regex pattern for this parameter is a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes, containing any ASCII character from the ! (!) thru the DEL character (), including most punctuation characters, digits, and upper and lowercased letters.

Returns:

The path for the policy.

For more information about paths, see IAM Identifiers in the IAM User Guide.

This parameter is optional. If it is not included, it defaults to a slash (/).

The regex pattern for this parameter is a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes, containing any ASCII character from the ! (!) thru the DEL character (), including most punctuation characters, digits, and upper and lowercased letters.

withPath

public CreatePolicyRequest withPath(String path)

The path for the policy.

For more information about paths, see IAM Identifiers in the IAM User Guide.

This parameter is optional. If it is not included, it defaults to a slash (/).

The regex pattern for this parameter is a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes, containing any ASCII character from the ! (!) thru the DEL character (), including most punctuation characters, digits, and upper and lowercased letters.

Parameters:

path - The path for the policy.

For more information about paths, see IAM Identifiers in the IAM User Guide.

This parameter is optional. If it is not included, it defaults to a slash (/).

The regex pattern for this parameter is a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes, containing any ASCII character from the ! (!) thru the DEL character (), including most punctuation characters, digits, and upper and lowercased letters.

Returns:

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

setPolicyDocument

public void setPolicyDocument(String policyDocument)

The JSON policy document that you want to use as the content for the new policy.

The regex pattern for this parameter is a string of characters consisting of any printable ASCII character ranging from the space character ( ) through end of the ASCII character range (ÿ). It also includes the special characters tab ( ), line feed ( ), and carriage return ( ).

Parameters:

policyDocument - The JSON policy document that you want to use as the content for the new policy.

The regex pattern for this parameter is a string of characters consisting of any printable ASCII character ranging from the space character ( ) through end of the ASCII character range (ÿ). It also includes the special characters tab ( ), line feed ( ), and carriage return ( ).

getPolicyDocument

public String getPolicyDocument()

The JSON policy document that you want to use as the content for the new policy.

The regex pattern for this parameter is a string of characters consisting of any printable ASCII character ranging from the space character ( ) through end of the ASCII character range (ÿ). It also includes the special characters tab ( ), line feed ( ), and carriage return ( ).

Returns:

The JSON policy document that you want to use as the content for the new policy.

The regex pattern for this parameter is a string of characters consisting of any printable ASCII character ranging from the space character ( ) through end of the ASCII character range (ÿ). It also includes the special characters tab ( ), line feed ( ), and carriage return ( ).

withPolicyDocument

public CreatePolicyRequest withPolicyDocument(String policyDocument)

The JSON policy document that you want to use as the content for the new policy.

The regex pattern for this parameter is a string of characters consisting of any printable ASCII character ranging from the space character ( ) through end of the ASCII character range (ÿ). It also includes the special characters tab ( ), line feed ( ), and carriage return ( ).

Parameters:

policyDocument - The JSON policy document that you want to use as the content for the new policy.

The regex pattern for this parameter is a string of characters consisting of any printable ASCII character ranging from the space character ( ) through end of the ASCII character range (ÿ). It also includes the special characters tab ( ), line feed ( ), and carriage return ( ).

Returns:

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

setDescription

public void setDescription(String description)

A friendly description of the policy.

Typically used to store information about the permissions defined in the policy. For example, "Grants access to production DynamoDB tables."

The policy description is immutable. After a value is assigned, it cannot be changed.

Parameters:

description - A friendly description of the policy.

Typically used to store information about the permissions defined in the policy. For example, "Grants access to production DynamoDB tables."

The policy description is immutable. After a value is assigned, it cannot be changed.

getDescription

public String getDescription()

A friendly description of the policy.

Typically used to store information about the permissions defined in the policy. For example, "Grants access to production DynamoDB tables."

The policy description is immutable. After a value is assigned, it cannot be changed.

Returns:

A friendly description of the policy.

Typically used to store information about the permissions defined in the policy. For example, "Grants access to production DynamoDB tables."

The policy description is immutable. After a value is assigned, it cannot be changed.

withDescription

public CreatePolicyRequest withDescription(String description)

A friendly description of the policy.

Typically used to store information about the permissions defined in the policy. For example, "Grants access to production DynamoDB tables."

The policy description is immutable. After a value is assigned, it cannot be changed.

Parameters:

description - A friendly description of the policy.

Typically used to store information about the permissions defined in the policy. For example, "Grants access to production DynamoDB tables."

The policy description is immutable. After a value is assigned, it cannot be changed.

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; useful for testing and debugging.

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