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

#include <CreateRoleRequest.h>

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

Public Member Functions

 CreateRoleRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
const Aws::StringGetPath () const
 
bool PathHasBeenSet () const
 
void SetPath (const Aws::String &value)
 
void SetPath (Aws::String &&value)
 
void SetPath (const char *value)
 
CreateRoleRequestWithPath (const Aws::String &value)
 
CreateRoleRequestWithPath (Aws::String &&value)
 
CreateRoleRequestWithPath (const char *value)
 
const Aws::StringGetRoleName () const
 
bool RoleNameHasBeenSet () const
 
void SetRoleName (const Aws::String &value)
 
void SetRoleName (Aws::String &&value)
 
void SetRoleName (const char *value)
 
CreateRoleRequestWithRoleName (const Aws::String &value)
 
CreateRoleRequestWithRoleName (Aws::String &&value)
 
CreateRoleRequestWithRoleName (const char *value)
 
const Aws::StringGetAssumeRolePolicyDocument () const
 
bool AssumeRolePolicyDocumentHasBeenSet () const
 
void SetAssumeRolePolicyDocument (const Aws::String &value)
 
void SetAssumeRolePolicyDocument (Aws::String &&value)
 
void SetAssumeRolePolicyDocument (const char *value)
 
CreateRoleRequestWithAssumeRolePolicyDocument (const Aws::String &value)
 
CreateRoleRequestWithAssumeRolePolicyDocument (Aws::String &&value)
 
CreateRoleRequestWithAssumeRolePolicyDocument (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)
 
CreateRoleRequestWithDescription (const Aws::String &value)
 
CreateRoleRequestWithDescription (Aws::String &&value)
 
CreateRoleRequestWithDescription (const char *value)
 
int GetMaxSessionDuration () const
 
bool MaxSessionDurationHasBeenSet () const
 
void SetMaxSessionDuration (int value)
 
CreateRoleRequestWithMaxSessionDuration (int value)
 
const Aws::StringGetPermissionsBoundary () const
 
bool PermissionsBoundaryHasBeenSet () const
 
void SetPermissionsBoundary (const Aws::String &value)
 
void SetPermissionsBoundary (Aws::String &&value)
 
void SetPermissionsBoundary (const char *value)
 
CreateRoleRequestWithPermissionsBoundary (const Aws::String &value)
 
CreateRoleRequestWithPermissionsBoundary (Aws::String &&value)
 
CreateRoleRequestWithPermissionsBoundary (const char *value)
 
const Aws::Vector< Tag > & GetTags () const
 
bool TagsHasBeenSet () const
 
void SetTags (const Aws::Vector< Tag > &value)
 
void SetTags (Aws::Vector< Tag > &&value)
 
CreateRoleRequestWithTags (const Aws::Vector< Tag > &value)
 
CreateRoleRequestWithTags (Aws::Vector< Tag > &&value)
 
CreateRoleRequestAddTags (const Tag &value)
 
CreateRoleRequestAddTags (Tag &&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 23 of file CreateRoleRequest.h.

Constructor & Destructor Documentation

◆ CreateRoleRequest()

Aws::IAM::Model::CreateRoleRequest::CreateRoleRequest ( )

Member Function Documentation

◆ AddTags() [1/2]

CreateRoleRequest& Aws::IAM::Model::CreateRoleRequest::AddTags ( const Tag value)
inline

A list of tags that you want to attach to the newly created role. Each tag consists of a key name and an associated value. For more information about tagging, see Tagging IAM Identities in the IAM User Guide.

If any one of the tags is invalid or if you exceed the allowed number of tags per role, then the entire request fails and the role is not created.

Definition at line 606 of file CreateRoleRequest.h.

◆ AddTags() [2/2]

CreateRoleRequest& Aws::IAM::Model::CreateRoleRequest::AddTags ( Tag &&  value)
inline

A list of tags that you want to attach to the newly created role. Each tag consists of a key name and an associated value. For more information about tagging, see Tagging IAM Identities in the IAM User Guide.

If any one of the tags is invalid or if you exceed the allowed number of tags per role, then the entire request fails and the role is not created.

Definition at line 617 of file CreateRoleRequest.h.

◆ AssumeRolePolicyDocumentHasBeenSet()

bool Aws::IAM::Model::CreateRoleRequest::AssumeRolePolicyDocumentHasBeenSet ( ) const
inline

The trust relationship policy document that grants an entity permission to assume the role.

In IAM, you must provide a JSON policy that has been converted to a string. However, for AWS CloudFormation templates formatted in YAML, you can provide the policy in JSON or YAML format. AWS CloudFormation always converts a YAML policy to JSON format before submitting it to IAM.

The regex pattern used to validate this parameter is a string of characters consisting of the following:

  • Any printable ASCII character ranging from the space character () through the end of the ASCII character range

  • The printable characters in the Basic Latin and Latin-1 Supplement character set (through )

  • The special characters tab (), line feed (), and carriage return ()

Upon success, the response includes the same trust policy in JSON format.

Definition at line 253 of file CreateRoleRequest.h.

◆ DescriptionHasBeenSet()

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

A description of the role.

Definition at line 372 of file CreateRoleRequest.h.

◆ DumpBodyToUrl()

void Aws::IAM::Model::CreateRoleRequest::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.

◆ GetAssumeRolePolicyDocument()

const Aws::String& Aws::IAM::Model::CreateRoleRequest::GetAssumeRolePolicyDocument ( ) const
inline

The trust relationship policy document that grants an entity permission to assume the role.

In IAM, you must provide a JSON policy that has been converted to a string. However, for AWS CloudFormation templates formatted in YAML, you can provide the policy in JSON or YAML format. AWS CloudFormation always converts a YAML policy to JSON format before submitting it to IAM.

The regex pattern used to validate this parameter is a string of characters consisting of the following:

  • Any printable ASCII character ranging from the space character () through the end of the ASCII character range

  • The printable characters in the Basic Latin and Latin-1 Supplement character set (through )

  • The special characters tab (), line feed (), and carriage return ()

Upon success, the response includes the same trust policy in JSON format.

Definition at line 235 of file CreateRoleRequest.h.

◆ GetDescription()

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

A description of the role.

Definition at line 367 of file CreateRoleRequest.h.

◆ GetMaxSessionDuration()

int Aws::IAM::Model::CreateRoleRequest::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 422 of file CreateRoleRequest.h.

◆ GetPath()

const Aws::String& Aws::IAM::Model::CreateRoleRequest::GetPath ( ) const
inline

The path to the role. For more information about paths, see IAM Identifiers in the IAM User Guide.

This parameter is optional. If it is not included, it defaults to a slash (/).

This parameter allows (through its regex pattern) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! () through the DEL character (), including most punctuation characters, digits, and upper and lowercased letters.

Definition at line 53 of file CreateRoleRequest.h.

◆ GetPermissionsBoundary()

const Aws::String& Aws::IAM::Model::CreateRoleRequest::GetPermissionsBoundary ( ) const
inline

The ARN of the policy that is used to set the permissions boundary for the role.

Definition at line 486 of file CreateRoleRequest.h.

◆ GetRoleName()

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

The name of the role to create.

IAM user, group, role, and policy names must be unique within the account. Names are not distinguished by case. For example, you cannot create resources named both "MyResource" and "myresource".

Definition at line 160 of file CreateRoleRequest.h.

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 32 of file CreateRoleRequest.h.

◆ GetTags()

const Aws::Vector<Tag>& Aws::IAM::Model::CreateRoleRequest::GetTags ( ) const
inline

A list of tags that you want to attach to the newly created role. Each tag consists of a key name and an associated value. For more information about tagging, see Tagging IAM Identities in the IAM User Guide.

If any one of the tags is invalid or if you exceed the allowed number of tags per role, then the entire request fails and the role is not created.

Definition at line 540 of file CreateRoleRequest.h.

◆ MaxSessionDurationHasBeenSet()

bool Aws::IAM::Model::CreateRoleRequest::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 441 of file CreateRoleRequest.h.

◆ PathHasBeenSet()

bool Aws::IAM::Model::CreateRoleRequest::PathHasBeenSet ( ) const
inline

The path to the role. For more information about paths, see IAM Identifiers in the IAM User Guide.

This parameter is optional. If it is not included, it defaults to a slash (/).

This parameter allows (through its regex pattern) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! () through the DEL character (), including most punctuation characters, digits, and upper and lowercased letters.

Definition at line 67 of file CreateRoleRequest.h.

◆ PermissionsBoundaryHasBeenSet()

bool Aws::IAM::Model::CreateRoleRequest::PermissionsBoundaryHasBeenSet ( ) const
inline

The ARN of the policy that is used to set the permissions boundary for the role.

Definition at line 492 of file CreateRoleRequest.h.

◆ RoleNameHasBeenSet()

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

The name of the role to create.

IAM user, group, role, and policy names must be unique within the account. Names are not distinguished by case. For example, you cannot create resources named both "MyResource" and "myresource".

Definition at line 168 of file CreateRoleRequest.h.

◆ SerializePayload()

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

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetAssumeRolePolicyDocument() [1/3]

void Aws::IAM::Model::CreateRoleRequest::SetAssumeRolePolicyDocument ( const Aws::String value)
inline

The trust relationship policy document that grants an entity permission to assume the role.

In IAM, you must provide a JSON policy that has been converted to a string. However, for AWS CloudFormation templates formatted in YAML, you can provide the policy in JSON or YAML format. AWS CloudFormation always converts a YAML policy to JSON format before submitting it to IAM.

The regex pattern used to validate this parameter is a string of characters consisting of the following:

  • Any printable ASCII character ranging from the space character () through the end of the ASCII character range

  • The printable characters in the Basic Latin and Latin-1 Supplement character set (through )

  • The special characters tab (), line feed (), and carriage return ()

Upon success, the response includes the same trust policy in JSON format.

Definition at line 271 of file CreateRoleRequest.h.

◆ SetAssumeRolePolicyDocument() [2/3]

void Aws::IAM::Model::CreateRoleRequest::SetAssumeRolePolicyDocument ( Aws::String &&  value)
inline

The trust relationship policy document that grants an entity permission to assume the role.

In IAM, you must provide a JSON policy that has been converted to a string. However, for AWS CloudFormation templates formatted in YAML, you can provide the policy in JSON or YAML format. AWS CloudFormation always converts a YAML policy to JSON format before submitting it to IAM.

The regex pattern used to validate this parameter is a string of characters consisting of the following:

  • Any printable ASCII character ranging from the space character () through the end of the ASCII character range

  • The printable characters in the Basic Latin and Latin-1 Supplement character set (through )

  • The special characters tab (), line feed (), and carriage return ()

Upon success, the response includes the same trust policy in JSON format.

Definition at line 289 of file CreateRoleRequest.h.

◆ SetAssumeRolePolicyDocument() [3/3]

void Aws::IAM::Model::CreateRoleRequest::SetAssumeRolePolicyDocument ( const char *  value)
inline

The trust relationship policy document that grants an entity permission to assume the role.

In IAM, you must provide a JSON policy that has been converted to a string. However, for AWS CloudFormation templates formatted in YAML, you can provide the policy in JSON or YAML format. AWS CloudFormation always converts a YAML policy to JSON format before submitting it to IAM.

The regex pattern used to validate this parameter is a string of characters consisting of the following:

  • Any printable ASCII character ranging from the space character () through the end of the ASCII character range

  • The printable characters in the Basic Latin and Latin-1 Supplement character set (through )

  • The special characters tab (), line feed (), and carriage return ()

Upon success, the response includes the same trust policy in JSON format.

Definition at line 307 of file CreateRoleRequest.h.

◆ SetDescription() [1/3]

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

A description of the role.

Definition at line 377 of file CreateRoleRequest.h.

◆ SetDescription() [2/3]

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

A description of the role.

Definition at line 382 of file CreateRoleRequest.h.

◆ SetDescription() [3/3]

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

A description of the role.

Definition at line 387 of file CreateRoleRequest.h.

◆ SetMaxSessionDuration()

void Aws::IAM::Model::CreateRoleRequest::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 460 of file CreateRoleRequest.h.

◆ SetPath() [1/3]

void Aws::IAM::Model::CreateRoleRequest::SetPath ( const Aws::String value)
inline

The path to the role. For more information about paths, see IAM Identifiers in the IAM User Guide.

This parameter is optional. If it is not included, it defaults to a slash (/).

This parameter allows (through its regex pattern) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! () through the DEL character (), including most punctuation characters, digits, and upper and lowercased letters.

Definition at line 81 of file CreateRoleRequest.h.

◆ SetPath() [2/3]

void Aws::IAM::Model::CreateRoleRequest::SetPath ( Aws::String &&  value)
inline

The path to the role. For more information about paths, see IAM Identifiers in the IAM User Guide.

This parameter is optional. If it is not included, it defaults to a slash (/).

This parameter allows (through its regex pattern) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! () through the DEL character (), including most punctuation characters, digits, and upper and lowercased letters.

Definition at line 95 of file CreateRoleRequest.h.

◆ SetPath() [3/3]

void Aws::IAM::Model::CreateRoleRequest::SetPath ( const char *  value)
inline

The path to the role. For more information about paths, see IAM Identifiers in the IAM User Guide.

This parameter is optional. If it is not included, it defaults to a slash (/).

This parameter allows (through its regex pattern) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! () through the DEL character (), including most punctuation characters, digits, and upper and lowercased letters.

Definition at line 109 of file CreateRoleRequest.h.

◆ SetPermissionsBoundary() [1/3]

void Aws::IAM::Model::CreateRoleRequest::SetPermissionsBoundary ( const Aws::String value)
inline

The ARN of the policy that is used to set the permissions boundary for the role.

Definition at line 498 of file CreateRoleRequest.h.

◆ SetPermissionsBoundary() [2/3]

void Aws::IAM::Model::CreateRoleRequest::SetPermissionsBoundary ( Aws::String &&  value)
inline

The ARN of the policy that is used to set the permissions boundary for the role.

Definition at line 504 of file CreateRoleRequest.h.

◆ SetPermissionsBoundary() [3/3]

void Aws::IAM::Model::CreateRoleRequest::SetPermissionsBoundary ( const char *  value)
inline

The ARN of the policy that is used to set the permissions boundary for the role.

Definition at line 510 of file CreateRoleRequest.h.

◆ SetRoleName() [1/3]

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

The name of the role to create.

IAM user, group, role, and policy names must be unique within the account. Names are not distinguished by case. For example, you cannot create resources named both "MyResource" and "myresource".

Definition at line 176 of file CreateRoleRequest.h.

◆ SetRoleName() [2/3]

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

The name of the role to create.

IAM user, group, role, and policy names must be unique within the account. Names are not distinguished by case. For example, you cannot create resources named both "MyResource" and "myresource".

Definition at line 184 of file CreateRoleRequest.h.

◆ SetRoleName() [3/3]

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

The name of the role to create.

IAM user, group, role, and policy names must be unique within the account. Names are not distinguished by case. For example, you cannot create resources named both "MyResource" and "myresource".

Definition at line 192 of file CreateRoleRequest.h.

◆ SetTags() [1/2]

void Aws::IAM::Model::CreateRoleRequest::SetTags ( const Aws::Vector< Tag > &  value)
inline

A list of tags that you want to attach to the newly created role. Each tag consists of a key name and an associated value. For more information about tagging, see Tagging IAM Identities in the IAM User Guide.

If any one of the tags is invalid or if you exceed the allowed number of tags per role, then the entire request fails and the role is not created.

Definition at line 562 of file CreateRoleRequest.h.

◆ SetTags() [2/2]

void Aws::IAM::Model::CreateRoleRequest::SetTags ( Aws::Vector< Tag > &&  value)
inline

A list of tags that you want to attach to the newly created role. Each tag consists of a key name and an associated value. For more information about tagging, see Tagging IAM Identities in the IAM User Guide.

If any one of the tags is invalid or if you exceed the allowed number of tags per role, then the entire request fails and the role is not created.

Definition at line 573 of file CreateRoleRequest.h.

◆ TagsHasBeenSet()

bool Aws::IAM::Model::CreateRoleRequest::TagsHasBeenSet ( ) const
inline

A list of tags that you want to attach to the newly created role. Each tag consists of a key name and an associated value. For more information about tagging, see Tagging IAM Identities in the IAM User Guide.

If any one of the tags is invalid or if you exceed the allowed number of tags per role, then the entire request fails and the role is not created.

Definition at line 551 of file CreateRoleRequest.h.

◆ WithAssumeRolePolicyDocument() [1/3]

CreateRoleRequest& Aws::IAM::Model::CreateRoleRequest::WithAssumeRolePolicyDocument ( const Aws::String value)
inline

The trust relationship policy document that grants an entity permission to assume the role.

In IAM, you must provide a JSON policy that has been converted to a string. However, for AWS CloudFormation templates formatted in YAML, you can provide the policy in JSON or YAML format. AWS CloudFormation always converts a YAML policy to JSON format before submitting it to IAM.

The regex pattern used to validate this parameter is a string of characters consisting of the following:

  • Any printable ASCII character ranging from the space character () through the end of the ASCII character range

  • The printable characters in the Basic Latin and Latin-1 Supplement character set (through )

  • The special characters tab (), line feed (), and carriage return ()

Upon success, the response includes the same trust policy in JSON format.

Definition at line 325 of file CreateRoleRequest.h.

◆ WithAssumeRolePolicyDocument() [2/3]

CreateRoleRequest& Aws::IAM::Model::CreateRoleRequest::WithAssumeRolePolicyDocument ( Aws::String &&  value)
inline

The trust relationship policy document that grants an entity permission to assume the role.

In IAM, you must provide a JSON policy that has been converted to a string. However, for AWS CloudFormation templates formatted in YAML, you can provide the policy in JSON or YAML format. AWS CloudFormation always converts a YAML policy to JSON format before submitting it to IAM.

The regex pattern used to validate this parameter is a string of characters consisting of the following:

  • Any printable ASCII character ranging from the space character () through the end of the ASCII character range

  • The printable characters in the Basic Latin and Latin-1 Supplement character set (through )

  • The special characters tab (), line feed (), and carriage return ()

Upon success, the response includes the same trust policy in JSON format.

Definition at line 343 of file CreateRoleRequest.h.

◆ WithAssumeRolePolicyDocument() [3/3]

CreateRoleRequest& Aws::IAM::Model::CreateRoleRequest::WithAssumeRolePolicyDocument ( const char *  value)
inline

The trust relationship policy document that grants an entity permission to assume the role.

In IAM, you must provide a JSON policy that has been converted to a string. However, for AWS CloudFormation templates formatted in YAML, you can provide the policy in JSON or YAML format. AWS CloudFormation always converts a YAML policy to JSON format before submitting it to IAM.

The regex pattern used to validate this parameter is a string of characters consisting of the following:

  • Any printable ASCII character ranging from the space character () through the end of the ASCII character range

  • The printable characters in the Basic Latin and Latin-1 Supplement character set (through )

  • The special characters tab (), line feed (), and carriage return ()

Upon success, the response includes the same trust policy in JSON format.

Definition at line 361 of file CreateRoleRequest.h.

◆ WithDescription() [1/3]

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

A description of the role.

Definition at line 392 of file CreateRoleRequest.h.

◆ WithDescription() [2/3]

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

A description of the role.

Definition at line 397 of file CreateRoleRequest.h.

◆ WithDescription() [3/3]

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

A description of the role.

Definition at line 402 of file CreateRoleRequest.h.

◆ WithMaxSessionDuration()

CreateRoleRequest& Aws::IAM::Model::CreateRoleRequest::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 479 of file CreateRoleRequest.h.

◆ WithPath() [1/3]

CreateRoleRequest& Aws::IAM::Model::CreateRoleRequest::WithPath ( const Aws::String value)
inline

The path to the role. For more information about paths, see IAM Identifiers in the IAM User Guide.

This parameter is optional. If it is not included, it defaults to a slash (/).

This parameter allows (through its regex pattern) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! () through the DEL character (), including most punctuation characters, digits, and upper and lowercased letters.

Definition at line 123 of file CreateRoleRequest.h.

◆ WithPath() [2/3]

CreateRoleRequest& Aws::IAM::Model::CreateRoleRequest::WithPath ( Aws::String &&  value)
inline

The path to the role. For more information about paths, see IAM Identifiers in the IAM User Guide.

This parameter is optional. If it is not included, it defaults to a slash (/).

This parameter allows (through its regex pattern) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! () through the DEL character (), including most punctuation characters, digits, and upper and lowercased letters.

Definition at line 137 of file CreateRoleRequest.h.

◆ WithPath() [3/3]

CreateRoleRequest& Aws::IAM::Model::CreateRoleRequest::WithPath ( const char *  value)
inline

The path to the role. For more information about paths, see IAM Identifiers in the IAM User Guide.

This parameter is optional. If it is not included, it defaults to a slash (/).

This parameter allows (through its regex pattern) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! () through the DEL character (), including most punctuation characters, digits, and upper and lowercased letters.

Definition at line 151 of file CreateRoleRequest.h.

◆ WithPermissionsBoundary() [1/3]

CreateRoleRequest& Aws::IAM::Model::CreateRoleRequest::WithPermissionsBoundary ( const Aws::String value)
inline

The ARN of the policy that is used to set the permissions boundary for the role.

Definition at line 516 of file CreateRoleRequest.h.

◆ WithPermissionsBoundary() [2/3]

CreateRoleRequest& Aws::IAM::Model::CreateRoleRequest::WithPermissionsBoundary ( Aws::String &&  value)
inline

The ARN of the policy that is used to set the permissions boundary for the role.

Definition at line 522 of file CreateRoleRequest.h.

◆ WithPermissionsBoundary() [3/3]

CreateRoleRequest& Aws::IAM::Model::CreateRoleRequest::WithPermissionsBoundary ( const char *  value)
inline

The ARN of the policy that is used to set the permissions boundary for the role.

Definition at line 528 of file CreateRoleRequest.h.

◆ WithRoleName() [1/3]

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

The name of the role to create.

IAM user, group, role, and policy names must be unique within the account. Names are not distinguished by case. For example, you cannot create resources named both "MyResource" and "myresource".

Definition at line 200 of file CreateRoleRequest.h.

◆ WithRoleName() [2/3]

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

The name of the role to create.

IAM user, group, role, and policy names must be unique within the account. Names are not distinguished by case. For example, you cannot create resources named both "MyResource" and "myresource".

Definition at line 208 of file CreateRoleRequest.h.

◆ WithRoleName() [3/3]

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

The name of the role to create.

IAM user, group, role, and policy names must be unique within the account. Names are not distinguished by case. For example, you cannot create resources named both "MyResource" and "myresource".

Definition at line 216 of file CreateRoleRequest.h.

◆ WithTags() [1/2]

CreateRoleRequest& Aws::IAM::Model::CreateRoleRequest::WithTags ( const Aws::Vector< Tag > &  value)
inline

A list of tags that you want to attach to the newly created role. Each tag consists of a key name and an associated value. For more information about tagging, see Tagging IAM Identities in the IAM User Guide.

If any one of the tags is invalid or if you exceed the allowed number of tags per role, then the entire request fails and the role is not created.

Definition at line 584 of file CreateRoleRequest.h.

◆ WithTags() [2/2]

CreateRoleRequest& Aws::IAM::Model::CreateRoleRequest::WithTags ( Aws::Vector< Tag > &&  value)
inline

A list of tags that you want to attach to the newly created role. Each tag consists of a key name and an associated value. For more information about tagging, see Tagging IAM Identities in the IAM User Guide.

If any one of the tags is invalid or if you exceed the allowed number of tags per role, then the entire request fails and the role is not created.

Definition at line 595 of file CreateRoleRequest.h.


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