AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

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.

Constant Summary collapse

SENSITIVE =
[]

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)


9625
9626
9627
9628
9629
9630
9631
9632
9633
9634
9635
9636
9637
9638
9639
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/types.rb', line 9625

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

#assume_role_policy_documentString

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

Returns:

  • (String)


9625
9626
9627
9628
9629
9630
9631
9632
9633
9634
9635
9636
9637
9638
9639
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/types.rb', line 9625

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

#create_dateTime

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

Returns:

  • (Time)


9625
9626
9627
9628
9629
9630
9631
9632
9633
9634
9635
9636
9637
9638
9639
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/types.rb', line 9625

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

#descriptionString

A description of the role that you provide.

Returns:

  • (String)


9625
9626
9627
9628
9629
9630
9631
9632
9633
9634
9635
9636
9637
9638
9639
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/types.rb', line 9625

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


9625
9626
9627
9628
9629
9630
9631
9632
9633
9634
9635
9636
9637
9638
9639
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/types.rb', line 9625

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

#pathString

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

Returns:

  • (String)


9625
9626
9627
9628
9629
9630
9631
9632
9633
9634
9635
9636
9637
9638
9639
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/types.rb', line 9625

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



9625
9626
9627
9628
9629
9630
9631
9632
9633
9634
9635
9636
9637
9638
9639
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/types.rb', line 9625

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

#role_idString

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

Returns:

  • (String)


9625
9626
9627
9628
9629
9630
9631
9632
9633
9634
9635
9636
9637
9638
9639
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/types.rb', line 9625

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

#role_last_usedTypes::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:



9625
9626
9627
9628
9629
9630
9631
9632
9633
9634
9635
9636
9637
9638
9639
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/types.rb', line 9625

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

#role_nameString

The friendly name that identifies the role.

Returns:

  • (String)


9625
9626
9627
9628
9629
9630
9631
9632
9633
9634
9635
9636
9637
9638
9639
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/types.rb', line 9625

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

#tagsArray<Types::Tag>

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

Returns:



9625
9626
9627
9628
9629
9630
9631
9632
9633
9634
9635
9636
9637
9638
9639
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/types.rb', line 9625

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