Role (AWS SDK for Java

JavaScript is disabled on your browser.

AWS SDK for Java 1.x API Reference - 1.12.795

We announced the upcoming end-of-support for AWS SDK for Java (v1). We recommend that you migrate to AWS SDK for Java v2. For dates, additional details, and information on how to migrate, please refer to the linked announcement.

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

com.amazonaws.services.identitymanagement.model

Class Role

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 API operations 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
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.
`Integer`	`getMaxSessionDuration ()` The maximum session duration (in seconds) for the specified role.
`String`	`getPath ()` The path to the role.
`AttachedPermissionsBoundary`	`getPermissionsBoundary ()` The ARN of the policy used to set the permissions boundary for the role.
`String`	`getRoleId ()` The stable and unique string identifying the role.
`RoleLastUsed`	`getRoleLastUsed ()` Contains information about the last time that an IAM role was used.
`String`	`getRoleName ()` The friendly name that identifies the role.
`List<Tag>`	`getTags ()` A list of tags that are attached to 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`	`setMaxSessionDuration (Integer maxSessionDuration)` The maximum session duration (in seconds) for the specified role.
`void`	`setPath (String path)` The path to the role.
`void`	`setPermissionsBoundary (AttachedPermissionsBoundary permissionsBoundary)` The ARN of the policy used to set the permissions boundary for the role.
`void`	`setRoleId (String roleId)` The stable and unique string identifying the role.
`void`	`setRoleLastUsed (RoleLastUsed roleLastUsed)` Contains information about the last time that an IAM role was used.
`void`	`setRoleName (String roleName)` The friendly name that identifies the role.
`void`	`setTags (Collection<Tag> tags)` A list of tags that are attached to the role.
`String`	`toString ()` Returns a string representation of this object.
`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`	`withMaxSessionDuration (Integer maxSessionDuration)` The maximum session duration (in seconds) for the specified role.
`Role`	`withPath (String path)` The path to the role.
`Role`	`withPermissionsBoundary (AttachedPermissionsBoundary permissionsBoundary)` The ARN of the policy used to set the permissions boundary for the role.
`Role`	`withRoleId (String roleId)` The stable and unique string identifying the role.
`Role`	`withRoleLastUsed (RoleLastUsed roleLastUsed)` Contains information about the last time that an IAM role was used.
`Role`	`withRoleName (String roleName)` The friendly name that identifies the role.
`Role`	`withTags (Collection<Tag> tags)` A list of tags that are attached to the role.
`Role`	`withTags (Tag... tags)` A list of tags that are attached to 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 IAM User Guide.
    
    Parameters:
    
    path - The path to the role. For more information about paths, see IAM identifiers in the IAM User Guide.
  - getPath
```
public String getPath()
```
    The path to the role. For more information about paths, see IAM identifiers in the IAM User Guide.
    
    Returns:
    
    The path to the role. For more information about paths, see IAM identifiers in the IAM User Guide.
  - withPath
```
public Role withPath(String path)
```
    The path to the role. For more information about paths, see IAM identifiers in the IAM User Guide.
    
    Parameters:
    
    path - The path to the role. For more information about paths, see IAM identifiers in the IAM User 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 IAM User Guide.
    
    Parameters:
    
    roleId - The stable and unique string identifying the role. For more information about IDs, see IAM identifiers in the IAM User Guide.
  - getRoleId
```
public String getRoleId()
```
    The stable and unique string identifying the role. For more information about IDs, see IAM identifiers in the IAM User Guide.
    
    Returns:
    
    The stable and unique string identifying the role. For more information about IDs, see IAM identifiers in the IAM User 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 IAM User Guide.
    
    Parameters:
    
    roleId - The stable and unique string identifying the role. For more information about IDs, see IAM identifiers in the IAM User 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.
  - setMaxSessionDuration
```
public void setMaxSessionDuration(Integer maxSessionDuration)
```
    The maximum session duration (in seconds) for the specified role. Anyone who uses the CLI, or API to assume the role can specify the duration using the optional DurationSeconds API parameter or duration-seconds CLI parameter.
    
    Parameters:
    
    maxSessionDuration - The maximum session duration (in seconds) for the specified role. Anyone who uses the CLI, or API to assume the role can specify the duration using the optional DurationSeconds API parameter or duration-seconds CLI parameter.
  - getMaxSessionDuration
```
public Integer getMaxSessionDuration()
```
    The maximum session duration (in seconds) for the specified role. Anyone who uses the CLI, or API to assume the role can specify the duration using the optional DurationSeconds API parameter or duration-seconds CLI parameter.
    
    Returns:
    
    The maximum session duration (in seconds) for the specified role. Anyone who uses the CLI, or API to assume the role can specify the duration using the optional DurationSeconds API parameter or duration-seconds CLI parameter.
  - withMaxSessionDuration
```
public Role withMaxSessionDuration(Integer maxSessionDuration)
```
    The maximum session duration (in seconds) for the specified role. Anyone who uses the CLI, or API to assume the role can specify the duration using the optional DurationSeconds API parameter or duration-seconds CLI parameter.
    
    Parameters:
    
    maxSessionDuration - The maximum session duration (in seconds) for the specified role. Anyone who uses the CLI, or API to assume the role can specify the duration using the optional DurationSeconds API parameter or duration-seconds CLI parameter.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setPermissionsBoundary
```
public void setPermissionsBoundary(AttachedPermissionsBoundary permissionsBoundary)
```
    The ARN of the policy used to set the permissions boundary for the role.
    
    For more information about permissions boundaries, see Permissions boundaries for IAM identities in the IAM User Guide.
    
    Parameters:
    
    permissionsBoundary - The ARN of the policy used to set the permissions boundary for the role.
    
    For more information about permissions boundaries, see Permissions boundaries for IAM identities in the IAM User Guide.
  - getPermissionsBoundary
```
public AttachedPermissionsBoundary getPermissionsBoundary()
```
    The ARN of the policy used to set the permissions boundary for the role.
    
    For more information about permissions boundaries, see Permissions boundaries for IAM identities in the IAM User Guide.
    
    Returns:
    
    The ARN of the policy used to set the permissions boundary for the role.
    
    For more information about permissions boundaries, see Permissions boundaries for IAM identities in the IAM User Guide.
  - withPermissionsBoundary
```
public Role withPermissionsBoundary(AttachedPermissionsBoundary permissionsBoundary)
```
    The ARN of the policy used to set the permissions boundary for the role.
    
    For more information about permissions boundaries, see Permissions boundaries for IAM identities in the IAM User Guide.
    
    Parameters:
    
    permissionsBoundary - The ARN of the policy used to set the permissions boundary for the role.
    
    For more information about permissions boundaries, see Permissions boundaries for IAM identities in the IAM User Guide.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getTags
```
public List<Tag> getTags()
```
    A list of tags that are attached to the role. For more information about tagging, see Tagging IAM resources in the IAM User Guide.
    
    Returns:
    
    A list of tags that are attached to the role. For more information about tagging, see Tagging IAM resources in the IAM User Guide.
  - setTags
```
public void setTags(Collection<Tag> tags)
```
    A list of tags that are attached to the role. For more information about tagging, see Tagging IAM resources in the IAM User Guide.
    
    Parameters:
    
    tags - A list of tags that are attached to the role. For more information about tagging, see Tagging IAM resources in the IAM User Guide.
  - withTags
```
public Role withTags(Tag... tags)
```
    A list of tags that are attached to the role. For more information about tagging, see Tagging IAM resources in the IAM User Guide.
    
    NOTE: This method appends the values to the existing list (if any). Use setTags(java.util.Collection) or withTags(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    tags - A list of tags that are attached to the role. For more information about tagging, see Tagging IAM resources in the IAM User Guide.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withTags
```
public Role withTags(Collection<Tag> tags)
```
    A list of tags that are attached to the role. For more information about tagging, see Tagging IAM resources in the IAM User Guide.
    
    Parameters:
    
    tags - A list of tags that are attached to the role. For more information about tagging, see Tagging IAM resources in the IAM User Guide.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setRoleLastUsed
```
public void setRoleLastUsed(RoleLastUsed roleLastUsed)
```
    Contains information about the last time that an IAM role was used. This includes the date and time and the Region in which the role was last used. Activity is only reported for the trailing 400 days. This period can be shorter if your Region began supporting these features within the last year. The role might have been used more than 400 days ago. For more information, see Regions where data is tracked in the IAM user Guide.
    
    Parameters:
    
    roleLastUsed - Contains information about the last time that an IAM role was used. This includes the date and time and the Region in which the role was last used. Activity is only reported for the trailing 400 days. This period can be shorter if your Region began supporting these features within the last year. The role might have been used more than 400 days ago. For more information, see Regions where data is tracked in the IAM user Guide.
  - getRoleLastUsed
```
public RoleLastUsed getRoleLastUsed()
```
    Contains information about the last time that an IAM role was used. This includes the date and time and the Region in which the role was last used. Activity is only reported for the trailing 400 days. This period can be shorter if your Region began supporting these features within the last year. The role might have been used more than 400 days ago. For more information, see Regions where data is tracked in the IAM user Guide.
    
    Returns:
    
    Contains information about the last time that an IAM role was used. This includes the date and time and the Region in which the role was last used. Activity is only reported for the trailing 400 days. This period can be shorter if your Region began supporting these features within the last year. The role might have been used more than 400 days ago. For more information, see Regions where data is tracked in the IAM user Guide.
  - withRoleLastUsed
```
public Role withRoleLastUsed(RoleLastUsed roleLastUsed)
```
    Contains information about the last time that an IAM role was used. This includes the date and time and the Region in which the role was last used. Activity is only reported for the trailing 400 days. This period can be shorter if your Region began supporting these features within the last year. The role might have been used more than 400 days ago. For more information, see Regions where data is tracked in the IAM user Guide.
    
    Parameters:
    
    roleLastUsed - Contains information about the last time that an IAM role was used. This includes the date and time and the Region in which the role was last used. Activity is only reported for the trailing 400 days. This period can be shorter if your Region began supporting these features within the last year. The role might have been used more than 400 days ago. For more information, see Regions where data is tracked in the IAM user Guide.
    
    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 Role clone()
```
    Overrides:
    
    clone in class Object

Skip navigation links

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

AWS SDK for Java 1.x API Reference - 1.12.795

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

setMaxSessionDuration

getMaxSessionDuration

withMaxSessionDuration

setPermissionsBoundary

getPermissionsBoundary

withPermissionsBoundary

getTags

setTags

withTags

withTags

setRoleLastUsed

getRoleLastUsed

withRoleLastUsed

toString

equals

hashCode

clone