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

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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-iam/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.

Instance Attribute Summary collapse

Instance Attribute Details

#arnString

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)


6776
6777
6778
6779
6780
6781
6782
6783
6784
6785
# File 'gems/aws-sdk-iam/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_documentString

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

Returns:

  • (String)


6776
6777
6778
6779
6780
6781
6782
6783
6784
6785
# File 'gems/aws-sdk-iam/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_dateTime

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

Returns:

  • (Time)


6776
6777
6778
6779
6780
6781
6782
6783
6784
6785
# File 'gems/aws-sdk-iam/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

#descriptionString

A description of the role that you provide.

Returns:

  • (String)


6776
6777
6778
6779
6780
6781
6782
6783
6784
6785
# File 'gems/aws-sdk-iam/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

#pathString

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

Returns:

  • (String)


6776
6777
6778
6779
6780
6781
6782
6783
6784
6785
# File 'gems/aws-sdk-iam/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_idString

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

Returns:

  • (String)


6776
6777
6778
6779
6780
6781
6782
6783
6784
6785
# File 'gems/aws-sdk-iam/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_nameString

The friendly name that identifies the role.

Returns:

  • (String)


6776
6777
6778
6779
6780
6781
6782
6783
6784
6785
# File 'gems/aws-sdk-iam/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