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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-iam/lib/aws-sdk-iam/types.rb

Overview

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#description ⇒ String

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

Returns:

  • (String)


13842
13843
13844
13845
13846
13847
13848
13849
13850
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/types.rb', line 13842

class UpdateRoleRequest < Struct.new(
  :role_name,
  :description,
  :max_session_duration,
  :max_signin_session_duration,
  :reset_max_signin_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.

IAM role credentials provided by Amazon EC2 instances assigned to the role are not subject to the specified maximum session duration.

Returns:

  • (Integer)


13842
13843
13844
13845
13846
13847
13848
13849
13850
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/types.rb', line 13842

class UpdateRoleRequest < Struct.new(
  :role_name,
  :description,
  :max_session_duration,
  :max_signin_session_duration,
  :reset_max_signin_session_duration)
  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 the specified role. This setting can have a value from 1 hour (3600 seconds) to 90 days (7776000 seconds), inclusive, and replaces any value currently configured for the role. This setting is independent of MaxSessionDuration.

If you omit both this parameter and ResetMaxSigninSessionDuration, the current setting is unchanged. You cannot specify this parameter and set ResetMaxSigninSessionDuration to true in the same request.

Changes to this setting apply to new sign-in sessions. Sessions that are already established are not affected.

You cannot set this value on a service-linked role.

Returns:

  • (Integer)


13842
13843
13844
13845
13846
13847
13848
13849
13850
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/types.rb', line 13842

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

#reset_max_signin_session_duration ⇒ Boolean

Specifies whether to clear the role's maximum sign-in session duration. Set this value to true to return the setting to its unset state, so that the existing sign-in session behavior applies. When the setting is unset, the role's MaxSigninSessionDuration is omitted from responses.

If you set this value to false or omit it, the current setting is not cleared. You cannot set this value to true and specify MaxSigninSessionDuration in the same request. Clearing a setting that is already unset has no effect.

You cannot reset this value on a service-linked role.

Returns:

  • (Boolean)


13842
13843
13844
13845
13846
13847
13848
13849
13850
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/types.rb', line 13842

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

#role_name ⇒ String

The name of the role that you want to modify.

Returns:

  • (String)


13842
13843
13844
13845
13846
13847
13848
13849
13850
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/types.rb', line 13842

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