com.amazonaws.services.identitymanagement.model

Class CreateRoleRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.identitymanagement.model.CreateRoleRequest

All Implemented Interfaces:

ReadLimitInfo, Serializable, Cloneable

public class CreateRoleRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

Container for the parameters to the CreateRole operation.

Creates a new role for your AWS account. For more information about roles, go to Working with Roles . For information about limitations on role names and the number of roles you can create, go to Limitations on IAM Entities in the IAM User Guide .

The policy in the following example grants permission to an EC2 instance to assume the role.

See Also:

AmazonIdentityManagement.createRole(CreateRoleRequest), Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
CreateRoleRequest()

Method Summary

Methods

Modifier and Type	Method and Description
CreateRoleRequest	clone() Creates a shallow clone of this request.
boolean	equals(Object obj)
String	getAssumeRolePolicyDocument() The policy that grants an entity permission to assume the role.
String	getPath() The path to the role.
String	getRoleName() The name of the role to create.
int	hashCode()
void	setAssumeRolePolicyDocument(String assumeRolePolicyDocument) The policy that grants an entity permission to assume the role.
void	setPath(String path) The path to the role.
void	setRoleName(String roleName) The name of the role to create.
String	toString() Returns a string representation of this object; useful for testing and debugging.
CreateRoleRequest	withAssumeRolePolicyDocument(String assumeRolePolicyDocument) The policy that grants an entity permission to assume the role.
CreateRoleRequest	withPath(String path) The path to the role.
CreateRoleRequest	withRoleName(String roleName) The name of the role to create.

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

CreateRoleRequest

public CreateRoleRequest()

Method Detail

getPath

public String getPath()

The path to the role. For more information about paths, see IAM Identifiers in the Using IAM guide.

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

Constraints:
Length: 1 - 512
Pattern: (\u002F)|(\u002F[\u0021-\u007F]+\u002F)

Returns:

The path to the role. For more information about paths, see IAM Identifiers in the Using IAM guide.

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

setPath

public void setPath(String path)

The path to the role. For more information about paths, see IAM Identifiers in the Using IAM guide.

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

Constraints:
Length: 1 - 512
Pattern: (\u002F)|(\u002F[\u0021-\u007F]+\u002F)

Parameters:

path - The path to the role. For more information about paths, see IAM Identifiers in the Using IAM guide.

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

withPath

public CreateRoleRequest withPath(String path)

The path to the role. For more information about paths, see IAM Identifiers in the Using IAM guide.

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

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

Constraints:
Length: 1 - 512
Pattern: (\u002F)|(\u002F[\u0021-\u007F]+\u002F)

Parameters:

path - The path to the role. For more information about paths, see IAM Identifiers in the Using IAM guide.

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

Returns:

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

getRoleName

public String getRoleName()

The name of the role to create.

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

Returns:

The name of the role to create.

setRoleName

public void setRoleName(String roleName)

The name of the role to create.

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

Parameters:

roleName - The name of the role to create.

withRoleName

public CreateRoleRequest withRoleName(String roleName)

The name of the role to create.

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 create.

Returns:

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

getAssumeRolePolicyDocument

public String getAssumeRolePolicyDocument()

The policy that grants an entity permission to assume the role.

Constraints:
Length: 1 - 131072
Pattern: [\u0009\u000A\u000D\u0020-\u00FF]+

Returns:

The policy that grants an entity permission to assume the role.

setAssumeRolePolicyDocument

public void setAssumeRolePolicyDocument(String assumeRolePolicyDocument)

The policy that grants an entity permission to assume the role.

Constraints:
Length: 1 - 131072
Pattern: [\u0009\u000A\u000D\u0020-\u00FF]+

Parameters:

assumeRolePolicyDocument - The policy that grants an entity permission to assume the role.

withAssumeRolePolicyDocument

public CreateRoleRequest withAssumeRolePolicyDocument(String assumeRolePolicyDocument)

The policy that grants an entity permission to assume the role.

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:

assumeRolePolicyDocument - The policy that grants an entity permission to assume the role.

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