com.amazonaws.services.identitymanagement.model
Class Role

java.lang.Object
  com.amazonaws.services.identitymanagement.model.Role

All Implemented Interfaces:

Serializable

public class Role
extends Object
implements Serializable

The Role data type contains information about a role.

This data type is used as a response element in the following actions:

• CreateRole

• GetRole

• ListRoles

See Also:

Serialized Form

Constructor Summary

Role()

Method Summary

boolean	equals(Object obj)
String	getArn() The Amazon Resource Name (ARN) specifying the role.
String	getAssumeRolePolicyDocument() The policy that grants an entity permission to assume the role.
Date	getCreateDate() The date when the role was created.
String	getPath() Path to the role.
String	getRoleId() The stable and unique string identifying the role.
String	getRoleName() The name identifying the role.
int	hashCode()
void	setArn(String arn) The Amazon Resource Name (ARN) specifying the role.
void	setAssumeRolePolicyDocument(String assumeRolePolicyDocument) The policy that grants an entity permission to assume the role.
void	setCreateDate(Date createDate) The date when the role was created.
void	setPath(String path) Path to the role.
void	setRoleId(String roleId) The stable and unique string identifying the role.
void	setRoleName(String roleName) The name identifying the role.
String	toString() Returns a string representation of this object; useful for testing and debugging.
Role	withArn(String arn) The Amazon Resource Name (ARN) specifying the role.
Role	withAssumeRolePolicyDocument(String assumeRolePolicyDocument) The policy that grants an entity permission to assume the role.
Role	withCreateDate(Date createDate) The date when the role was created.
Role	withPath(String path) Path to the role.
Role	withRoleId(String roleId) The stable and unique string identifying the role.
Role	withRoleName(String roleName) The name identifying the role.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Role

public Role()

Method Detail

getPath

public String getPath()

Path to the role. For more information about paths, see Identifiers for IAM Entities in Using AWS Identity and Access Management.

Constraints:
Length: 1 - 512
Pattern: (/)|(/[!-]+/)

Returns:

Path to the role. For more information about paths, see Identifiers for IAM Entities in Using AWS Identity and Access Management.

setPath

public void setPath(String path)

Path to the role. For more information about paths, see Identifiers for IAM Entities in Using AWS Identity and Access Management.

Constraints:
Length: 1 - 512
Pattern: (/)|(/[!-]+/)

Parameters:

path - Path to the role. For more information about paths, see Identifiers for IAM Entities in Using AWS Identity and Access Management.

withPath

public Role withPath(String path)

Path to the role. For more information about paths, see Identifiers for IAM Entities in Using AWS Identity and Access Management.

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

Constraints:
Length: 1 - 512
Pattern: (/)|(/[!-]+/)

Parameters:

path - Path to the role. For more information about paths, see Identifiers for IAM Entities in Using AWS Identity and Access Management.

Returns:

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

getRoleName

public String getRoleName()

The name identifying the role.

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

Returns:

The name identifying the role.

setRoleName

public void setRoleName(String roleName)

The name identifying the role.

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

Parameters:

roleName - The name identifying the role.

withRoleName

public Role withRoleName(String roleName)

The name identifying the role.

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

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

Parameters:

roleName - The name identifying the role.

Returns:

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

getRoleId

public String getRoleId()

The stable and unique string identifying the role. For more information about IDs, see Identifiers for IAM Entities in Using AWS Identity and Access Management.

Constraints:
Length: 16 - 32
Pattern: [\w]*

Returns:

The stable and unique string identifying the role. For more information about IDs, see Identifiers for IAM Entities in Using AWS Identity and Access Management.

setRoleId

public void setRoleId(String roleId)

The stable and unique string identifying the role. For more information about IDs, see Identifiers for IAM Entities in Using AWS Identity and Access Management.

Constraints:
Length: 16 - 32
Pattern: [\w]*

Parameters:

roleId - The stable and unique string identifying the role. For more information about IDs, see Identifiers for IAM Entities in Using AWS Identity and Access Management.

withRoleId

public Role withRoleId(String roleId)

The stable and unique string identifying the role. For more information about IDs, see Identifiers for IAM Entities in Using AWS Identity and Access Management.

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

Constraints:
Length: 16 - 32
Pattern: [\w]*

Parameters:

roleId - The stable and unique string identifying the role. For more information about IDs, see Identifiers for IAM Entities in Using AWS Identity and Access Management.

Returns:

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

getArn

public String getArn()

The Amazon Resource Name (ARN) specifying the role. For more information about ARNs and how to use them in policies, see Identifiers for IAM Entities in Using AWS Identity and Access Management.

Constraints:
Length: 20 - 2048

Returns:

The Amazon Resource Name (ARN) specifying the role. For more information about ARNs and how to use them in policies, see Identifiers for IAM Entities in Using AWS Identity and Access Management.

setArn

public void setArn(String arn)

The Amazon Resource Name (ARN) specifying the role. For more information about ARNs and how to use them in policies, see Identifiers for IAM Entities in Using AWS Identity and Access Management.

Constraints:
Length: 20 - 2048

Parameters:

arn - The Amazon Resource Name (ARN) specifying the role. For more information about ARNs and how to use them in policies, see Identifiers for IAM Entities in Using AWS Identity and Access Management.

withArn

public Role withArn(String arn)

The Amazon Resource Name (ARN) specifying the role. For more information about ARNs and how to use them in policies, see Identifiers for IAM Entities in Using AWS Identity and Access Management.

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

Constraints:
Length: 20 - 2048

Parameters:

arn - The Amazon Resource Name (ARN) specifying the role. For more information about ARNs and how to use them in policies, see Identifiers for IAM Entities in Using AWS Identity and Access Management.

Returns:

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

getCreateDate

public Date getCreateDate()

The date when the role was created.

Returns:

The date when the role was created.

setCreateDate

public void setCreateDate(Date createDate)

The date when the role was created.

Parameters:

createDate - The date when the role was created.

withCreateDate

public Role withCreateDate(Date createDate)

The date when the role was created.

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

Parameters:

createDate - The date when the role was created.

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.

The returned policy is URL-encoded according to RFC 3986. For more information about RFC 3986, go to http://www.faqs.org/rfcs/rfc3986.html.

Constraints:
Length: 1 - 131072
Pattern: [ -?]+

Returns:

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

The returned policy is URL-encoded according to RFC 3986. For more information about RFC 3986, go to http://www.faqs.org/rfcs/rfc3986.html.

setAssumeRolePolicyDocument

public void setAssumeRolePolicyDocument(String assumeRolePolicyDocument)

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

The returned policy is URL-encoded according to RFC 3986. For more information about RFC 3986, go to http://www.faqs.org/rfcs/rfc3986.html.

Constraints:
Length: 1 - 131072
Pattern: [ -?]+

Parameters:

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

The returned policy is URL-encoded according to RFC 3986. For more information about RFC 3986, go to http://www.faqs.org/rfcs/rfc3986.html.

withAssumeRolePolicyDocument

public Role withAssumeRolePolicyDocument(String assumeRolePolicyDocument)

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

The returned policy is URL-encoded according to RFC 3986. For more information about RFC 3986, go to http://www.faqs.org/rfcs/rfc3986.html.

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

Constraints:
Length: 1 - 131072
Pattern: [ -?]+

Parameters:

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

The returned policy is URL-encoded according to RFC 3986. For more information about RFC 3986, go to http://www.faqs.org/rfcs/rfc3986.html.

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