AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

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

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing UpdateRoleRequest as input to an Aws::Client method, you can use a vanilla Hash:

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

Instance Attribute Summary collapse

Instance Attribute Details

#descriptionString

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

Returns:

  • (String)

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

#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 AWS 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.

Returns:

  • (Integer)

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

#role_nameString

The name of the role that you want to modify.

Returns:

  • (String)

    The name of the role that you want to modify.