Class: Aws::IAM::Types::Role
- Inherits:
-
Struct
- Object
- Struct
- Aws::IAM::Types::Role
- 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
-
#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][1], 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.
-
#max_signin_session_duration ⇒ Integer
The maximum duration (in seconds) of an Amazon Web Services Sign-In session for users who sign in with this 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_last_used ⇒ Types::RoleLastUsed
Contains information about the last time that an IAM role was used.
-
#role_name ⇒ String
The friendly name that identifies the role.
-
#source_role_template ⇒ Types::SourceRoleTemplate
Contains information about the role template that this role was created from.
-
#tags ⇒ Array<Types::Tag>
A list of tags that are attached to the 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.
10867 10868 10869 10870 10871 10872 10873 10874 10875 10876 10877 10878 10879 10880 10881 10882 10883 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/types.rb', line 10867 class Role < Struct.new( :path, :role_name, :role_id, :arn, :create_date, :assume_role_policy_document, :description, :max_session_duration, :max_signin_session_duration, :permissions_boundary, :tags, :role_last_used, :source_role_template) SENSITIVE = [] include Aws::Structure end |
#assume_role_policy_document ⇒ String
The policy that grants an entity permission to assume the role.
10867 10868 10869 10870 10871 10872 10873 10874 10875 10876 10877 10878 10879 10880 10881 10882 10883 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/types.rb', line 10867 class Role < Struct.new( :path, :role_name, :role_id, :arn, :create_date, :assume_role_policy_document, :description, :max_session_duration, :max_signin_session_duration, :permissions_boundary, :tags, :role_last_used, :source_role_template) SENSITIVE = [] include Aws::Structure end |
#create_date ⇒ Time
The date and time, in ISO 8601 date-time format, when the role was created.
10867 10868 10869 10870 10871 10872 10873 10874 10875 10876 10877 10878 10879 10880 10881 10882 10883 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/types.rb', line 10867 class Role < Struct.new( :path, :role_name, :role_id, :arn, :create_date, :assume_role_policy_document, :description, :max_session_duration, :max_signin_session_duration, :permissions_boundary, :tags, :role_last_used, :source_role_template) SENSITIVE = [] include Aws::Structure end |
#description ⇒ String
A description of the role that you provide.
10867 10868 10869 10870 10871 10872 10873 10874 10875 10876 10877 10878 10879 10880 10881 10882 10883 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/types.rb', line 10867 class Role < Struct.new( :path, :role_name, :role_id, :arn, :create_date, :assume_role_policy_document, :description, :max_session_duration, :max_signin_session_duration, :permissions_boundary, :tags, :role_last_used, :source_role_template) SENSITIVE = [] include Aws::Structure end |
#max_session_duration ⇒ Integer
The maximum session duration (in seconds) for the specified role.
Anyone who uses the CLI, or API to assume the role can specify the
duration using the optional DurationSeconds API parameter or
duration-seconds CLI parameter.
10867 10868 10869 10870 10871 10872 10873 10874 10875 10876 10877 10878 10879 10880 10881 10882 10883 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/types.rb', line 10867 class Role < Struct.new( :path, :role_name, :role_id, :arn, :create_date, :assume_role_policy_document, :description, :max_session_duration, :max_signin_session_duration, :permissions_boundary, :tags, :role_last_used, :source_role_template) SENSITIVE = [] include Aws::Structure end |
#max_signin_session_duration ⇒ Integer
The maximum duration (in seconds) of an Amazon Web Services Sign-In
session for users who sign in with this role. This value is
independent of MaxSessionDuration.
This member is omitted when the setting is unset. In that case, no default value is returned and the existing sign-in session behavior applies.
10867 10868 10869 10870 10871 10872 10873 10874 10875 10876 10877 10878 10879 10880 10881 10882 10883 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/types.rb', line 10867 class Role < Struct.new( :path, :role_name, :role_id, :arn, :create_date, :assume_role_policy_document, :description, :max_session_duration, :max_signin_session_duration, :permissions_boundary, :tags, :role_last_used, :source_role_template) SENSITIVE = [] include Aws::Structure end |
#path ⇒ String
The path to the role. For more information about paths, see IAM identifiers in the IAM User Guide.
10867 10868 10869 10870 10871 10872 10873 10874 10875 10876 10877 10878 10879 10880 10881 10882 10883 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/types.rb', line 10867 class Role < Struct.new( :path, :role_name, :role_id, :arn, :create_date, :assume_role_policy_document, :description, :max_session_duration, :max_signin_session_duration, :permissions_boundary, :tags, :role_last_used, :source_role_template) SENSITIVE = [] 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 in the IAM User Guide.
10867 10868 10869 10870 10871 10872 10873 10874 10875 10876 10877 10878 10879 10880 10881 10882 10883 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/types.rb', line 10867 class Role < Struct.new( :path, :role_name, :role_id, :arn, :create_date, :assume_role_policy_document, :description, :max_session_duration, :max_signin_session_duration, :permissions_boundary, :tags, :role_last_used, :source_role_template) SENSITIVE = [] 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 IAM User Guide.
10867 10868 10869 10870 10871 10872 10873 10874 10875 10876 10877 10878 10879 10880 10881 10882 10883 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/types.rb', line 10867 class Role < Struct.new( :path, :role_name, :role_id, :arn, :create_date, :assume_role_policy_document, :description, :max_session_duration, :max_signin_session_duration, :permissions_boundary, :tags, :role_last_used, :source_role_template) SENSITIVE = [] include Aws::Structure end |
#role_last_used ⇒ Types::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.
10867 10868 10869 10870 10871 10872 10873 10874 10875 10876 10877 10878 10879 10880 10881 10882 10883 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/types.rb', line 10867 class Role < Struct.new( :path, :role_name, :role_id, :arn, :create_date, :assume_role_policy_document, :description, :max_session_duration, :max_signin_session_duration, :permissions_boundary, :tags, :role_last_used, :source_role_template) SENSITIVE = [] include Aws::Structure end |
#role_name ⇒ String
The friendly name that identifies the role.
10867 10868 10869 10870 10871 10872 10873 10874 10875 10876 10877 10878 10879 10880 10881 10882 10883 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/types.rb', line 10867 class Role < Struct.new( :path, :role_name, :role_id, :arn, :create_date, :assume_role_policy_document, :description, :max_session_duration, :max_signin_session_duration, :permissions_boundary, :tags, :role_last_used, :source_role_template) SENSITIVE = [] include Aws::Structure end |
#source_role_template ⇒ Types::SourceRoleTemplate
Contains information about the role template that this role was created from. This member is present only for roles created with AcquireRole.
10867 10868 10869 10870 10871 10872 10873 10874 10875 10876 10877 10878 10879 10880 10881 10882 10883 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/types.rb', line 10867 class Role < Struct.new( :path, :role_name, :role_id, :arn, :create_date, :assume_role_policy_document, :description, :max_session_duration, :max_signin_session_duration, :permissions_boundary, :tags, :role_last_used, :source_role_template) SENSITIVE = [] include Aws::Structure end |
#tags ⇒ Array<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.
10867 10868 10869 10870 10871 10872 10873 10874 10875 10876 10877 10878 10879 10880 10881 10882 10883 |
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/types.rb', line 10867 class Role < Struct.new( :path, :role_name, :role_id, :arn, :create_date, :assume_role_policy_document, :description, :max_session_duration, :max_signin_session_duration, :permissions_boundary, :tags, :role_last_used, :source_role_template) SENSITIVE = [] include Aws::Structure end |