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

Inherits:

Struct

• Object
• Struct
• Aws::IAM::Types::Role

Includes:

Structure

Defined in:

lib/aws-sdk-iam/types.rb

Overview

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

Instance Attribute Summary

• #arn ⇒ 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.

• #create_date ⇒ Time

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

• #description ⇒ String

  A description of the role that you provide.

• #max_session_duration ⇒ Integer

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

• #path ⇒ String

  The path to the role.

• #permissions_boundary ⇒ Types::AttachedPermissionsBoundary

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

• #role_id ⇒ String

  The stable and unique string identifying the role.

• #role_name ⇒ String

  The friendly name that identifies the role.

• #tags ⇒ Array<Types::Tag>

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

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.

[1]: docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html

Returns:

• (String)

# File 'lib/aws-sdk-iam/types.rb', line 7982

class Role < Struct.new(
  :path,
  :role_name,
  :role_id,
  :arn,
  :create_date,
  :assume_role_policy_document,
  :description,
  :max_session_duration,
  :permissions_boundary,
  :tags)
  include Aws::Structure
end

#assume_role_policy_document ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-iam/types.rb', line 7982

class Role < Struct.new(
  :path,
  :role_name,
  :role_id,
  :arn,
  :create_date,
  :assume_role_policy_document,
  :description,
  :max_session_duration,
  :permissions_boundary,
  :tags)
  include Aws::Structure
end

#create_date ⇒ Time

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

[1]: www.iso.org/iso/iso8601

Returns:

• (Time)

# File 'lib/aws-sdk-iam/types.rb', line 7982

class Role < Struct.new(
  :path,
  :role_name,
  :role_id,
  :arn,
  :create_date,
  :assume_role_policy_document,
  :description,
  :max_session_duration,
  :permissions_boundary,
  :tags)
  include Aws::Structure
end

#description ⇒ String

A description of the role that you provide.

Returns:

• (String)

# File 'lib/aws-sdk-iam/types.rb', line 7982

class Role < Struct.new(
  :path,
  :role_name,
  :role_id,
  :arn,
  :create_date,
  :assume_role_policy_document,
  :description,
  :max_session_duration,
  :permissions_boundary,
  :tags)
  include Aws::Structure
end

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

# File 'lib/aws-sdk-iam/types.rb', line 7982

class Role < Struct.new(
  :path,
  :role_name,
  :role_id,
  :arn,
  :create_date,
  :assume_role_policy_document,
  :description,
  :max_session_duration,
  :permissions_boundary,
  :tags)
  include Aws::Structure
end

#path ⇒ String

The path to the role. For more information about paths, see [IAM Identifiers] in the *Using IAM* guide.

[1]: docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html

Returns:

• (String)

# File 'lib/aws-sdk-iam/types.rb', line 7982

class Role < Struct.new(
  :path,
  :role_name,
  :role_id,
  :arn,
  :create_date,
  :assume_role_policy_document,
  :description,
  :max_session_duration,
  :permissions_boundary,
  :tags)
  include Aws::Structure
end

#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 ](IAM/latest/UserGuide/access_policies_boundaries.html) in the *IAM User Guide*.

Returns:

• (Types::AttachedPermissionsBoundary)

# File 'lib/aws-sdk-iam/types.rb', line 7982

class Role < Struct.new(
  :path,
  :role_name,
  :role_id,
  :arn,
  :create_date,
  :assume_role_policy_document,
  :description,
  :max_session_duration,
  :permissions_boundary,
  :tags)
  include Aws::Structure
end

#role_id ⇒ String

The stable and unique string identifying the role. For more information about IDs, see [IAM Identifiers] in the *Using IAM* guide.

[1]: docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html

Returns:

• (String)

# File 'lib/aws-sdk-iam/types.rb', line 7982

class Role < Struct.new(
  :path,
  :role_name,
  :role_id,
  :arn,
  :create_date,
  :assume_role_policy_document,
  :description,
  :max_session_duration,
  :permissions_boundary,
  :tags)
  include Aws::Structure
end

#role_name ⇒ String

The friendly name that identifies the role.

Returns:

• (String)

# File 'lib/aws-sdk-iam/types.rb', line 7982

class Role < Struct.new(
  :path,
  :role_name,
  :role_id,
  :arn,
  :create_date,
  :assume_role_policy_document,
  :description,
  :max_session_duration,
  :permissions_boundary,
  :tags)
  include Aws::Structure
end

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

[1]: docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html

Returns:

• (Array<Types::Tag>)

# File 'lib/aws-sdk-iam/types.rb', line 7982

class Role < Struct.new(
  :path,
  :role_name,
  :role_id,
  :arn,
  :create_date,
  :assume_role_policy_document,
  :description,
  :max_session_duration,
  :permissions_boundary,
  :tags)
  include Aws::Structure
end