Class: Aws::IAM::Types::UpdateRoleRequest

Inherits:

Struct

• Object
• Struct
• Aws::IAM::Types::UpdateRoleRequest

Includes:

Structure

Defined in:

lib/aws-sdk-iam/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #description ⇒ String

  The new description that you want to apply to the specified role.

• #max_session_duration ⇒ Integer

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

• #role_name ⇒ String

  The name of the role that you want to modify.

Instance Attribute Details

#description ⇒ String

The new description that you want to apply to the specified role.

Returns:

• (String)

# File 'lib/aws-sdk-iam/types.rb', line 11330

class UpdateRoleRequest < Struct.new(
  :role_name,
  :description,
  :max_session_duration)
  SENSITIVE = []
  include Aws::Structure
end

#max_session_duration ⇒ Integer

The maximum session duration (in seconds) that you want to set for the specified role. If you do not specify a value for this setting, the default value of one hour is applied. This setting can have a value from 1 hour to 12 hours.

Anyone who assumes the role from the CLI or API can use the ‘DurationSeconds` API parameter or the `duration-seconds` CLI parameter to request a longer session. The `MaxSessionDuration` setting determines the maximum duration that can be requested using the `DurationSeconds` parameter. If users don’t specify a value for the ‘DurationSeconds` parameter, their security credentials are valid for one hour by default. This applies when you use the `AssumeRole*` API operations or the `assume-role*` CLI operations but does not apply when you use those operations to create a console URL. For more information, see [Using IAM roles] in the *IAM User Guide*.

<note markdown=“1”> IAM role credentials provided by Amazon EC2 instances assigned to the role are not subject to the specified maximum session duration.

</note>

[1]: docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use.html

Returns:

• (Integer)

# File 'lib/aws-sdk-iam/types.rb', line 11330

class UpdateRoleRequest < Struct.new(
  :role_name,
  :description,
  :max_session_duration)
  SENSITIVE = []
  include Aws::Structure
end

#role_name ⇒ String

The name of the role that you want to modify.

Returns:

• (String)

# File 'lib/aws-sdk-iam/types.rb', line 11330

class UpdateRoleRequest < Struct.new(
  :role_name,
  :description,
  :max_session_duration)
  SENSITIVE = []
  include Aws::Structure
end