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 API operations 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)


7192
7193
7194
7195
7196
7197
7198
7199
7200
7201
7202
7203
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/types.rb', line 7192

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

#assume_role_policy_documentString

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

Returns:

  • (String)


7192
7193
7194
7195
7196
7197
7198
7199
7200
7201
7202
7203
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/types.rb', line 7192

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

#create_dateTime

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

Returns:

  • (Time)


7192
7193
7194
7195
7196
7197
7198
7199
7200
7201
7202
7203
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/types.rb', line 7192

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

#descriptionString

A description of the role that you provide.

Returns:

  • (String)


7192
7193
7194
7195
7196
7197
7198
7199
7200
7201
7202
7203
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/types.rb', line 7192

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

#max_session_durationInteger

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)


7192
7193
7194
7195
7196
7197
7198
7199
7200
7201
7202
7203
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/types.rb', line 7192

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


7192
7193
7194
7195
7196
7197
7198
7199
7200
7201
7202
7203
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/types.rb', line 7192

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

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



7192
7193
7194
7195
7196
7197
7198
7199
7200
7201
7202
7203
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/types.rb', line 7192

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


7192
7193
7194
7195
7196
7197
7198
7199
7200
7201
7202
7203
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/types.rb', line 7192

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

#role_nameString

The friendly name that identifies the role.

Returns:

  • (String)


7192
7193
7194
7195
7196
7197
7198
7199
7200
7201
7202
7203
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/types.rb', line 7192

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