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

Inherits:
Struct
  • Object
show all
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 APIs that interact with roles.

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.

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

Returns:

  • (String) 


6776
6777
6778
6779
6780
6781
6782
6783
6784
6785
 
# File 'lib/aws-sdk-iam/types.rb', line 6776

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

#assume_role_policy_document ⇒ String

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

Returns:

  • (String) 


6776
6777
6778
6779
6780
6781
6782
6783
6784
6785
 
# File 'lib/aws-sdk-iam/types.rb', line 6776

class Role < Struct.new(
  :path,
  :role_name,
  :role_id,
  :arn,
  :create_date,
  :assume_role_policy_document,
  :description)
  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) 


6776
6777
6778
6779
6780
6781
6782
6783
6784
6785
 
# File 'lib/aws-sdk-iam/types.rb', line 6776

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

#description ⇒ String

A description of the role that you provide.

Returns:

  • (String) 


6776
6777
6778
6779
6780
6781
6782
6783
6784
6785
 
# File 'lib/aws-sdk-iam/types.rb', line 6776

class Role < Struct.new(
  :path,
  :role_name,
  :role_id,
  :arn,
  :create_date,
  :assume_role_policy_document,
  :description)
  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) 


6776
6777
6778
6779
6780
6781
6782
6783
6784
6785
 
# File 'lib/aws-sdk-iam/types.rb', line 6776

class Role < Struct.new(
  :path,
  :role_name,
  :role_id,
  :arn,
  :create_date,
  :assume_role_policy_document,
  :description)
  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) 


6776
6777
6778
6779
6780
6781
6782
6783
6784
6785
 
# File 'lib/aws-sdk-iam/types.rb', line 6776

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

#role_name ⇒ String

The friendly name that identifies the role.

Returns:

  • (String) 


6776
6777
6778
6779
6780
6781
6782
6783
6784
6785
 
# File 'lib/aws-sdk-iam/types.rb', line 6776

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