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

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

Overview

Note:

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

{
  role_name: "roleNameType", # required
  description: "roleDescriptionType",
  max_session_duration: 1,
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#descriptionString

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

Returns:

  • (String)

12274
12275
12276
12277
12278
12279
12280
# File 'lib/aws-sdk-iam/types.rb', line 12274

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

#max_session_durationInteger

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 maximum 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*.

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

Returns:

  • (Integer)

12274
12275
12276
12277
12278
12279
12280
# File 'lib/aws-sdk-iam/types.rb', line 12274

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

#role_nameString

The name of the role that you want to modify.

Returns:

  • (String)

12274
12275
12276
12277
12278
12279
12280
# File 'lib/aws-sdk-iam/types.rb', line 12274

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