AWS SDK for C++  1.8.95
AWS SDK for C++
Public Member Functions | Protected Member Functions | List of all members
Aws::IAM::Model::UpdateRoleRequest Class Reference

#include <UpdateRoleRequest.h>

+ Inheritance diagram for Aws::IAM::Model::UpdateRoleRequest:

Public Member Functions

 UpdateRoleRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
const Aws::StringGetRoleName () const
 
bool RoleNameHasBeenSet () const
 
void SetRoleName (const Aws::String &value)
 
void SetRoleName (Aws::String &&value)
 
void SetRoleName (const char *value)
 
UpdateRoleRequestWithRoleName (const Aws::String &value)
 
UpdateRoleRequestWithRoleName (Aws::String &&value)
 
UpdateRoleRequestWithRoleName (const char *value)
 
const Aws::StringGetDescription () const
 
bool DescriptionHasBeenSet () const
 
void SetDescription (const Aws::String &value)
 
void SetDescription (Aws::String &&value)
 
void SetDescription (const char *value)
 
UpdateRoleRequestWithDescription (const Aws::String &value)
 
UpdateRoleRequestWithDescription (Aws::String &&value)
 
UpdateRoleRequestWithDescription (const char *value)
 
int GetMaxSessionDuration () const
 
bool MaxSessionDurationHasBeenSet () const
 
void SetMaxSessionDuration (int value)
 
UpdateRoleRequestWithMaxSessionDuration (int value)
 
- Public Member Functions inherited from Aws::IAM::IAMRequest
virtual ~IAMRequest ()
 
void AddParametersToRequest (Aws::Http::HttpRequest &httpRequest) const
 
Aws::Http::HeaderValueCollection GetHeaders () const override
 
- Public Member Functions inherited from Aws::AmazonSerializableWebServiceRequest
 AmazonSerializableWebServiceRequest ()
 
virtual ~AmazonSerializableWebServiceRequest ()
 
std::shared_ptr< Aws::IOStreamGetBody () const override
 
- Public Member Functions inherited from Aws::AmazonWebServiceRequest
 AmazonWebServiceRequest ()
 
virtual ~AmazonWebServiceRequest ()=default
 
virtual void AddQueryStringParameters (Aws::Http::URI &uri) const
 
virtual void PutToPresignedUrl (Aws::Http::URI &uri) const
 
virtual bool IsStreaming () const
 
virtual bool IsEventStreamRequest () const
 
virtual bool SignBody () const
 
virtual bool IsChunked () const
 
virtual void SetRequestSignedHandler (const RequestSignedHandler &handler)
 
virtual const RequestSignedHandlerGetRequestSignedHandler () const
 
const Aws::IOStreamFactoryGetResponseStreamFactory () const
 
void SetResponseStreamFactory (const Aws::IOStreamFactory &factory)
 
virtual void SetDataReceivedEventHandler (const Aws::Http::DataReceivedEventHandler &dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (const Aws::Http::DataSentEventHandler &dataSentEventHandler)
 
virtual void SetContinueRequestHandler (const Aws::Http::ContinueRequestHandler &continueRequestHandler)
 
virtual void SetDataReceivedEventHandler (Aws::Http::DataReceivedEventHandler &&dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (Aws::Http::DataSentEventHandler &&dataSentEventHandler)
 
virtual void SetContinueRequestHandler (Aws::Http::ContinueRequestHandler &&continueRequestHandler)
 
virtual void SetRequestRetryHandler (const RequestRetryHandler &handler)
 
virtual void SetRequestRetryHandler (RequestRetryHandler &&handler)
 
virtual const Aws::Http::DataReceivedEventHandlerGetDataReceivedEventHandler () const
 
virtual const Aws::Http::DataSentEventHandlerGetDataSentEventHandler () const
 
virtual const Aws::Http::ContinueRequestHandlerGetContinueRequestHandler () const
 
virtual const RequestRetryHandlerGetRequestRetryHandler () const
 
virtual bool ShouldComputeContentMd5 () const
 

Protected Member Functions

void DumpBodyToUrl (Aws::Http::URI &uri) const override
 
- Protected Member Functions inherited from Aws::IAM::IAMRequest
virtual Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const
 

Detailed Description

Definition at line 21 of file UpdateRoleRequest.h.

Constructor & Destructor Documentation

◆ UpdateRoleRequest()

Aws::IAM::Model::UpdateRoleRequest::UpdateRoleRequest ( )

Member Function Documentation

◆ DescriptionHasBeenSet()

bool Aws::IAM::Model::UpdateRoleRequest::DescriptionHasBeenSet ( ) const
inline

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

Definition at line 88 of file UpdateRoleRequest.h.

◆ DumpBodyToUrl()

void Aws::IAM::Model::UpdateRoleRequest::DumpBodyToUrl ( Aws::Http::URI uri) const
overrideprotectedvirtual

Default does nothing. Override this to convert what would otherwise be the payload of the request to a query string format.

Reimplemented from Aws::AmazonWebServiceRequest.

◆ GetDescription()

const Aws::String& Aws::IAM::Model::UpdateRoleRequest::GetDescription ( ) const
inline

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

Definition at line 83 of file UpdateRoleRequest.h.

◆ GetMaxSessionDuration()

int Aws::IAM::Model::UpdateRoleRequest::GetMaxSessionDuration ( ) const
inline

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.

Definition at line 138 of file UpdateRoleRequest.h.

◆ GetRoleName()

const Aws::String& Aws::IAM::Model::UpdateRoleRequest::GetRoleName ( ) const
inline

The name of the role that you want to modify.

Definition at line 42 of file UpdateRoleRequest.h.

◆ GetServiceRequestName()

virtual const char* Aws::IAM::Model::UpdateRoleRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 30 of file UpdateRoleRequest.h.

◆ MaxSessionDurationHasBeenSet()

bool Aws::IAM::Model::UpdateRoleRequest::MaxSessionDurationHasBeenSet ( ) const
inline

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.

Definition at line 157 of file UpdateRoleRequest.h.

◆ RoleNameHasBeenSet()

bool Aws::IAM::Model::UpdateRoleRequest::RoleNameHasBeenSet ( ) const
inline

The name of the role that you want to modify.

Definition at line 47 of file UpdateRoleRequest.h.

◆ SerializePayload()

Aws::String Aws::IAM::Model::UpdateRoleRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetDescription() [1/3]

void Aws::IAM::Model::UpdateRoleRequest::SetDescription ( const Aws::String value)
inline

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

Definition at line 93 of file UpdateRoleRequest.h.

◆ SetDescription() [2/3]

void Aws::IAM::Model::UpdateRoleRequest::SetDescription ( Aws::String &&  value)
inline

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

Definition at line 98 of file UpdateRoleRequest.h.

◆ SetDescription() [3/3]

void Aws::IAM::Model::UpdateRoleRequest::SetDescription ( const char *  value)
inline

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

Definition at line 103 of file UpdateRoleRequest.h.

◆ SetMaxSessionDuration()

void Aws::IAM::Model::UpdateRoleRequest::SetMaxSessionDuration ( int  value)
inline

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.

Definition at line 176 of file UpdateRoleRequest.h.

◆ SetRoleName() [1/3]

void Aws::IAM::Model::UpdateRoleRequest::SetRoleName ( const Aws::String value)
inline

The name of the role that you want to modify.

Definition at line 52 of file UpdateRoleRequest.h.

◆ SetRoleName() [2/3]

void Aws::IAM::Model::UpdateRoleRequest::SetRoleName ( Aws::String &&  value)
inline

The name of the role that you want to modify.

Definition at line 57 of file UpdateRoleRequest.h.

◆ SetRoleName() [3/3]

void Aws::IAM::Model::UpdateRoleRequest::SetRoleName ( const char *  value)
inline

The name of the role that you want to modify.

Definition at line 62 of file UpdateRoleRequest.h.

◆ WithDescription() [1/3]

UpdateRoleRequest& Aws::IAM::Model::UpdateRoleRequest::WithDescription ( const Aws::String value)
inline

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

Definition at line 108 of file UpdateRoleRequest.h.

◆ WithDescription() [2/3]

UpdateRoleRequest& Aws::IAM::Model::UpdateRoleRequest::WithDescription ( Aws::String &&  value)
inline

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

Definition at line 113 of file UpdateRoleRequest.h.

◆ WithDescription() [3/3]

UpdateRoleRequest& Aws::IAM::Model::UpdateRoleRequest::WithDescription ( const char *  value)
inline

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

Definition at line 118 of file UpdateRoleRequest.h.

◆ WithMaxSessionDuration()

UpdateRoleRequest& Aws::IAM::Model::UpdateRoleRequest::WithMaxSessionDuration ( int  value)
inline

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.

Definition at line 195 of file UpdateRoleRequest.h.

◆ WithRoleName() [1/3]

UpdateRoleRequest& Aws::IAM::Model::UpdateRoleRequest::WithRoleName ( const Aws::String value)
inline

The name of the role that you want to modify.

Definition at line 67 of file UpdateRoleRequest.h.

◆ WithRoleName() [2/3]

UpdateRoleRequest& Aws::IAM::Model::UpdateRoleRequest::WithRoleName ( Aws::String &&  value)
inline

The name of the role that you want to modify.

Definition at line 72 of file UpdateRoleRequest.h.

◆ WithRoleName() [3/3]

UpdateRoleRequest& Aws::IAM::Model::UpdateRoleRequest::WithRoleName ( const char *  value)
inline

The name of the role that you want to modify.

Definition at line 77 of file UpdateRoleRequest.h.


The documentation for this class was generated from the following file: