You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::IAM::Types::Role

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

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

Returned by:

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

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

Returns:

  • (String) —

    The Amazon Resource Name (ARN) specifying the role.

#assume_role_policy_document ⇒ String

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

Returns:

  • (String) —

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

#create_date ⇒ Time

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

Returns:

  • (Time) —

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

#description ⇒ String

A description of the role that you provide.

Returns:

  • (String) —

    A description of the role that you provide.

#max_session_duration ⇒ Integer

The maximum session duration (in seconds) for the specified role. Anyone who uses the AWS CLI, or API to assume the role can specify the duration using the optional DurationSeconds API parameter or duration-seconds CLI parameter.

Returns:

  • (Integer) —

    The maximum session duration (in seconds) for the specified role.

#path ⇒ String

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

Returns:

  • (String) —

    The path to the role.

#permissions_boundary ⇒ Types::AttachedPermissionsBoundary

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:

#role_id ⇒ String

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

Returns:

  • (String) —

    The stable and unique string identifying the role.

#role_last_used ⇒ Types::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:

  • (Types::RoleLastUsed) —

    Contains information about the last time that an IAM role was used.

#role_name ⇒ String

The friendly name that identifies the role.

Returns:

  • (String) —

    The friendly name that identifies the role.

#tags ⇒ Array<Types::Tag>

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

Returns:

  • (Array<Types::Tag>) —

    A list of tags that are attached to the specified role.