Role (AWS SDK for Java

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

All Implemented Interfaces:

Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class Role
extends Object
implements Serializable, Cloneable
```
Contains information about an IAM role. This structure is returned as a response element in several APIs that interact with roles.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

Role()

Constructors
Constructor and Description
`Role()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Role`	`clone()`
`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 and time, in ISO 8601 date-time format, when the role was created.
`String`	`getDescription()` A description of the role that you provide.
`String`	`getPath()` The path to the role.
`String`	`getRoleId()` The stable and unique string identifying the role.
`String`	`getRoleName()` The friendly name that identifies 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 and time, in ISO 8601 date-time format, when the role was created.
`void`	`setDescription(String description)` A description of the role that you provide.
`void`	`setPath(String path)` The path to the role.
`void`	`setRoleId(String roleId)` The stable and unique string identifying the role.
`void`	`setRoleName(String roleName)` The friendly name that identifies 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 and time, in ISO 8601 date-time format, when the role was created.
`Role`	`withDescription(String description)` A description of the role that you provide.
`Role`	`withPath(String path)` The path to the role.
`Role`	`withRoleId(String roleId)` The stable and unique string identifying the role.
`Role`	`withRoleName(String roleName)` The friendly name that identifies the role.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - Role
```
public Role()
```
- Method Detail
  - setPath
```
public void setPath(String path)
```
    The path to the role. For more information about paths, see IAM Identifiers in the Using IAM guide.
    
    Parameters:
    
    path - The path to the role. For more information about paths, see IAM Identifiers in the Using IAM guide.
  - getPath
```
public String getPath()
```
    The path to the role. For more information about paths, see IAM Identifiers in the Using IAM guide.
    
    Returns:
    
    The path to the role. For more information about paths, see IAM Identifiers in the Using IAM guide.
  - withPath
```
public Role withPath(String path)
```
    The path to the role. For more information about paths, see IAM Identifiers in the Using IAM guide.
    
    Parameters:
    
    path - The path to the role. For more information about paths, see IAM Identifiers in the Using IAM guide.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setRoleName
```
public void setRoleName(String roleName)
```
    The friendly name that identifies the role.
    
    Parameters:
    
    roleName - The friendly name that identifies the role.
  - getRoleName
```
public String getRoleName()
```
    The friendly name that identifies the role.
    
    Returns:
    
    The friendly name that identifies the role.
  - withRoleName
```
public Role withRoleName(String roleName)
```
    The friendly name that identifies the role.
    
    Parameters:
    
    roleName - The friendly name that identifies the role.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setRoleId
```
public void setRoleId(String roleId)
```
    The stable and unique string identifying the role. For more information about IDs, see IAM Identifiers in the Using IAM guide.
    
    Parameters:
    
    roleId - The stable and unique string identifying the role. For more information about IDs, see IAM Identifiers in the Using IAM guide.
  - getRoleId
```
public String getRoleId()
```
    The stable and unique string identifying the role. For more information about IDs, see IAM Identifiers in the Using IAM guide.
    
    Returns:
    
    The stable and unique string identifying the role. For more information about IDs, see IAM Identifiers in the Using IAM guide.
  - withRoleId
```
public Role withRoleId(String roleId)
```
    The stable and unique string identifying the role. For more information about IDs, see IAM Identifiers in the Using IAM guide.
    
    Parameters:
    
    roleId - The stable and unique string identifying the role. For more information about IDs, see IAM Identifiers in the Using IAM guide.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - 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 IAM Identifiers in the IAM User Guide guide.
    
    Parameters:
    
    arn - The Amazon Resource Name (ARN) specifying the role. For more information about ARNs and how to use them in policies, see IAM Identifiers in the IAM User Guide guide.
  - 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 IAM Identifiers in the IAM User Guide guide.
    
    Returns:
    
    The Amazon Resource Name (ARN) specifying the role. For more information about ARNs and how to use them in policies, see IAM Identifiers in the IAM User Guide guide.
  - 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 IAM Identifiers in the IAM User Guide guide.
    
    Parameters:
    
    arn - The Amazon Resource Name (ARN) specifying the role. For more information about ARNs and how to use them in policies, see IAM Identifiers in the IAM User Guide guide.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCreateDate
```
public void setCreateDate(Date createDate)
```
    The date and time, in ISO 8601 date-time format, when the role was created.
    
    Parameters:
    
    createDate - The date and time, in ISO 8601 date-time format, when the role was created.
  - getCreateDate
```
public Date getCreateDate()
```
    The date and time, in ISO 8601 date-time format, when the role was created.
    
    Returns:
    
    The date and time, in ISO 8601 date-time format, when the role was created.
  - withCreateDate
```
public Role withCreateDate(Date createDate)
```
    The date and time, in ISO 8601 date-time format, when the role was created.
    
    Parameters:
    
    createDate - The date and time, in ISO 8601 date-time format, when the role was created.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setAssumeRolePolicyDocument
```
public void setAssumeRolePolicyDocument(String assumeRolePolicyDocument)
```
    The policy that grants an entity permission to assume the role.
    
    Parameters:
    
    assumeRolePolicyDocument - The policy that grants an entity permission to assume the role.
  - getAssumeRolePolicyDocument
```
public String getAssumeRolePolicyDocument()
```
    The policy that grants an entity permission to assume the role.
    
    Returns:
    
    The policy that grants an entity permission to assume the role.
  - withAssumeRolePolicyDocument
```
public Role withAssumeRolePolicyDocument(String assumeRolePolicyDocument)
```
    The policy that grants an entity permission to assume the role.
    
    Parameters:
    
    assumeRolePolicyDocument - The policy that grants an entity permission to assume the role.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDescription
```
public void setDescription(String description)
```
    A description of the role that you provide.
    
    Parameters:
    
    description - A description of the role that you provide.
  - getDescription
```
public String getDescription()
```
    A description of the role that you provide.
    
    Returns:
    
    A description of the role that you provide.
  - withDescription
```
public Role withDescription(String description)
```
    A description of the role that you provide.
    
    Parameters:
    
    description - A description of the role that you provide.
    
    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 Role clone()
```
    Overrides:
    
    clone in class Object

Did this page help you?

Class Role

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Role

Method Detail

setPath

getPath

withPath

setRoleName

getRoleName

withRoleName

setRoleId

getRoleId

withRoleId

setArn

getArn

withArn

setCreateDate

getCreateDate

withCreateDate

setAssumeRolePolicyDocument

getAssumeRolePolicyDocument

withAssumeRolePolicyDocument

setDescription

getDescription

withDescription

toString

equals

hashCode

clone