Class: Aws::SecurityHub::Types::AwsIamRoleDetails

Inherits:

Struct

• Object
• Struct
• Aws::SecurityHub::Types::AwsIamRoleDetails

Defined in:

gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb

Overview

Note:

When making an API call, you may pass AwsIamRoleDetails data as a hash:

{
  assume_role_policy_document: "AwsIamRoleAssumeRolePolicyDocument",
  attached_managed_policies: [
    {
      policy_name: "NonEmptyString",
      policy_arn: "NonEmptyString",
    },
  ],
  create_date: "NonEmptyString",
  instance_profile_list: [
    {
      arn: "NonEmptyString",
      create_date: "NonEmptyString",
      instance_profile_id: "NonEmptyString",
      instance_profile_name: "NonEmptyString",
      path: "NonEmptyString",
      roles: [
        {
          arn: "NonEmptyString",
          assume_role_policy_document: "AwsIamRoleAssumeRolePolicyDocument",
          create_date: "NonEmptyString",
          path: "NonEmptyString",
          role_id: "NonEmptyString",
          role_name: "NonEmptyString",
        },
      ],
    },
  ],
  permissions_boundary: {
    permissions_boundary_arn: "NonEmptyString",
    permissions_boundary_type: "NonEmptyString",
  },
  role_id: "NonEmptyString",
  role_name: "NonEmptyString",
  role_policy_list: [
    {
      policy_name: "NonEmptyString",
    },
  ],
  max_session_duration: 1,
  path: "NonEmptyString",
}

Contains information about an IAM role, including all of the role's policies.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #assume_role_policy_document ⇒ String

  The trust policy that grants permission to assume the role.

• #attached_managed_policies ⇒ Array<Types::AwsIamAttachedManagedPolicy>

  The list of the managed policies that are attached to the role.

• #create_date ⇒ String

  Indicates when the role was created.

• #instance_profile_list ⇒ Array<Types::AwsIamInstanceProfile>

  The list of instance profiles that contain this role.

• #max_session_duration ⇒ Integer

  The maximum session duration (in seconds) that you want to set for the specified role.

• #path ⇒ String

  The path to the role.

• #permissions_boundary ⇒ Types::AwsIamPermissionsBoundary

  Information about the policy used to set the permissions boundary for an IAM principal.

• #role_id ⇒ String

  The stable and unique string identifying the role.

• #role_name ⇒ String

  The friendly name that identifies the role.

• #role_policy_list ⇒ Array<Types::AwsIamRolePolicy>

  The list of inline policies that are embedded in the role.

Instance Attribute Details

#assume_role_policy_document ⇒ String

The trust policy that grants permission to assume the role.

Returns:

• (String)

# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 6324

class AwsIamRoleDetails < Struct.new(
  :assume_role_policy_document,
  :attached_managed_policies,
  :create_date,
  :instance_profile_list,
  :permissions_boundary,
  :role_id,
  :role_name,
  :role_policy_list,
  :max_session_duration,
  :path)
  SENSITIVE = []
  include Aws::Structure
end

#attached_managed_policies ⇒ Array<Types::AwsIamAttachedManagedPolicy>

The list of the managed policies that are attached to the role.

Returns:

• (Array<Types::AwsIamAttachedManagedPolicy>)

# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 6324

class AwsIamRoleDetails < Struct.new(
  :assume_role_policy_document,
  :attached_managed_policies,
  :create_date,
  :instance_profile_list,
  :permissions_boundary,
  :role_id,
  :role_name,
  :role_policy_list,
  :max_session_duration,
  :path)
  SENSITIVE = []
  include Aws::Structure
end

#create_date ⇒ String

Indicates when the role was created.

Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time Format. The value cannot contain spaces. For example, 2020-03-22T13:22:13.933Z.

Returns:

• (String)

# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 6324

class AwsIamRoleDetails < Struct.new(
  :assume_role_policy_document,
  :attached_managed_policies,
  :create_date,
  :instance_profile_list,
  :permissions_boundary,
  :role_id,
  :role_name,
  :role_policy_list,
  :max_session_duration,
  :path)
  SENSITIVE = []
  include Aws::Structure
end

#instance_profile_list ⇒ Array<Types::AwsIamInstanceProfile>

The list of instance profiles that contain this role.

Returns:

• (Array<Types::AwsIamInstanceProfile>)

# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 6324

class AwsIamRoleDetails < Struct.new(
  :assume_role_policy_document,
  :attached_managed_policies,
  :create_date,
  :instance_profile_list,
  :permissions_boundary,
  :role_id,
  :role_name,
  :role_policy_list,
  :max_session_duration,
  :path)
  SENSITIVE = []
  include Aws::Structure
end

#max_session_duration ⇒ Integer

The maximum session duration (in seconds) that you want to set for the specified role.

Returns:

• (Integer)

# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 6324

class AwsIamRoleDetails < Struct.new(
  :assume_role_policy_document,
  :attached_managed_policies,
  :create_date,
  :instance_profile_list,
  :permissions_boundary,
  :role_id,
  :role_name,
  :role_policy_list,
  :max_session_duration,
  :path)
  SENSITIVE = []
  include Aws::Structure
end

#path ⇒ String

The path to the role.

Returns:

• (String)

# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 6324

class AwsIamRoleDetails < Struct.new(
  :assume_role_policy_document,
  :attached_managed_policies,
  :create_date,
  :instance_profile_list,
  :permissions_boundary,
  :role_id,
  :role_name,
  :role_policy_list,
  :max_session_duration,
  :path)
  SENSITIVE = []
  include Aws::Structure
end

#permissions_boundary ⇒ Types::AwsIamPermissionsBoundary

Information about the policy used to set the permissions boundary for an IAM principal.

Returns:

• (Types::AwsIamPermissionsBoundary)

# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 6324

class AwsIamRoleDetails < Struct.new(
  :assume_role_policy_document,
  :attached_managed_policies,
  :create_date,
  :instance_profile_list,
  :permissions_boundary,
  :role_id,
  :role_name,
  :role_policy_list,
  :max_session_duration,
  :path)
  SENSITIVE = []
  include Aws::Structure
end

#role_id ⇒ String

The stable and unique string identifying the role.

Returns:

• (String)

# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 6324

class AwsIamRoleDetails < Struct.new(
  :assume_role_policy_document,
  :attached_managed_policies,
  :create_date,
  :instance_profile_list,
  :permissions_boundary,
  :role_id,
  :role_name,
  :role_policy_list,
  :max_session_duration,
  :path)
  SENSITIVE = []
  include Aws::Structure
end

#role_name ⇒ String

The friendly name that identifies the role.

Returns:

• (String)

# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 6324

class AwsIamRoleDetails < Struct.new(
  :assume_role_policy_document,
  :attached_managed_policies,
  :create_date,
  :instance_profile_list,
  :permissions_boundary,
  :role_id,
  :role_name,
  :role_policy_list,
  :max_session_duration,
  :path)
  SENSITIVE = []
  include Aws::Structure
end

#role_policy_list ⇒ Array<Types::AwsIamRolePolicy>

The list of inline policies that are embedded in the role.

Returns:

• (Array<Types::AwsIamRolePolicy>)

# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 6324

class AwsIamRoleDetails < Struct.new(
  :assume_role_policy_document,
  :attached_managed_policies,
  :create_date,
  :instance_profile_list,
  :permissions_boundary,
  :role_id,
  :role_name,
  :role_policy_list,
  :max_session_duration,
  :path)
  SENSITIVE = []
  include Aws::Structure
end