AWS SDK for C++  1.9.16
AWS SDK for C++
Public Member Functions | List of all members
Aws::CognitoIdentityProvider::Model::CreateGroupRequest Class Reference

#include <CreateGroupRequest.h>

+ Inheritance diagram for Aws::CognitoIdentityProvider::Model::CreateGroupRequest:

Public Member Functions

 CreateGroupRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const override
 
const Aws::StringGetGroupName () const
 
bool GroupNameHasBeenSet () const
 
void SetGroupName (const Aws::String &value)
 
void SetGroupName (Aws::String &&value)
 
void SetGroupName (const char *value)
 
CreateGroupRequestWithGroupName (const Aws::String &value)
 
CreateGroupRequestWithGroupName (Aws::String &&value)
 
CreateGroupRequestWithGroupName (const char *value)
 
const Aws::StringGetUserPoolId () const
 
bool UserPoolIdHasBeenSet () const
 
void SetUserPoolId (const Aws::String &value)
 
void SetUserPoolId (Aws::String &&value)
 
void SetUserPoolId (const char *value)
 
CreateGroupRequestWithUserPoolId (const Aws::String &value)
 
CreateGroupRequestWithUserPoolId (Aws::String &&value)
 
CreateGroupRequestWithUserPoolId (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)
 
CreateGroupRequestWithDescription (const Aws::String &value)
 
CreateGroupRequestWithDescription (Aws::String &&value)
 
CreateGroupRequestWithDescription (const char *value)
 
const Aws::StringGetRoleArn () const
 
bool RoleArnHasBeenSet () const
 
void SetRoleArn (const Aws::String &value)
 
void SetRoleArn (Aws::String &&value)
 
void SetRoleArn (const char *value)
 
CreateGroupRequestWithRoleArn (const Aws::String &value)
 
CreateGroupRequestWithRoleArn (Aws::String &&value)
 
CreateGroupRequestWithRoleArn (const char *value)
 
int GetPrecedence () const
 
bool PrecedenceHasBeenSet () const
 
void SetPrecedence (int value)
 
CreateGroupRequestWithPrecedence (int value)
 
- Public Member Functions inherited from Aws::CognitoIdentityProvider::CognitoIdentityProviderRequest
virtual ~CognitoIdentityProviderRequest ()
 
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
 

Additional Inherited Members

- Protected Member Functions inherited from Aws::AmazonWebServiceRequest
virtual void DumpBodyToUrl (Aws::Http::URI &uri) const
 

Detailed Description

Definition at line 21 of file CreateGroupRequest.h.

Constructor & Destructor Documentation

◆ CreateGroupRequest()

Aws::CognitoIdentityProvider::Model::CreateGroupRequest::CreateGroupRequest ( )

Member Function Documentation

◆ DescriptionHasBeenSet()

bool Aws::CognitoIdentityProvider::Model::CreateGroupRequest::DescriptionHasBeenSet ( ) const
inline

A string containing the description of the group.

Definition at line 127 of file CreateGroupRequest.h.

◆ GetDescription()

const Aws::String& Aws::CognitoIdentityProvider::Model::CreateGroupRequest::GetDescription ( ) const
inline

A string containing the description of the group.

Definition at line 122 of file CreateGroupRequest.h.

◆ GetGroupName()

const Aws::String& Aws::CognitoIdentityProvider::Model::CreateGroupRequest::GetGroupName ( ) const
inline

The name of the group. Must be unique.

Definition at line 40 of file CreateGroupRequest.h.

◆ GetPrecedence()

int Aws::CognitoIdentityProvider::Model::CreateGroupRequest::GetPrecedence ( ) const
inline

A nonnegative integer value that specifies the precedence of this group relative to the other groups that a user can belong to in the user pool. Zero is the highest precedence value. Groups with lower Precedence values take precedence over groups with higher or null Precedence values. If a user belongs to two or more groups, it is the group with the lowest precedence value whose role ARN will be used in the cognito:roles and cognito:preferred_role claims in the user's tokens.

Two groups can have the same Precedence value. If this happens, neither group takes precedence over the other. If two groups with the same Precedence have the same role ARN, that role is used in the cognito:preferred_role claim in tokens for users in each group. If the two groups have different role ARNs, the cognito:preferred_role claim is not set in users' tokens.

The default Precedence value is null.

Definition at line 217 of file CreateGroupRequest.h.

◆ GetRequestSpecificHeaders()

Aws::Http::HeaderValueCollection Aws::CognitoIdentityProvider::Model::CreateGroupRequest::GetRequestSpecificHeaders ( ) const
overridevirtual

◆ GetRoleArn()

const Aws::String& Aws::CognitoIdentityProvider::Model::CreateGroupRequest::GetRoleArn ( ) const
inline

The role ARN for the group.

Definition at line 163 of file CreateGroupRequest.h.

◆ GetServiceRequestName()

virtual const char* Aws::CognitoIdentityProvider::Model::CreateGroupRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 30 of file CreateGroupRequest.h.

◆ GetUserPoolId()

const Aws::String& Aws::CognitoIdentityProvider::Model::CreateGroupRequest::GetUserPoolId ( ) const
inline

The user pool ID for the user pool.

Definition at line 81 of file CreateGroupRequest.h.

◆ GroupNameHasBeenSet()

bool Aws::CognitoIdentityProvider::Model::CreateGroupRequest::GroupNameHasBeenSet ( ) const
inline

The name of the group. Must be unique.

Definition at line 45 of file CreateGroupRequest.h.

◆ PrecedenceHasBeenSet()

bool Aws::CognitoIdentityProvider::Model::CreateGroupRequest::PrecedenceHasBeenSet ( ) const
inline

A nonnegative integer value that specifies the precedence of this group relative to the other groups that a user can belong to in the user pool. Zero is the highest precedence value. Groups with lower Precedence values take precedence over groups with higher or null Precedence values. If a user belongs to two or more groups, it is the group with the lowest precedence value whose role ARN will be used in the cognito:roles and cognito:preferred_role claims in the user's tokens.

Two groups can have the same Precedence value. If this happens, neither group takes precedence over the other. If two groups with the same Precedence have the same role ARN, that role is used in the cognito:preferred_role claim in tokens for users in each group. If the two groups have different role ARNs, the cognito:preferred_role claim is not set in users' tokens.

The default Precedence value is null.

Definition at line 235 of file CreateGroupRequest.h.

◆ RoleArnHasBeenSet()

bool Aws::CognitoIdentityProvider::Model::CreateGroupRequest::RoleArnHasBeenSet ( ) const
inline

The role ARN for the group.

Definition at line 168 of file CreateGroupRequest.h.

◆ SerializePayload()

Aws::String Aws::CognitoIdentityProvider::Model::CreateGroupRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetDescription() [1/3]

void Aws::CognitoIdentityProvider::Model::CreateGroupRequest::SetDescription ( Aws::String &&  value)
inline

A string containing the description of the group.

Definition at line 137 of file CreateGroupRequest.h.

◆ SetDescription() [2/3]

void Aws::CognitoIdentityProvider::Model::CreateGroupRequest::SetDescription ( const Aws::String value)
inline

A string containing the description of the group.

Definition at line 132 of file CreateGroupRequest.h.

◆ SetDescription() [3/3]

void Aws::CognitoIdentityProvider::Model::CreateGroupRequest::SetDescription ( const char *  value)
inline

A string containing the description of the group.

Definition at line 142 of file CreateGroupRequest.h.

◆ SetGroupName() [1/3]

void Aws::CognitoIdentityProvider::Model::CreateGroupRequest::SetGroupName ( Aws::String &&  value)
inline

The name of the group. Must be unique.

Definition at line 55 of file CreateGroupRequest.h.

◆ SetGroupName() [2/3]

void Aws::CognitoIdentityProvider::Model::CreateGroupRequest::SetGroupName ( const Aws::String value)
inline

The name of the group. Must be unique.

Definition at line 50 of file CreateGroupRequest.h.

◆ SetGroupName() [3/3]

void Aws::CognitoIdentityProvider::Model::CreateGroupRequest::SetGroupName ( const char *  value)
inline

The name of the group. Must be unique.

Definition at line 60 of file CreateGroupRequest.h.

◆ SetPrecedence()

void Aws::CognitoIdentityProvider::Model::CreateGroupRequest::SetPrecedence ( int  value)
inline

A nonnegative integer value that specifies the precedence of this group relative to the other groups that a user can belong to in the user pool. Zero is the highest precedence value. Groups with lower Precedence values take precedence over groups with higher or null Precedence values. If a user belongs to two or more groups, it is the group with the lowest precedence value whose role ARN will be used in the cognito:roles and cognito:preferred_role claims in the user's tokens.

Two groups can have the same Precedence value. If this happens, neither group takes precedence over the other. If two groups with the same Precedence have the same role ARN, that role is used in the cognito:preferred_role claim in tokens for users in each group. If the two groups have different role ARNs, the cognito:preferred_role claim is not set in users' tokens.

The default Precedence value is null.

Definition at line 253 of file CreateGroupRequest.h.

◆ SetRoleArn() [1/3]

void Aws::CognitoIdentityProvider::Model::CreateGroupRequest::SetRoleArn ( Aws::String &&  value)
inline

The role ARN for the group.

Definition at line 178 of file CreateGroupRequest.h.

◆ SetRoleArn() [2/3]

void Aws::CognitoIdentityProvider::Model::CreateGroupRequest::SetRoleArn ( const Aws::String value)
inline

The role ARN for the group.

Definition at line 173 of file CreateGroupRequest.h.

◆ SetRoleArn() [3/3]

void Aws::CognitoIdentityProvider::Model::CreateGroupRequest::SetRoleArn ( const char *  value)
inline

The role ARN for the group.

Definition at line 183 of file CreateGroupRequest.h.

◆ SetUserPoolId() [1/3]

void Aws::CognitoIdentityProvider::Model::CreateGroupRequest::SetUserPoolId ( Aws::String &&  value)
inline

The user pool ID for the user pool.

Definition at line 96 of file CreateGroupRequest.h.

◆ SetUserPoolId() [2/3]

void Aws::CognitoIdentityProvider::Model::CreateGroupRequest::SetUserPoolId ( const Aws::String value)
inline

The user pool ID for the user pool.

Definition at line 91 of file CreateGroupRequest.h.

◆ SetUserPoolId() [3/3]

void Aws::CognitoIdentityProvider::Model::CreateGroupRequest::SetUserPoolId ( const char *  value)
inline

The user pool ID for the user pool.

Definition at line 101 of file CreateGroupRequest.h.

◆ UserPoolIdHasBeenSet()

bool Aws::CognitoIdentityProvider::Model::CreateGroupRequest::UserPoolIdHasBeenSet ( ) const
inline

The user pool ID for the user pool.

Definition at line 86 of file CreateGroupRequest.h.

◆ WithDescription() [1/3]

CreateGroupRequest& Aws::CognitoIdentityProvider::Model::CreateGroupRequest::WithDescription ( Aws::String &&  value)
inline

A string containing the description of the group.

Definition at line 152 of file CreateGroupRequest.h.

◆ WithDescription() [2/3]

CreateGroupRequest& Aws::CognitoIdentityProvider::Model::CreateGroupRequest::WithDescription ( const Aws::String value)
inline

A string containing the description of the group.

Definition at line 147 of file CreateGroupRequest.h.

◆ WithDescription() [3/3]

CreateGroupRequest& Aws::CognitoIdentityProvider::Model::CreateGroupRequest::WithDescription ( const char *  value)
inline

A string containing the description of the group.

Definition at line 157 of file CreateGroupRequest.h.

◆ WithGroupName() [1/3]

CreateGroupRequest& Aws::CognitoIdentityProvider::Model::CreateGroupRequest::WithGroupName ( Aws::String &&  value)
inline

The name of the group. Must be unique.

Definition at line 70 of file CreateGroupRequest.h.

◆ WithGroupName() [2/3]

CreateGroupRequest& Aws::CognitoIdentityProvider::Model::CreateGroupRequest::WithGroupName ( const Aws::String value)
inline

The name of the group. Must be unique.

Definition at line 65 of file CreateGroupRequest.h.

◆ WithGroupName() [3/3]

CreateGroupRequest& Aws::CognitoIdentityProvider::Model::CreateGroupRequest::WithGroupName ( const char *  value)
inline

The name of the group. Must be unique.

Definition at line 75 of file CreateGroupRequest.h.

◆ WithPrecedence()

CreateGroupRequest& Aws::CognitoIdentityProvider::Model::CreateGroupRequest::WithPrecedence ( int  value)
inline

A nonnegative integer value that specifies the precedence of this group relative to the other groups that a user can belong to in the user pool. Zero is the highest precedence value. Groups with lower Precedence values take precedence over groups with higher or null Precedence values. If a user belongs to two or more groups, it is the group with the lowest precedence value whose role ARN will be used in the cognito:roles and cognito:preferred_role claims in the user's tokens.

Two groups can have the same Precedence value. If this happens, neither group takes precedence over the other. If two groups with the same Precedence have the same role ARN, that role is used in the cognito:preferred_role claim in tokens for users in each group. If the two groups have different role ARNs, the cognito:preferred_role claim is not set in users' tokens.

The default Precedence value is null.

Definition at line 271 of file CreateGroupRequest.h.

◆ WithRoleArn() [1/3]

CreateGroupRequest& Aws::CognitoIdentityProvider::Model::CreateGroupRequest::WithRoleArn ( Aws::String &&  value)
inline

The role ARN for the group.

Definition at line 193 of file CreateGroupRequest.h.

◆ WithRoleArn() [2/3]

CreateGroupRequest& Aws::CognitoIdentityProvider::Model::CreateGroupRequest::WithRoleArn ( const Aws::String value)
inline

The role ARN for the group.

Definition at line 188 of file CreateGroupRequest.h.

◆ WithRoleArn() [3/3]

CreateGroupRequest& Aws::CognitoIdentityProvider::Model::CreateGroupRequest::WithRoleArn ( const char *  value)
inline

The role ARN for the group.

Definition at line 198 of file CreateGroupRequest.h.

◆ WithUserPoolId() [1/3]

CreateGroupRequest& Aws::CognitoIdentityProvider::Model::CreateGroupRequest::WithUserPoolId ( Aws::String &&  value)
inline

The user pool ID for the user pool.

Definition at line 111 of file CreateGroupRequest.h.

◆ WithUserPoolId() [2/3]

CreateGroupRequest& Aws::CognitoIdentityProvider::Model::CreateGroupRequest::WithUserPoolId ( const Aws::String value)
inline

The user pool ID for the user pool.

Definition at line 106 of file CreateGroupRequest.h.

◆ WithUserPoolId() [3/3]

CreateGroupRequest& Aws::CognitoIdentityProvider::Model::CreateGroupRequest::WithUserPoolId ( const char *  value)
inline

The user pool ID for the user pool.

Definition at line 116 of file CreateGroupRequest.h.


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