Role

class Role

Contains information about an IAM role. This structure is returned as a response element in several API operations that interact with roles.

Types

Link copied to clipboard
class Builder
Link copied to clipboard
object Companion

Properties

Link copied to clipboard
val arn: String

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.

Link copied to clipboard

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

Link copied to clipboard

The date and time, in ISO 8601 date-time format, when the role was created.

Link copied to clipboard

A description of the role that you provide.

Link copied to clipboard

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.

Link copied to clipboard

The path to the role. For more information about paths, see IAM identifiers in the IAM User Guide.

Link copied to clipboard

The ARN of the policy used to set the permissions boundary for the role.

Link copied to clipboard

The stable and unique string identifying the role. For more information about IDs, see IAM identifiers in the IAM User Guide.

Link copied to clipboard

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.

Link copied to clipboard

The friendly name that identifies the role.

Link copied to clipboard
val tags: List<Tag>?

A list of tags that are attached to the role. For more information about tagging, see Tagging IAM resources in the IAM User Guide.

Functions

Link copied to clipboard
inline fun copy(block: Role.Builder.() -> Unit = {}): Role
Link copied to clipboard
open operator override fun equals(other: Any?): Boolean
Link copied to clipboard
open override fun hashCode(): Int
Link copied to clipboard
open override fun toString(): String