AWS SDK for C++  1.8.51
AWS SDK for C++
Public Member Functions | List of all members
Aws::APIGateway::Model::CreateAuthorizerRequest Class Reference

#include <CreateAuthorizerRequest.h>

+ Inheritance diagram for Aws::APIGateway::Model::CreateAuthorizerRequest:

Public Member Functions

 CreateAuthorizerRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
const Aws::StringGetRestApiId () const
 
bool RestApiIdHasBeenSet () const
 
void SetRestApiId (const Aws::String &value)
 
void SetRestApiId (Aws::String &&value)
 
void SetRestApiId (const char *value)
 
CreateAuthorizerRequestWithRestApiId (const Aws::String &value)
 
CreateAuthorizerRequestWithRestApiId (Aws::String &&value)
 
CreateAuthorizerRequestWithRestApiId (const char *value)
 
const Aws::StringGetName () const
 
bool NameHasBeenSet () const
 
void SetName (const Aws::String &value)
 
void SetName (Aws::String &&value)
 
void SetName (const char *value)
 
CreateAuthorizerRequestWithName (const Aws::String &value)
 
CreateAuthorizerRequestWithName (Aws::String &&value)
 
CreateAuthorizerRequestWithName (const char *value)
 
const AuthorizerTypeGetType () const
 
bool TypeHasBeenSet () const
 
void SetType (const AuthorizerType &value)
 
void SetType (AuthorizerType &&value)
 
CreateAuthorizerRequestWithType (const AuthorizerType &value)
 
CreateAuthorizerRequestWithType (AuthorizerType &&value)
 
const Aws::Vector< Aws::String > & GetProviderARNs () const
 
bool ProviderARNsHasBeenSet () const
 
void SetProviderARNs (const Aws::Vector< Aws::String > &value)
 
void SetProviderARNs (Aws::Vector< Aws::String > &&value)
 
CreateAuthorizerRequestWithProviderARNs (const Aws::Vector< Aws::String > &value)
 
CreateAuthorizerRequestWithProviderARNs (Aws::Vector< Aws::String > &&value)
 
CreateAuthorizerRequestAddProviderARNs (const Aws::String &value)
 
CreateAuthorizerRequestAddProviderARNs (Aws::String &&value)
 
CreateAuthorizerRequestAddProviderARNs (const char *value)
 
const Aws::StringGetAuthType () const
 
bool AuthTypeHasBeenSet () const
 
void SetAuthType (const Aws::String &value)
 
void SetAuthType (Aws::String &&value)
 
void SetAuthType (const char *value)
 
CreateAuthorizerRequestWithAuthType (const Aws::String &value)
 
CreateAuthorizerRequestWithAuthType (Aws::String &&value)
 
CreateAuthorizerRequestWithAuthType (const char *value)
 
const Aws::StringGetAuthorizerUri () const
 
bool AuthorizerUriHasBeenSet () const
 
void SetAuthorizerUri (const Aws::String &value)
 
void SetAuthorizerUri (Aws::String &&value)
 
void SetAuthorizerUri (const char *value)
 
CreateAuthorizerRequestWithAuthorizerUri (const Aws::String &value)
 
CreateAuthorizerRequestWithAuthorizerUri (Aws::String &&value)
 
CreateAuthorizerRequestWithAuthorizerUri (const char *value)
 
const Aws::StringGetAuthorizerCredentials () const
 
bool AuthorizerCredentialsHasBeenSet () const
 
void SetAuthorizerCredentials (const Aws::String &value)
 
void SetAuthorizerCredentials (Aws::String &&value)
 
void SetAuthorizerCredentials (const char *value)
 
CreateAuthorizerRequestWithAuthorizerCredentials (const Aws::String &value)
 
CreateAuthorizerRequestWithAuthorizerCredentials (Aws::String &&value)
 
CreateAuthorizerRequestWithAuthorizerCredentials (const char *value)
 
const Aws::StringGetIdentitySource () const
 
bool IdentitySourceHasBeenSet () const
 
void SetIdentitySource (const Aws::String &value)
 
void SetIdentitySource (Aws::String &&value)
 
void SetIdentitySource (const char *value)
 
CreateAuthorizerRequestWithIdentitySource (const Aws::String &value)
 
CreateAuthorizerRequestWithIdentitySource (Aws::String &&value)
 
CreateAuthorizerRequestWithIdentitySource (const char *value)
 
const Aws::StringGetIdentityValidationExpression () const
 
bool IdentityValidationExpressionHasBeenSet () const
 
void SetIdentityValidationExpression (const Aws::String &value)
 
void SetIdentityValidationExpression (Aws::String &&value)
 
void SetIdentityValidationExpression (const char *value)
 
CreateAuthorizerRequestWithIdentityValidationExpression (const Aws::String &value)
 
CreateAuthorizerRequestWithIdentityValidationExpression (Aws::String &&value)
 
CreateAuthorizerRequestWithIdentityValidationExpression (const char *value)
 
int GetAuthorizerResultTtlInSeconds () const
 
bool AuthorizerResultTtlInSecondsHasBeenSet () const
 
void SetAuthorizerResultTtlInSeconds (int value)
 
CreateAuthorizerRequestWithAuthorizerResultTtlInSeconds (int value)
 
- Public Member Functions inherited from Aws::APIGateway::APIGatewayRequest
virtual ~APIGatewayRequest ()
 
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::APIGateway::APIGatewayRequest
virtual Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const
 
- Protected Member Functions inherited from Aws::AmazonWebServiceRequest
virtual void DumpBodyToUrl (Aws::Http::URI &uri) const
 

Detailed Description

Request to add a new Authorizer to an existing RestApi resource.

See Also:

AWS API Reference

Definition at line 27 of file CreateAuthorizerRequest.h.

Constructor & Destructor Documentation

◆ CreateAuthorizerRequest()

Aws::APIGateway::Model::CreateAuthorizerRequest::CreateAuthorizerRequest ( )

Member Function Documentation

◆ AddProviderARNs() [1/3]

CreateAuthorizerRequest& Aws::APIGateway::Model::CreateAuthorizerRequest::AddProviderARNs ( const Aws::String value)
inline

A list of the Amazon Cognito user pool ARNs for the COGNITO_USER_POOLS authorizer. Each element is of this format: arn:aws:cognito-idp:{region}:{account_id}:userpool/{user_pool_id}. For a TOKEN or REQUEST authorizer, this is not defined.

Definition at line 233 of file CreateAuthorizerRequest.h.

◆ AddProviderARNs() [2/3]

CreateAuthorizerRequest& Aws::APIGateway::Model::CreateAuthorizerRequest::AddProviderARNs ( Aws::String &&  value)
inline

A list of the Amazon Cognito user pool ARNs for the COGNITO_USER_POOLS authorizer. Each element is of this format: arn:aws:cognito-idp:{region}:{account_id}:userpool/{user_pool_id}. For a TOKEN or REQUEST authorizer, this is not defined.

Definition at line 242 of file CreateAuthorizerRequest.h.

◆ AddProviderARNs() [3/3]

CreateAuthorizerRequest& Aws::APIGateway::Model::CreateAuthorizerRequest::AddProviderARNs ( const char *  value)
inline

A list of the Amazon Cognito user pool ARNs for the COGNITO_USER_POOLS authorizer. Each element is of this format: arn:aws:cognito-idp:{region}:{account_id}:userpool/{user_pool_id}. For a TOKEN or REQUEST authorizer, this is not defined.

Definition at line 251 of file CreateAuthorizerRequest.h.

◆ AuthorizerCredentialsHasBeenSet()

bool Aws::APIGateway::Model::CreateAuthorizerRequest::AuthorizerCredentialsHasBeenSet ( ) const
inline

Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer. To specify an IAM role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To use resource-based permissions on the Lambda function, specify null.

Definition at line 438 of file CreateAuthorizerRequest.h.

◆ AuthorizerResultTtlInSecondsHasBeenSet()

bool Aws::APIGateway::Model::CreateAuthorizerRequest::AuthorizerResultTtlInSecondsHasBeenSet ( ) const
inline

The TTL in seconds of cached authorizer results. If it equals 0, authorization caching is disabled. If it is greater than 0, API Gateway will cache authorizer responses. If this field is not set, the default value is 300. The maximum value is 3600, or 1 hour.

Definition at line 793 of file CreateAuthorizerRequest.h.

◆ AuthorizerUriHasBeenSet()

bool Aws::APIGateway::Model::CreateAuthorizerRequest::AuthorizerUriHasBeenSet ( ) const
inline

Specifies the authorizer's Uniform Resource Identifier (URI). For TOKEN or REQUEST authorizers, this must be a well-formed Lambda function URI, for example, arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:{account_id}:function:{lambda_function_name}/invocations. In general, the URI has this form arn:aws:apigateway:{region}:lambda:path/{service_api}, where {region} is the same as the region hosting the Lambda function, path indicates that the remaining substring in the URI should be treated as the path to the resource, including the initial /. For Lambda functions, this is usually of the form /2015-03-31/functions/[FunctionARN]/invocations.

Definition at line 331 of file CreateAuthorizerRequest.h.

◆ AuthTypeHasBeenSet()

bool Aws::APIGateway::Model::CreateAuthorizerRequest::AuthTypeHasBeenSet ( ) const
inline

Optional customer-defined field, used in OpenAPI imports and exports without functional impact.

Definition at line 264 of file CreateAuthorizerRequest.h.

◆ GetAuthorizerCredentials()

const Aws::String& Aws::APIGateway::Model::CreateAuthorizerRequest::GetAuthorizerCredentials ( ) const
inline

Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer. To specify an IAM role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To use resource-based permissions on the Lambda function, specify null.

Definition at line 430 of file CreateAuthorizerRequest.h.

◆ GetAuthorizerResultTtlInSeconds()

int Aws::APIGateway::Model::CreateAuthorizerRequest::GetAuthorizerResultTtlInSeconds ( ) const
inline

The TTL in seconds of cached authorizer results. If it equals 0, authorization caching is disabled. If it is greater than 0, API Gateway will cache authorizer responses. If this field is not set, the default value is 300. The maximum value is 3600, or 1 hour.

Definition at line 785 of file CreateAuthorizerRequest.h.

◆ GetAuthorizerUri()

const Aws::String& Aws::APIGateway::Model::CreateAuthorizerRequest::GetAuthorizerUri ( ) const
inline

Specifies the authorizer's Uniform Resource Identifier (URI). For TOKEN or REQUEST authorizers, this must be a well-formed Lambda function URI, for example, arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:{account_id}:function:{lambda_function_name}/invocations. In general, the URI has this form arn:aws:apigateway:{region}:lambda:path/{service_api}, where {region} is the same as the region hosting the Lambda function, path indicates that the remaining substring in the URI should be treated as the path to the resource, including the initial /. For Lambda functions, this is usually of the form /2015-03-31/functions/[FunctionARN]/invocations.

Definition at line 316 of file CreateAuthorizerRequest.h.

◆ GetAuthType()

const Aws::String& Aws::APIGateway::Model::CreateAuthorizerRequest::GetAuthType ( ) const
inline

Optional customer-defined field, used in OpenAPI imports and exports without functional impact.

Definition at line 258 of file CreateAuthorizerRequest.h.

◆ GetIdentitySource()

const Aws::String& Aws::APIGateway::Model::CreateAuthorizerRequest::GetIdentitySource ( ) const
inline

The identity source for which authorization is requested.

  • For a TOKEN or COGNITO_USER_POOLS authorizer, this is required and specifies the request header mapping expression for the custom header holding the authorization token submitted by the client. For example, if the token header name is Auth, the header mapping expression is method.request.header.Auth.
  • For the REQUEST authorizer, this is required when authorization caching is enabled. The value is a comma-separated string of one or more mapping expressions of the specified request parameters. For example, if an Auth header, a Name query string parameter are defined as identity sources, this value is method.request.header.Auth, method.request.querystring.Name. These parameters will be used to derive the authorization caching key and to perform runtime validation of the REQUEST authorizer by verifying all of the identity-related request parameters are present, not null and non-empty. Only when this is true does the authorizer invoke the authorizer Lambda function, otherwise, it returns a 401 Unauthorized response without calling the Lambda function. The valid value is a string of comma-separated mapping expressions of the specified request parameters. When the authorization caching is not enabled, this property is optional.

Definition at line 511 of file CreateAuthorizerRequest.h.

◆ GetIdentityValidationExpression()

const Aws::String& Aws::APIGateway::Model::CreateAuthorizerRequest::GetIdentityValidationExpression ( ) const
inline

A validation expression for the incoming identity token. For TOKEN authorizers, this value is a regular expression. For COGNITO_USER_POOLS authorizers, API Gateway will match the aud field of the incoming token from the client against the specified regular expression. It will invoke the authorizer's Lambda function when there is a match. Otherwise, it will return a 401 Unauthorized response without calling the Lambda function. The validation expression does not apply to the REQUEST authorizer.

Definition at line 692 of file CreateAuthorizerRequest.h.

◆ GetName()

const Aws::String& Aws::APIGateway::Model::CreateAuthorizerRequest::GetName ( ) const
inline

[Required] The name of the authorizer.

Definition at line 85 of file CreateAuthorizerRequest.h.

◆ GetProviderARNs()

const Aws::Vector<Aws::String>& Aws::APIGateway::Model::CreateAuthorizerRequest::GetProviderARNs ( ) const
inline

A list of the Amazon Cognito user pool ARNs for the COGNITO_USER_POOLS authorizer. Each element is of this format: arn:aws:cognito-idp:{region}:{account_id}:userpool/{user_pool_id}. For a TOKEN or REQUEST authorizer, this is not defined.

Definition at line 179 of file CreateAuthorizerRequest.h.

◆ GetRestApiId()

const Aws::String& Aws::APIGateway::Model::CreateAuthorizerRequest::GetRestApiId ( ) const
inline

[Required] The string identifier of the associated RestApi.

Definition at line 44 of file CreateAuthorizerRequest.h.

◆ GetServiceRequestName()

virtual const char* Aws::APIGateway::Model::CreateAuthorizerRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 36 of file CreateAuthorizerRequest.h.

◆ GetType()

const AuthorizerType& Aws::APIGateway::Model::CreateAuthorizerRequest::GetType ( ) const
inline

[Required] The authorizer type. Valid values are TOKEN for a Lambda function using a single authorization token submitted in a custom header, REQUEST for a Lambda function using incoming request parameters, and COGNITO_USER_POOLS for using an Amazon Cognito user pool.

Definition at line 129 of file CreateAuthorizerRequest.h.

◆ IdentitySourceHasBeenSet()

bool Aws::APIGateway::Model::CreateAuthorizerRequest::IdentitySourceHasBeenSet ( ) const
inline

The identity source for which authorization is requested.

  • For a TOKEN or COGNITO_USER_POOLS authorizer, this is required and specifies the request header mapping expression for the custom header holding the authorization token submitted by the client. For example, if the token header name is Auth, the header mapping expression is method.request.header.Auth.
  • For the REQUEST authorizer, this is required when authorization caching is enabled. The value is a comma-separated string of one or more mapping expressions of the specified request parameters. For example, if an Auth header, a Name query string parameter are defined as identity sources, this value is method.request.header.Auth, method.request.querystring.Name. These parameters will be used to derive the authorization caching key and to perform runtime validation of the REQUEST authorizer by verifying all of the identity-related request parameters are present, not null and non-empty. Only when this is true does the authorizer invoke the authorizer Lambda function, otherwise, it returns a 401 Unauthorized response without calling the Lambda function. The valid value is a string of comma-separated mapping expressions of the specified request parameters. When the authorization caching is not enabled, this property is optional.

Definition at line 535 of file CreateAuthorizerRequest.h.

◆ IdentityValidationExpressionHasBeenSet()

bool Aws::APIGateway::Model::CreateAuthorizerRequest::IdentityValidationExpressionHasBeenSet ( ) const
inline

A validation expression for the incoming identity token. For TOKEN authorizers, this value is a regular expression. For COGNITO_USER_POOLS authorizers, API Gateway will match the aud field of the incoming token from the client against the specified regular expression. It will invoke the authorizer's Lambda function when there is a match. Otherwise, it will return a 401 Unauthorized response without calling the Lambda function. The validation expression does not apply to the REQUEST authorizer.

Definition at line 704 of file CreateAuthorizerRequest.h.

◆ NameHasBeenSet()

bool Aws::APIGateway::Model::CreateAuthorizerRequest::NameHasBeenSet ( ) const
inline

[Required] The name of the authorizer.

Definition at line 90 of file CreateAuthorizerRequest.h.

◆ ProviderARNsHasBeenSet()

bool Aws::APIGateway::Model::CreateAuthorizerRequest::ProviderARNsHasBeenSet ( ) const
inline

A list of the Amazon Cognito user pool ARNs for the COGNITO_USER_POOLS authorizer. Each element is of this format: arn:aws:cognito-idp:{region}:{account_id}:userpool/{user_pool_id}. For a TOKEN or REQUEST authorizer, this is not defined.

Definition at line 188 of file CreateAuthorizerRequest.h.

◆ RestApiIdHasBeenSet()

bool Aws::APIGateway::Model::CreateAuthorizerRequest::RestApiIdHasBeenSet ( ) const
inline

[Required] The string identifier of the associated RestApi.

Definition at line 49 of file CreateAuthorizerRequest.h.

◆ SerializePayload()

Aws::String Aws::APIGateway::Model::CreateAuthorizerRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetAuthorizerCredentials() [1/3]

void Aws::APIGateway::Model::CreateAuthorizerRequest::SetAuthorizerCredentials ( const Aws::String value)
inline

Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer. To specify an IAM role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To use resource-based permissions on the Lambda function, specify null.

Definition at line 446 of file CreateAuthorizerRequest.h.

◆ SetAuthorizerCredentials() [2/3]

void Aws::APIGateway::Model::CreateAuthorizerRequest::SetAuthorizerCredentials ( Aws::String &&  value)
inline

Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer. To specify an IAM role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To use resource-based permissions on the Lambda function, specify null.

Definition at line 454 of file CreateAuthorizerRequest.h.

◆ SetAuthorizerCredentials() [3/3]

void Aws::APIGateway::Model::CreateAuthorizerRequest::SetAuthorizerCredentials ( const char *  value)
inline

Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer. To specify an IAM role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To use resource-based permissions on the Lambda function, specify null.

Definition at line 462 of file CreateAuthorizerRequest.h.

◆ SetAuthorizerResultTtlInSeconds()

void Aws::APIGateway::Model::CreateAuthorizerRequest::SetAuthorizerResultTtlInSeconds ( int  value)
inline

The TTL in seconds of cached authorizer results. If it equals 0, authorization caching is disabled. If it is greater than 0, API Gateway will cache authorizer responses. If this field is not set, the default value is 300. The maximum value is 3600, or 1 hour.

Definition at line 801 of file CreateAuthorizerRequest.h.

◆ SetAuthorizerUri() [1/3]

void Aws::APIGateway::Model::CreateAuthorizerRequest::SetAuthorizerUri ( const Aws::String value)
inline

Specifies the authorizer's Uniform Resource Identifier (URI). For TOKEN or REQUEST authorizers, this must be a well-formed Lambda function URI, for example, arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:{account_id}:function:{lambda_function_name}/invocations. In general, the URI has this form arn:aws:apigateway:{region}:lambda:path/{service_api}, where {region} is the same as the region hosting the Lambda function, path indicates that the remaining substring in the URI should be treated as the path to the resource, including the initial /. For Lambda functions, this is usually of the form /2015-03-31/functions/[FunctionARN]/invocations.

Definition at line 346 of file CreateAuthorizerRequest.h.

◆ SetAuthorizerUri() [2/3]

void Aws::APIGateway::Model::CreateAuthorizerRequest::SetAuthorizerUri ( Aws::String &&  value)
inline

Specifies the authorizer's Uniform Resource Identifier (URI). For TOKEN or REQUEST authorizers, this must be a well-formed Lambda function URI, for example, arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:{account_id}:function:{lambda_function_name}/invocations. In general, the URI has this form arn:aws:apigateway:{region}:lambda:path/{service_api}, where {region} is the same as the region hosting the Lambda function, path indicates that the remaining substring in the URI should be treated as the path to the resource, including the initial /. For Lambda functions, this is usually of the form /2015-03-31/functions/[FunctionARN]/invocations.

Definition at line 361 of file CreateAuthorizerRequest.h.

◆ SetAuthorizerUri() [3/3]

void Aws::APIGateway::Model::CreateAuthorizerRequest::SetAuthorizerUri ( const char *  value)
inline

Specifies the authorizer's Uniform Resource Identifier (URI). For TOKEN or REQUEST authorizers, this must be a well-formed Lambda function URI, for example, arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:{account_id}:function:{lambda_function_name}/invocations. In general, the URI has this form arn:aws:apigateway:{region}:lambda:path/{service_api}, where {region} is the same as the region hosting the Lambda function, path indicates that the remaining substring in the URI should be treated as the path to the resource, including the initial /. For Lambda functions, this is usually of the form /2015-03-31/functions/[FunctionARN]/invocations.

Definition at line 376 of file CreateAuthorizerRequest.h.

◆ SetAuthType() [1/3]

void Aws::APIGateway::Model::CreateAuthorizerRequest::SetAuthType ( const Aws::String value)
inline

Optional customer-defined field, used in OpenAPI imports and exports without functional impact.

Definition at line 270 of file CreateAuthorizerRequest.h.

◆ SetAuthType() [2/3]

void Aws::APIGateway::Model::CreateAuthorizerRequest::SetAuthType ( Aws::String &&  value)
inline

Optional customer-defined field, used in OpenAPI imports and exports without functional impact.

Definition at line 276 of file CreateAuthorizerRequest.h.

◆ SetAuthType() [3/3]

void Aws::APIGateway::Model::CreateAuthorizerRequest::SetAuthType ( const char *  value)
inline

Optional customer-defined field, used in OpenAPI imports and exports without functional impact.

Definition at line 282 of file CreateAuthorizerRequest.h.

◆ SetIdentitySource() [1/3]

void Aws::APIGateway::Model::CreateAuthorizerRequest::SetIdentitySource ( const Aws::String value)
inline

The identity source for which authorization is requested.

  • For a TOKEN or COGNITO_USER_POOLS authorizer, this is required and specifies the request header mapping expression for the custom header holding the authorization token submitted by the client. For example, if the token header name is Auth, the header mapping expression is method.request.header.Auth.
  • For the REQUEST authorizer, this is required when authorization caching is enabled. The value is a comma-separated string of one or more mapping expressions of the specified request parameters. For example, if an Auth header, a Name query string parameter are defined as identity sources, this value is method.request.header.Auth, method.request.querystring.Name. These parameters will be used to derive the authorization caching key and to perform runtime validation of the REQUEST authorizer by verifying all of the identity-related request parameters are present, not null and non-empty. Only when this is true does the authorizer invoke the authorizer Lambda function, otherwise, it returns a 401 Unauthorized response without calling the Lambda function. The valid value is a string of comma-separated mapping expressions of the specified request parameters. When the authorization caching is not enabled, this property is optional.

Definition at line 559 of file CreateAuthorizerRequest.h.

◆ SetIdentitySource() [2/3]

void Aws::APIGateway::Model::CreateAuthorizerRequest::SetIdentitySource ( Aws::String &&  value)
inline

The identity source for which authorization is requested.

  • For a TOKEN or COGNITO_USER_POOLS authorizer, this is required and specifies the request header mapping expression for the custom header holding the authorization token submitted by the client. For example, if the token header name is Auth, the header mapping expression is method.request.header.Auth.
  • For the REQUEST authorizer, this is required when authorization caching is enabled. The value is a comma-separated string of one or more mapping expressions of the specified request parameters. For example, if an Auth header, a Name query string parameter are defined as identity sources, this value is method.request.header.Auth, method.request.querystring.Name. These parameters will be used to derive the authorization caching key and to perform runtime validation of the REQUEST authorizer by verifying all of the identity-related request parameters are present, not null and non-empty. Only when this is true does the authorizer invoke the authorizer Lambda function, otherwise, it returns a 401 Unauthorized response without calling the Lambda function. The valid value is a string of comma-separated mapping expressions of the specified request parameters. When the authorization caching is not enabled, this property is optional.

Definition at line 583 of file CreateAuthorizerRequest.h.

◆ SetIdentitySource() [3/3]

void Aws::APIGateway::Model::CreateAuthorizerRequest::SetIdentitySource ( const char *  value)
inline

The identity source for which authorization is requested.

  • For a TOKEN or COGNITO_USER_POOLS authorizer, this is required and specifies the request header mapping expression for the custom header holding the authorization token submitted by the client. For example, if the token header name is Auth, the header mapping expression is method.request.header.Auth.
  • For the REQUEST authorizer, this is required when authorization caching is enabled. The value is a comma-separated string of one or more mapping expressions of the specified request parameters. For example, if an Auth header, a Name query string parameter are defined as identity sources, this value is method.request.header.Auth, method.request.querystring.Name. These parameters will be used to derive the authorization caching key and to perform runtime validation of the REQUEST authorizer by verifying all of the identity-related request parameters are present, not null and non-empty. Only when this is true does the authorizer invoke the authorizer Lambda function, otherwise, it returns a 401 Unauthorized response without calling the Lambda function. The valid value is a string of comma-separated mapping expressions of the specified request parameters. When the authorization caching is not enabled, this property is optional.

Definition at line 607 of file CreateAuthorizerRequest.h.

◆ SetIdentityValidationExpression() [1/3]

void Aws::APIGateway::Model::CreateAuthorizerRequest::SetIdentityValidationExpression ( const Aws::String value)
inline

A validation expression for the incoming identity token. For TOKEN authorizers, this value is a regular expression. For COGNITO_USER_POOLS authorizers, API Gateway will match the aud field of the incoming token from the client against the specified regular expression. It will invoke the authorizer's Lambda function when there is a match. Otherwise, it will return a 401 Unauthorized response without calling the Lambda function. The validation expression does not apply to the REQUEST authorizer.

Definition at line 716 of file CreateAuthorizerRequest.h.

◆ SetIdentityValidationExpression() [2/3]

void Aws::APIGateway::Model::CreateAuthorizerRequest::SetIdentityValidationExpression ( Aws::String &&  value)
inline

A validation expression for the incoming identity token. For TOKEN authorizers, this value is a regular expression. For COGNITO_USER_POOLS authorizers, API Gateway will match the aud field of the incoming token from the client against the specified regular expression. It will invoke the authorizer's Lambda function when there is a match. Otherwise, it will return a 401 Unauthorized response without calling the Lambda function. The validation expression does not apply to the REQUEST authorizer.

Definition at line 728 of file CreateAuthorizerRequest.h.

◆ SetIdentityValidationExpression() [3/3]

void Aws::APIGateway::Model::CreateAuthorizerRequest::SetIdentityValidationExpression ( const char *  value)
inline

A validation expression for the incoming identity token. For TOKEN authorizers, this value is a regular expression. For COGNITO_USER_POOLS authorizers, API Gateway will match the aud field of the incoming token from the client against the specified regular expression. It will invoke the authorizer's Lambda function when there is a match. Otherwise, it will return a 401 Unauthorized response without calling the Lambda function. The validation expression does not apply to the REQUEST authorizer.

Definition at line 740 of file CreateAuthorizerRequest.h.

◆ SetName() [1/3]

void Aws::APIGateway::Model::CreateAuthorizerRequest::SetName ( const Aws::String value)
inline

[Required] The name of the authorizer.

Definition at line 95 of file CreateAuthorizerRequest.h.

◆ SetName() [2/3]

void Aws::APIGateway::Model::CreateAuthorizerRequest::SetName ( Aws::String &&  value)
inline

[Required] The name of the authorizer.

Definition at line 100 of file CreateAuthorizerRequest.h.

◆ SetName() [3/3]

void Aws::APIGateway::Model::CreateAuthorizerRequest::SetName ( const char *  value)
inline

[Required] The name of the authorizer.

Definition at line 105 of file CreateAuthorizerRequest.h.

◆ SetProviderARNs() [1/2]

void Aws::APIGateway::Model::CreateAuthorizerRequest::SetProviderARNs ( const Aws::Vector< Aws::String > &  value)
inline

A list of the Amazon Cognito user pool ARNs for the COGNITO_USER_POOLS authorizer. Each element is of this format: arn:aws:cognito-idp:{region}:{account_id}:userpool/{user_pool_id}. For a TOKEN or REQUEST authorizer, this is not defined.

Definition at line 197 of file CreateAuthorizerRequest.h.

◆ SetProviderARNs() [2/2]

void Aws::APIGateway::Model::CreateAuthorizerRequest::SetProviderARNs ( Aws::Vector< Aws::String > &&  value)
inline

A list of the Amazon Cognito user pool ARNs for the COGNITO_USER_POOLS authorizer. Each element is of this format: arn:aws:cognito-idp:{region}:{account_id}:userpool/{user_pool_id}. For a TOKEN or REQUEST authorizer, this is not defined.

Definition at line 206 of file CreateAuthorizerRequest.h.

◆ SetRestApiId() [1/3]

void Aws::APIGateway::Model::CreateAuthorizerRequest::SetRestApiId ( const Aws::String value)
inline

[Required] The string identifier of the associated RestApi.

Definition at line 54 of file CreateAuthorizerRequest.h.

◆ SetRestApiId() [2/3]

void Aws::APIGateway::Model::CreateAuthorizerRequest::SetRestApiId ( Aws::String &&  value)
inline

[Required] The string identifier of the associated RestApi.

Definition at line 59 of file CreateAuthorizerRequest.h.

◆ SetRestApiId() [3/3]

void Aws::APIGateway::Model::CreateAuthorizerRequest::SetRestApiId ( const char *  value)
inline

[Required] The string identifier of the associated RestApi.

Definition at line 64 of file CreateAuthorizerRequest.h.

◆ SetType() [1/2]

void Aws::APIGateway::Model::CreateAuthorizerRequest::SetType ( const AuthorizerType value)
inline

[Required] The authorizer type. Valid values are TOKEN for a Lambda function using a single authorization token submitted in a custom header, REQUEST for a Lambda function using incoming request parameters, and COGNITO_USER_POOLS for using an Amazon Cognito user pool.

Definition at line 145 of file CreateAuthorizerRequest.h.

◆ SetType() [2/2]

void Aws::APIGateway::Model::CreateAuthorizerRequest::SetType ( AuthorizerType &&  value)
inline

[Required] The authorizer type. Valid values are TOKEN for a Lambda function using a single authorization token submitted in a custom header, REQUEST for a Lambda function using incoming request parameters, and COGNITO_USER_POOLS for using an Amazon Cognito user pool.

Definition at line 153 of file CreateAuthorizerRequest.h.

◆ TypeHasBeenSet()

bool Aws::APIGateway::Model::CreateAuthorizerRequest::TypeHasBeenSet ( ) const
inline

[Required] The authorizer type. Valid values are TOKEN for a Lambda function using a single authorization token submitted in a custom header, REQUEST for a Lambda function using incoming request parameters, and COGNITO_USER_POOLS for using an Amazon Cognito user pool.

Definition at line 137 of file CreateAuthorizerRequest.h.

◆ WithAuthorizerCredentials() [1/3]

CreateAuthorizerRequest& Aws::APIGateway::Model::CreateAuthorizerRequest::WithAuthorizerCredentials ( const Aws::String value)
inline

Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer. To specify an IAM role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To use resource-based permissions on the Lambda function, specify null.

Definition at line 470 of file CreateAuthorizerRequest.h.

◆ WithAuthorizerCredentials() [2/3]

CreateAuthorizerRequest& Aws::APIGateway::Model::CreateAuthorizerRequest::WithAuthorizerCredentials ( Aws::String &&  value)
inline

Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer. To specify an IAM role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To use resource-based permissions on the Lambda function, specify null.

Definition at line 478 of file CreateAuthorizerRequest.h.

◆ WithAuthorizerCredentials() [3/3]

CreateAuthorizerRequest& Aws::APIGateway::Model::CreateAuthorizerRequest::WithAuthorizerCredentials ( const char *  value)
inline

Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer. To specify an IAM role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To use resource-based permissions on the Lambda function, specify null.

Definition at line 486 of file CreateAuthorizerRequest.h.

◆ WithAuthorizerResultTtlInSeconds()

CreateAuthorizerRequest& Aws::APIGateway::Model::CreateAuthorizerRequest::WithAuthorizerResultTtlInSeconds ( int  value)
inline

The TTL in seconds of cached authorizer results. If it equals 0, authorization caching is disabled. If it is greater than 0, API Gateway will cache authorizer responses. If this field is not set, the default value is 300. The maximum value is 3600, or 1 hour.

Definition at line 809 of file CreateAuthorizerRequest.h.

◆ WithAuthorizerUri() [1/3]

CreateAuthorizerRequest& Aws::APIGateway::Model::CreateAuthorizerRequest::WithAuthorizerUri ( const Aws::String value)
inline

Specifies the authorizer's Uniform Resource Identifier (URI). For TOKEN or REQUEST authorizers, this must be a well-formed Lambda function URI, for example, arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:{account_id}:function:{lambda_function_name}/invocations. In general, the URI has this form arn:aws:apigateway:{region}:lambda:path/{service_api}, where {region} is the same as the region hosting the Lambda function, path indicates that the remaining substring in the URI should be treated as the path to the resource, including the initial /. For Lambda functions, this is usually of the form /2015-03-31/functions/[FunctionARN]/invocations.

Definition at line 391 of file CreateAuthorizerRequest.h.

◆ WithAuthorizerUri() [2/3]

CreateAuthorizerRequest& Aws::APIGateway::Model::CreateAuthorizerRequest::WithAuthorizerUri ( Aws::String &&  value)
inline

Specifies the authorizer's Uniform Resource Identifier (URI). For TOKEN or REQUEST authorizers, this must be a well-formed Lambda function URI, for example, arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:{account_id}:function:{lambda_function_name}/invocations. In general, the URI has this form arn:aws:apigateway:{region}:lambda:path/{service_api}, where {region} is the same as the region hosting the Lambda function, path indicates that the remaining substring in the URI should be treated as the path to the resource, including the initial /. For Lambda functions, this is usually of the form /2015-03-31/functions/[FunctionARN]/invocations.

Definition at line 406 of file CreateAuthorizerRequest.h.

◆ WithAuthorizerUri() [3/3]

CreateAuthorizerRequest& Aws::APIGateway::Model::CreateAuthorizerRequest::WithAuthorizerUri ( const char *  value)
inline

Specifies the authorizer's Uniform Resource Identifier (URI). For TOKEN or REQUEST authorizers, this must be a well-formed Lambda function URI, for example, arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:{account_id}:function:{lambda_function_name}/invocations. In general, the URI has this form arn:aws:apigateway:{region}:lambda:path/{service_api}, where {region} is the same as the region hosting the Lambda function, path indicates that the remaining substring in the URI should be treated as the path to the resource, including the initial /. For Lambda functions, this is usually of the form /2015-03-31/functions/[FunctionARN]/invocations.

Definition at line 421 of file CreateAuthorizerRequest.h.

◆ WithAuthType() [1/3]

CreateAuthorizerRequest& Aws::APIGateway::Model::CreateAuthorizerRequest::WithAuthType ( const Aws::String value)
inline

Optional customer-defined field, used in OpenAPI imports and exports without functional impact.

Definition at line 288 of file CreateAuthorizerRequest.h.

◆ WithAuthType() [2/3]

CreateAuthorizerRequest& Aws::APIGateway::Model::CreateAuthorizerRequest::WithAuthType ( Aws::String &&  value)
inline

Optional customer-defined field, used in OpenAPI imports and exports without functional impact.

Definition at line 294 of file CreateAuthorizerRequest.h.

◆ WithAuthType() [3/3]

CreateAuthorizerRequest& Aws::APIGateway::Model::CreateAuthorizerRequest::WithAuthType ( const char *  value)
inline

Optional customer-defined field, used in OpenAPI imports and exports without functional impact.

Definition at line 300 of file CreateAuthorizerRequest.h.

◆ WithIdentitySource() [1/3]

CreateAuthorizerRequest& Aws::APIGateway::Model::CreateAuthorizerRequest::WithIdentitySource ( const Aws::String value)
inline

The identity source for which authorization is requested.

  • For a TOKEN or COGNITO_USER_POOLS authorizer, this is required and specifies the request header mapping expression for the custom header holding the authorization token submitted by the client. For example, if the token header name is Auth, the header mapping expression is method.request.header.Auth.
  • For the REQUEST authorizer, this is required when authorization caching is enabled. The value is a comma-separated string of one or more mapping expressions of the specified request parameters. For example, if an Auth header, a Name query string parameter are defined as identity sources, this value is method.request.header.Auth, method.request.querystring.Name. These parameters will be used to derive the authorization caching key and to perform runtime validation of the REQUEST authorizer by verifying all of the identity-related request parameters are present, not null and non-empty. Only when this is true does the authorizer invoke the authorizer Lambda function, otherwise, it returns a 401 Unauthorized response without calling the Lambda function. The valid value is a string of comma-separated mapping expressions of the specified request parameters. When the authorization caching is not enabled, this property is optional.

Definition at line 631 of file CreateAuthorizerRequest.h.

◆ WithIdentitySource() [2/3]

CreateAuthorizerRequest& Aws::APIGateway::Model::CreateAuthorizerRequest::WithIdentitySource ( Aws::String &&  value)
inline

The identity source for which authorization is requested.

  • For a TOKEN or COGNITO_USER_POOLS authorizer, this is required and specifies the request header mapping expression for the custom header holding the authorization token submitted by the client. For example, if the token header name is Auth, the header mapping expression is method.request.header.Auth.
  • For the REQUEST authorizer, this is required when authorization caching is enabled. The value is a comma-separated string of one or more mapping expressions of the specified request parameters. For example, if an Auth header, a Name query string parameter are defined as identity sources, this value is method.request.header.Auth, method.request.querystring.Name. These parameters will be used to derive the authorization caching key and to perform runtime validation of the REQUEST authorizer by verifying all of the identity-related request parameters are present, not null and non-empty. Only when this is true does the authorizer invoke the authorizer Lambda function, otherwise, it returns a 401 Unauthorized response without calling the Lambda function. The valid value is a string of comma-separated mapping expressions of the specified request parameters. When the authorization caching is not enabled, this property is optional.

Definition at line 655 of file CreateAuthorizerRequest.h.

◆ WithIdentitySource() [3/3]

CreateAuthorizerRequest& Aws::APIGateway::Model::CreateAuthorizerRequest::WithIdentitySource ( const char *  value)
inline

The identity source for which authorization is requested.

  • For a TOKEN or COGNITO_USER_POOLS authorizer, this is required and specifies the request header mapping expression for the custom header holding the authorization token submitted by the client. For example, if the token header name is Auth, the header mapping expression is method.request.header.Auth.
  • For the REQUEST authorizer, this is required when authorization caching is enabled. The value is a comma-separated string of one or more mapping expressions of the specified request parameters. For example, if an Auth header, a Name query string parameter are defined as identity sources, this value is method.request.header.Auth, method.request.querystring.Name. These parameters will be used to derive the authorization caching key and to perform runtime validation of the REQUEST authorizer by verifying all of the identity-related request parameters are present, not null and non-empty. Only when this is true does the authorizer invoke the authorizer Lambda function, otherwise, it returns a 401 Unauthorized response without calling the Lambda function. The valid value is a string of comma-separated mapping expressions of the specified request parameters. When the authorization caching is not enabled, this property is optional.

Definition at line 679 of file CreateAuthorizerRequest.h.

◆ WithIdentityValidationExpression() [1/3]

CreateAuthorizerRequest& Aws::APIGateway::Model::CreateAuthorizerRequest::WithIdentityValidationExpression ( const Aws::String value)
inline

A validation expression for the incoming identity token. For TOKEN authorizers, this value is a regular expression. For COGNITO_USER_POOLS authorizers, API Gateway will match the aud field of the incoming token from the client against the specified regular expression. It will invoke the authorizer's Lambda function when there is a match. Otherwise, it will return a 401 Unauthorized response without calling the Lambda function. The validation expression does not apply to the REQUEST authorizer.

Definition at line 752 of file CreateAuthorizerRequest.h.

◆ WithIdentityValidationExpression() [2/3]

CreateAuthorizerRequest& Aws::APIGateway::Model::CreateAuthorizerRequest::WithIdentityValidationExpression ( Aws::String &&  value)
inline

A validation expression for the incoming identity token. For TOKEN authorizers, this value is a regular expression. For COGNITO_USER_POOLS authorizers, API Gateway will match the aud field of the incoming token from the client against the specified regular expression. It will invoke the authorizer's Lambda function when there is a match. Otherwise, it will return a 401 Unauthorized response without calling the Lambda function. The validation expression does not apply to the REQUEST authorizer.

Definition at line 764 of file CreateAuthorizerRequest.h.

◆ WithIdentityValidationExpression() [3/3]

CreateAuthorizerRequest& Aws::APIGateway::Model::CreateAuthorizerRequest::WithIdentityValidationExpression ( const char *  value)
inline

A validation expression for the incoming identity token. For TOKEN authorizers, this value is a regular expression. For COGNITO_USER_POOLS authorizers, API Gateway will match the aud field of the incoming token from the client against the specified regular expression. It will invoke the authorizer's Lambda function when there is a match. Otherwise, it will return a 401 Unauthorized response without calling the Lambda function. The validation expression does not apply to the REQUEST authorizer.

Definition at line 776 of file CreateAuthorizerRequest.h.

◆ WithName() [1/3]

CreateAuthorizerRequest& Aws::APIGateway::Model::CreateAuthorizerRequest::WithName ( const Aws::String value)
inline

[Required] The name of the authorizer.

Definition at line 110 of file CreateAuthorizerRequest.h.

◆ WithName() [2/3]

CreateAuthorizerRequest& Aws::APIGateway::Model::CreateAuthorizerRequest::WithName ( Aws::String &&  value)
inline

[Required] The name of the authorizer.

Definition at line 115 of file CreateAuthorizerRequest.h.

◆ WithName() [3/3]

CreateAuthorizerRequest& Aws::APIGateway::Model::CreateAuthorizerRequest::WithName ( const char *  value)
inline

[Required] The name of the authorizer.

Definition at line 120 of file CreateAuthorizerRequest.h.

◆ WithProviderARNs() [1/2]

CreateAuthorizerRequest& Aws::APIGateway::Model::CreateAuthorizerRequest::WithProviderARNs ( const Aws::Vector< Aws::String > &  value)
inline

A list of the Amazon Cognito user pool ARNs for the COGNITO_USER_POOLS authorizer. Each element is of this format: arn:aws:cognito-idp:{region}:{account_id}:userpool/{user_pool_id}. For a TOKEN or REQUEST authorizer, this is not defined.

Definition at line 215 of file CreateAuthorizerRequest.h.

◆ WithProviderARNs() [2/2]

CreateAuthorizerRequest& Aws::APIGateway::Model::CreateAuthorizerRequest::WithProviderARNs ( Aws::Vector< Aws::String > &&  value)
inline

A list of the Amazon Cognito user pool ARNs for the COGNITO_USER_POOLS authorizer. Each element is of this format: arn:aws:cognito-idp:{region}:{account_id}:userpool/{user_pool_id}. For a TOKEN or REQUEST authorizer, this is not defined.

Definition at line 224 of file CreateAuthorizerRequest.h.

◆ WithRestApiId() [1/3]

CreateAuthorizerRequest& Aws::APIGateway::Model::CreateAuthorizerRequest::WithRestApiId ( const Aws::String value)
inline

[Required] The string identifier of the associated RestApi.

Definition at line 69 of file CreateAuthorizerRequest.h.

◆ WithRestApiId() [2/3]

CreateAuthorizerRequest& Aws::APIGateway::Model::CreateAuthorizerRequest::WithRestApiId ( Aws::String &&  value)
inline

[Required] The string identifier of the associated RestApi.

Definition at line 74 of file CreateAuthorizerRequest.h.

◆ WithRestApiId() [3/3]

CreateAuthorizerRequest& Aws::APIGateway::Model::CreateAuthorizerRequest::WithRestApiId ( const char *  value)
inline

[Required] The string identifier of the associated RestApi.

Definition at line 79 of file CreateAuthorizerRequest.h.

◆ WithType() [1/2]

CreateAuthorizerRequest& Aws::APIGateway::Model::CreateAuthorizerRequest::WithType ( const AuthorizerType value)
inline

[Required] The authorizer type. Valid values are TOKEN for a Lambda function using a single authorization token submitted in a custom header, REQUEST for a Lambda function using incoming request parameters, and COGNITO_USER_POOLS for using an Amazon Cognito user pool.

Definition at line 161 of file CreateAuthorizerRequest.h.

◆ WithType() [2/2]

CreateAuthorizerRequest& Aws::APIGateway::Model::CreateAuthorizerRequest::WithType ( AuthorizerType &&  value)
inline

[Required] The authorizer type. Valid values are TOKEN for a Lambda function using a single authorization token submitted in a custom header, REQUEST for a Lambda function using incoming request parameters, and COGNITO_USER_POOLS for using an Amazon Cognito user pool.

Definition at line 169 of file CreateAuthorizerRequest.h.


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