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

#include <CreateAuthorizerRequest.h>

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

Public Member Functions

 CreateAuthorizerRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
const Aws::StringGetApiId () const
 
bool ApiIdHasBeenSet () const
 
void SetApiId (const Aws::String &value)
 
void SetApiId (Aws::String &&value)
 
void SetApiId (const char *value)
 
CreateAuthorizerRequestWithApiId (const Aws::String &value)
 
CreateAuthorizerRequestWithApiId (Aws::String &&value)
 
CreateAuthorizerRequestWithApiId (const char *value)
 
const Aws::StringGetAuthorizerCredentialsArn () const
 
bool AuthorizerCredentialsArnHasBeenSet () const
 
void SetAuthorizerCredentialsArn (const Aws::String &value)
 
void SetAuthorizerCredentialsArn (Aws::String &&value)
 
void SetAuthorizerCredentialsArn (const char *value)
 
CreateAuthorizerRequestWithAuthorizerCredentialsArn (const Aws::String &value)
 
CreateAuthorizerRequestWithAuthorizerCredentialsArn (Aws::String &&value)
 
CreateAuthorizerRequestWithAuthorizerCredentialsArn (const char *value)
 
const Aws::StringGetAuthorizerPayloadFormatVersion () const
 
bool AuthorizerPayloadFormatVersionHasBeenSet () const
 
void SetAuthorizerPayloadFormatVersion (const Aws::String &value)
 
void SetAuthorizerPayloadFormatVersion (Aws::String &&value)
 
void SetAuthorizerPayloadFormatVersion (const char *value)
 
CreateAuthorizerRequestWithAuthorizerPayloadFormatVersion (const Aws::String &value)
 
CreateAuthorizerRequestWithAuthorizerPayloadFormatVersion (Aws::String &&value)
 
CreateAuthorizerRequestWithAuthorizerPayloadFormatVersion (const char *value)
 
int GetAuthorizerResultTtlInSeconds () const
 
bool AuthorizerResultTtlInSecondsHasBeenSet () const
 
void SetAuthorizerResultTtlInSeconds (int value)
 
CreateAuthorizerRequestWithAuthorizerResultTtlInSeconds (int value)
 
const AuthorizerTypeGetAuthorizerType () const
 
bool AuthorizerTypeHasBeenSet () const
 
void SetAuthorizerType (const AuthorizerType &value)
 
void SetAuthorizerType (AuthorizerType &&value)
 
CreateAuthorizerRequestWithAuthorizerType (const AuthorizerType &value)
 
CreateAuthorizerRequestWithAuthorizerType (AuthorizerType &&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)
 
bool GetEnableSimpleResponses () const
 
bool EnableSimpleResponsesHasBeenSet () const
 
void SetEnableSimpleResponses (bool value)
 
CreateAuthorizerRequestWithEnableSimpleResponses (bool value)
 
const Aws::Vector< Aws::String > & GetIdentitySource () const
 
bool IdentitySourceHasBeenSet () const
 
void SetIdentitySource (const Aws::Vector< Aws::String > &value)
 
void SetIdentitySource (Aws::Vector< Aws::String > &&value)
 
CreateAuthorizerRequestWithIdentitySource (const Aws::Vector< Aws::String > &value)
 
CreateAuthorizerRequestWithIdentitySource (Aws::Vector< Aws::String > &&value)
 
CreateAuthorizerRequestAddIdentitySource (const Aws::String &value)
 
CreateAuthorizerRequestAddIdentitySource (Aws::String &&value)
 
CreateAuthorizerRequestAddIdentitySource (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)
 
const JWTConfigurationGetJwtConfiguration () const
 
bool JwtConfigurationHasBeenSet () const
 
void SetJwtConfiguration (const JWTConfiguration &value)
 
void SetJwtConfiguration (JWTConfiguration &&value)
 
CreateAuthorizerRequestWithJwtConfiguration (const JWTConfiguration &value)
 
CreateAuthorizerRequestWithJwtConfiguration (JWTConfiguration &&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)
 
- Public Member Functions inherited from Aws::ApiGatewayV2::ApiGatewayV2Request
virtual ~ApiGatewayV2Request ()
 
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::ApiGatewayV2::ApiGatewayV2Request
virtual Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const
 
- Protected Member Functions inherited from Aws::AmazonWebServiceRequest
virtual void DumpBodyToUrl (Aws::Http::URI &uri) const
 

Detailed Description

Creates a new Authorizer resource to represent an authorizer.

See Also:

AWS API Reference

Definition at line 28 of file CreateAuthorizerRequest.h.

Constructor & Destructor Documentation

◆ CreateAuthorizerRequest()

Aws::ApiGatewayV2::Model::CreateAuthorizerRequest::CreateAuthorizerRequest ( )

Member Function Documentation

◆ AddIdentitySource() [1/3]

CreateAuthorizerRequest& Aws::ApiGatewayV2::Model::CreateAuthorizerRequest::AddIdentitySource ( const Aws::String value)
inline

The identity source for which authorization is requested.

For a REQUEST authorizer, this is optional. The value is a set of one or more mapping expressions of the specified request parameters. The identity source can be headers, query string parameters, stage variables, and context parameters. For example, if an Auth header and a Name query string parameter are defined as identity sources, this value is route.request.header.Auth, route.request.querystring.Name for WebSocket APIs. For HTTP APIs, use selection expressions prefixed with $, for example, $request.header.Auth, $request.querystring.Name. These parameters are used to perform runtime validation for Lambda-based authorizers by verifying all of the identity-related request parameters are present in the request, 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. For HTTP APIs, identity sources are also used as the cache key when caching is enabled. To learn more, see Working with AWS Lambda authorizers for HTTP APIs.

For JWT, a single entry that specifies where to extract the JSON Web Token (JWT) from inbound requests. Currently only header-based and query parameter-based selections are supported, for example $request.header.Authorization.

Definition at line 641 of file CreateAuthorizerRequest.h.

◆ AddIdentitySource() [2/3]

CreateAuthorizerRequest& Aws::ApiGatewayV2::Model::CreateAuthorizerRequest::AddIdentitySource ( Aws::String &&  value)
inline

The identity source for which authorization is requested.

For a REQUEST authorizer, this is optional. The value is a set of one or more mapping expressions of the specified request parameters. The identity source can be headers, query string parameters, stage variables, and context parameters. For example, if an Auth header and a Name query string parameter are defined as identity sources, this value is route.request.header.Auth, route.request.querystring.Name for WebSocket APIs. For HTTP APIs, use selection expressions prefixed with $, for example, $request.header.Auth, $request.querystring.Name. These parameters are used to perform runtime validation for Lambda-based authorizers by verifying all of the identity-related request parameters are present in the request, 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. For HTTP APIs, identity sources are also used as the cache key when caching is enabled. To learn more, see Working with AWS Lambda authorizers for HTTP APIs.

For JWT, a single entry that specifies where to extract the JSON Web Token (JWT) from inbound requests. Currently only header-based and query parameter-based selections are supported, for example $request.header.Authorization.

Definition at line 665 of file CreateAuthorizerRequest.h.

◆ AddIdentitySource() [3/3]

CreateAuthorizerRequest& Aws::ApiGatewayV2::Model::CreateAuthorizerRequest::AddIdentitySource ( const char *  value)
inline

The identity source for which authorization is requested.

For a REQUEST authorizer, this is optional. The value is a set of one or more mapping expressions of the specified request parameters. The identity source can be headers, query string parameters, stage variables, and context parameters. For example, if an Auth header and a Name query string parameter are defined as identity sources, this value is route.request.header.Auth, route.request.querystring.Name for WebSocket APIs. For HTTP APIs, use selection expressions prefixed with $, for example, $request.header.Auth, $request.querystring.Name. These parameters are used to perform runtime validation for Lambda-based authorizers by verifying all of the identity-related request parameters are present in the request, 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. For HTTP APIs, identity sources are also used as the cache key when caching is enabled. To learn more, see Working with AWS Lambda authorizers for HTTP APIs.

For JWT, a single entry that specifies where to extract the JSON Web Token (JWT) from inbound requests. Currently only header-based and query parameter-based selections are supported, for example $request.header.Authorization.

Definition at line 689 of file CreateAuthorizerRequest.h.

◆ ApiIdHasBeenSet()

bool Aws::ApiGatewayV2::Model::CreateAuthorizerRequest::ApiIdHasBeenSet ( ) const
inline

The API identifier.

Definition at line 50 of file CreateAuthorizerRequest.h.

◆ AuthorizerCredentialsArnHasBeenSet()

bool Aws::ApiGatewayV2::Model::CreateAuthorizerRequest::AuthorizerCredentialsArnHasBeenSet ( ) 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, don't specify this parameter. Supported only for REQUEST authorizers.

Definition at line 99 of file CreateAuthorizerRequest.h.

◆ AuthorizerPayloadFormatVersionHasBeenSet()

bool Aws::ApiGatewayV2::Model::CreateAuthorizerRequest::AuthorizerPayloadFormatVersionHasBeenSet ( ) const
inline

Specifies the format of the payload sent to an HTTP API Lambda authorizer. Required for HTTP API Lambda authorizers. Supported values are 1.0 and 2.0. To learn more, see Working with AWS Lambda authorizers for HTTP APIs.

Definition at line 172 of file CreateAuthorizerRequest.h.

◆ AuthorizerResultTtlInSecondsHasBeenSet()

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

The time to live (TTL) for cached authorizer results, in seconds. If it equals 0, authorization caching is disabled. If it is greater than 0, API Gateway caches authorizer responses. The maximum value is 3600, or 1 hour. Supported only for HTTP API Lambda authorizers.

Definition at line 243 of file CreateAuthorizerRequest.h.

◆ AuthorizerTypeHasBeenSet()

bool Aws::ApiGatewayV2::Model::CreateAuthorizerRequest::AuthorizerTypeHasBeenSet ( ) const
inline

The authorizer type. Specify REQUEST for a Lambda function using incoming request parameters. Specify JWT to use JSON Web Tokens (supported only for HTTP APIs).

Definition at line 274 of file CreateAuthorizerRequest.h.

◆ AuthorizerUriHasBeenSet()

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

The authorizer's Uniform Resource Identifier (URI). For 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:<replaceable>{account_id}</replaceable>:function:<replaceable>{lambda_function_name}</replaceable>/invocations. In general, the URI has this form: arn:aws:apigateway:<replaceable>{region}</replaceable>:lambda:path/<replaceable>{service_api}</replaceable>

, where <replaceable></replaceable>{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. Supported only for REQUEST authorizers.

Definition at line 335 of file CreateAuthorizerRequest.h.

◆ EnableSimpleResponsesHasBeenSet()

bool Aws::ApiGatewayV2::Model::CreateAuthorizerRequest::EnableSimpleResponsesHasBeenSet ( ) const
inline

Specifies whether a Lambda authorizer returns a response in a simple format. By default, a Lambda authorizer must return an IAM policy. If enabled, the Lambda authorizer can return a boolean value instead of an IAM policy. Supported only for HTTP APIs. To learn more, see Working with AWS Lambda authorizers for HTTP APIs

Definition at line 452 of file CreateAuthorizerRequest.h.

◆ GetApiId()

const Aws::String& Aws::ApiGatewayV2::Model::CreateAuthorizerRequest::GetApiId ( ) const
inline

The API identifier.

Definition at line 45 of file CreateAuthorizerRequest.h.

◆ GetAuthorizerCredentialsArn()

const Aws::String& Aws::ApiGatewayV2::Model::CreateAuthorizerRequest::GetAuthorizerCredentialsArn ( ) 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, don't specify this parameter. Supported only for REQUEST authorizers.

Definition at line 90 of file CreateAuthorizerRequest.h.

◆ GetAuthorizerPayloadFormatVersion()

const Aws::String& Aws::ApiGatewayV2::Model::CreateAuthorizerRequest::GetAuthorizerPayloadFormatVersion ( ) const
inline

Specifies the format of the payload sent to an HTTP API Lambda authorizer. Required for HTTP API Lambda authorizers. Supported values are 1.0 and 2.0. To learn more, see Working with AWS Lambda authorizers for HTTP APIs.

Definition at line 163 of file CreateAuthorizerRequest.h.

◆ GetAuthorizerResultTtlInSeconds()

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

The time to live (TTL) for cached authorizer results, in seconds. If it equals 0, authorization caching is disabled. If it is greater than 0, API Gateway caches authorizer responses. The maximum value is 3600, or 1 hour. Supported only for HTTP API Lambda authorizers.

Definition at line 235 of file CreateAuthorizerRequest.h.

◆ GetAuthorizerType()

const AuthorizerType& Aws::ApiGatewayV2::Model::CreateAuthorizerRequest::GetAuthorizerType ( ) const
inline

The authorizer type. Specify REQUEST for a Lambda function using incoming request parameters. Specify JWT to use JSON Web Tokens (supported only for HTTP APIs).

Definition at line 267 of file CreateAuthorizerRequest.h.

◆ GetAuthorizerUri()

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

The authorizer's Uniform Resource Identifier (URI). For 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:<replaceable>{account_id}</replaceable>:function:<replaceable>{lambda_function_name}</replaceable>/invocations. In general, the URI has this form: arn:aws:apigateway:<replaceable>{region}</replaceable>:lambda:path/<replaceable>{service_api}</replaceable>

, where <replaceable></replaceable>{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. Supported only for REQUEST authorizers.

Definition at line 319 of file CreateAuthorizerRequest.h.

◆ GetEnableSimpleResponses()

bool Aws::ApiGatewayV2::Model::CreateAuthorizerRequest::GetEnableSimpleResponses ( ) const
inline

Specifies whether a Lambda authorizer returns a response in a simple format. By default, a Lambda authorizer must return an IAM policy. If enabled, the Lambda authorizer can return a boolean value instead of an IAM policy. Supported only for HTTP APIs. To learn more, see Working with AWS Lambda authorizers for HTTP APIs

Definition at line 442 of file CreateAuthorizerRequest.h.

◆ GetIdentitySource()

const Aws::Vector<Aws::String>& Aws::ApiGatewayV2::Model::CreateAuthorizerRequest::GetIdentitySource ( ) const
inline

The identity source for which authorization is requested.

For a REQUEST authorizer, this is optional. The value is a set of one or more mapping expressions of the specified request parameters. The identity source can be headers, query string parameters, stage variables, and context parameters. For example, if an Auth header and a Name query string parameter are defined as identity sources, this value is route.request.header.Auth, route.request.querystring.Name for WebSocket APIs. For HTTP APIs, use selection expressions prefixed with $, for example, $request.header.Auth, $request.querystring.Name. These parameters are used to perform runtime validation for Lambda-based authorizers by verifying all of the identity-related request parameters are present in the request, 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. For HTTP APIs, identity sources are also used as the cache key when caching is enabled. To learn more, see Working with AWS Lambda authorizers for HTTP APIs.

For JWT, a single entry that specifies where to extract the JSON Web Token (JWT) from inbound requests. Currently only header-based and query parameter-based selections are supported, for example $request.header.Authorization.

Definition at line 497 of file CreateAuthorizerRequest.h.

◆ GetIdentityValidationExpression()

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

This parameter is not used.

Definition at line 695 of file CreateAuthorizerRequest.h.

◆ GetJwtConfiguration()

const JWTConfiguration& Aws::ApiGatewayV2::Model::CreateAuthorizerRequest::GetJwtConfiguration ( ) const
inline

Represents the configuration of a JWT authorizer. Required for the JWT authorizer type. Supported only for HTTP APIs.

Definition at line 737 of file CreateAuthorizerRequest.h.

◆ GetName()

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

The name of the authorizer.

Definition at line 773 of file CreateAuthorizerRequest.h.

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 37 of file CreateAuthorizerRequest.h.

◆ IdentitySourceHasBeenSet()

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

The identity source for which authorization is requested.

For a REQUEST authorizer, this is optional. The value is a set of one or more mapping expressions of the specified request parameters. The identity source can be headers, query string parameters, stage variables, and context parameters. For example, if an Auth header and a Name query string parameter are defined as identity sources, this value is route.request.header.Auth, route.request.querystring.Name for WebSocket APIs. For HTTP APIs, use selection expressions prefixed with $, for example, $request.header.Auth, $request.querystring.Name. These parameters are used to perform runtime validation for Lambda-based authorizers by verifying all of the identity-related request parameters are present in the request, 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. For HTTP APIs, identity sources are also used as the cache key when caching is enabled. To learn more, see Working with AWS Lambda authorizers for HTTP APIs.

For JWT, a single entry that specifies where to extract the JSON Web Token (JWT) from inbound requests. Currently only header-based and query parameter-based selections are supported, for example $request.header.Authorization.

Definition at line 521 of file CreateAuthorizerRequest.h.

◆ IdentityValidationExpressionHasBeenSet()

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

This parameter is not used.

Definition at line 700 of file CreateAuthorizerRequest.h.

◆ JwtConfigurationHasBeenSet()

bool Aws::ApiGatewayV2::Model::CreateAuthorizerRequest::JwtConfigurationHasBeenSet ( ) const
inline

Represents the configuration of a JWT authorizer. Required for the JWT authorizer type. Supported only for HTTP APIs.

Definition at line 743 of file CreateAuthorizerRequest.h.

◆ NameHasBeenSet()

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

The name of the authorizer.

Definition at line 778 of file CreateAuthorizerRequest.h.

◆ SerializePayload()

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

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetApiId() [1/3]

void Aws::ApiGatewayV2::Model::CreateAuthorizerRequest::SetApiId ( const Aws::String value)
inline

The API identifier.

Definition at line 55 of file CreateAuthorizerRequest.h.

◆ SetApiId() [2/3]

void Aws::ApiGatewayV2::Model::CreateAuthorizerRequest::SetApiId ( Aws::String &&  value)
inline

The API identifier.

Definition at line 60 of file CreateAuthorizerRequest.h.

◆ SetApiId() [3/3]

void Aws::ApiGatewayV2::Model::CreateAuthorizerRequest::SetApiId ( const char *  value)
inline

The API identifier.

Definition at line 65 of file CreateAuthorizerRequest.h.

◆ SetAuthorizerCredentialsArn() [1/3]

void Aws::ApiGatewayV2::Model::CreateAuthorizerRequest::SetAuthorizerCredentialsArn ( 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, don't specify this parameter. Supported only for REQUEST authorizers.

Definition at line 108 of file CreateAuthorizerRequest.h.

◆ SetAuthorizerCredentialsArn() [2/3]

void Aws::ApiGatewayV2::Model::CreateAuthorizerRequest::SetAuthorizerCredentialsArn ( 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, don't specify this parameter. Supported only for REQUEST authorizers.

Definition at line 117 of file CreateAuthorizerRequest.h.

◆ SetAuthorizerCredentialsArn() [3/3]

void Aws::ApiGatewayV2::Model::CreateAuthorizerRequest::SetAuthorizerCredentialsArn ( 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, don't specify this parameter. Supported only for REQUEST authorizers.

Definition at line 126 of file CreateAuthorizerRequest.h.

◆ SetAuthorizerPayloadFormatVersion() [1/3]

void Aws::ApiGatewayV2::Model::CreateAuthorizerRequest::SetAuthorizerPayloadFormatVersion ( const Aws::String value)
inline

Specifies the format of the payload sent to an HTTP API Lambda authorizer. Required for HTTP API Lambda authorizers. Supported values are 1.0 and 2.0. To learn more, see Working with AWS Lambda authorizers for HTTP APIs.

Definition at line 181 of file CreateAuthorizerRequest.h.

◆ SetAuthorizerPayloadFormatVersion() [2/3]

void Aws::ApiGatewayV2::Model::CreateAuthorizerRequest::SetAuthorizerPayloadFormatVersion ( Aws::String &&  value)
inline

Specifies the format of the payload sent to an HTTP API Lambda authorizer. Required for HTTP API Lambda authorizers. Supported values are 1.0 and 2.0. To learn more, see Working with AWS Lambda authorizers for HTTP APIs.

Definition at line 190 of file CreateAuthorizerRequest.h.

◆ SetAuthorizerPayloadFormatVersion() [3/3]

void Aws::ApiGatewayV2::Model::CreateAuthorizerRequest::SetAuthorizerPayloadFormatVersion ( const char *  value)
inline

Specifies the format of the payload sent to an HTTP API Lambda authorizer. Required for HTTP API Lambda authorizers. Supported values are 1.0 and 2.0. To learn more, see Working with AWS Lambda authorizers for HTTP APIs.

Definition at line 199 of file CreateAuthorizerRequest.h.

◆ SetAuthorizerResultTtlInSeconds()

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

The time to live (TTL) for cached authorizer results, in seconds. If it equals 0, authorization caching is disabled. If it is greater than 0, API Gateway caches authorizer responses. The maximum value is 3600, or 1 hour. Supported only for HTTP API Lambda authorizers.

Definition at line 251 of file CreateAuthorizerRequest.h.

◆ SetAuthorizerType() [1/2]

void Aws::ApiGatewayV2::Model::CreateAuthorizerRequest::SetAuthorizerType ( const AuthorizerType value)
inline

The authorizer type. Specify REQUEST for a Lambda function using incoming request parameters. Specify JWT to use JSON Web Tokens (supported only for HTTP APIs).

Definition at line 281 of file CreateAuthorizerRequest.h.

◆ SetAuthorizerType() [2/2]

void Aws::ApiGatewayV2::Model::CreateAuthorizerRequest::SetAuthorizerType ( AuthorizerType &&  value)
inline

The authorizer type. Specify REQUEST for a Lambda function using incoming request parameters. Specify JWT to use JSON Web Tokens (supported only for HTTP APIs).

Definition at line 288 of file CreateAuthorizerRequest.h.

◆ SetAuthorizerUri() [1/3]

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

The authorizer's Uniform Resource Identifier (URI). For 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:<replaceable>{account_id}</replaceable>:function:<replaceable>{lambda_function_name}</replaceable>/invocations. In general, the URI has this form: arn:aws:apigateway:<replaceable>{region}</replaceable>:lambda:path/<replaceable>{service_api}</replaceable>

, where <replaceable></replaceable>{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. Supported only for REQUEST authorizers.

Definition at line 351 of file CreateAuthorizerRequest.h.

◆ SetAuthorizerUri() [2/3]

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

The authorizer's Uniform Resource Identifier (URI). For 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:<replaceable>{account_id}</replaceable>:function:<replaceable>{lambda_function_name}</replaceable>/invocations. In general, the URI has this form: arn:aws:apigateway:<replaceable>{region}</replaceable>:lambda:path/<replaceable>{service_api}</replaceable>

, where <replaceable></replaceable>{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. Supported only for REQUEST authorizers.

Definition at line 367 of file CreateAuthorizerRequest.h.

◆ SetAuthorizerUri() [3/3]

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

The authorizer's Uniform Resource Identifier (URI). For 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:<replaceable>{account_id}</replaceable>:function:<replaceable>{lambda_function_name}</replaceable>/invocations. In general, the URI has this form: arn:aws:apigateway:<replaceable>{region}</replaceable>:lambda:path/<replaceable>{service_api}</replaceable>

, where <replaceable></replaceable>{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. Supported only for REQUEST authorizers.

Definition at line 383 of file CreateAuthorizerRequest.h.

◆ SetEnableSimpleResponses()

void Aws::ApiGatewayV2::Model::CreateAuthorizerRequest::SetEnableSimpleResponses ( bool  value)
inline

Specifies whether a Lambda authorizer returns a response in a simple format. By default, a Lambda authorizer must return an IAM policy. If enabled, the Lambda authorizer can return a boolean value instead of an IAM policy. Supported only for HTTP APIs. To learn more, see Working with AWS Lambda authorizers for HTTP APIs

Definition at line 462 of file CreateAuthorizerRequest.h.

◆ SetIdentitySource() [1/2]

void Aws::ApiGatewayV2::Model::CreateAuthorizerRequest::SetIdentitySource ( const Aws::Vector< Aws::String > &  value)
inline

The identity source for which authorization is requested.

For a REQUEST authorizer, this is optional. The value is a set of one or more mapping expressions of the specified request parameters. The identity source can be headers, query string parameters, stage variables, and context parameters. For example, if an Auth header and a Name query string parameter are defined as identity sources, this value is route.request.header.Auth, route.request.querystring.Name for WebSocket APIs. For HTTP APIs, use selection expressions prefixed with $, for example, $request.header.Auth, $request.querystring.Name. These parameters are used to perform runtime validation for Lambda-based authorizers by verifying all of the identity-related request parameters are present in the request, 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. For HTTP APIs, identity sources are also used as the cache key when caching is enabled. To learn more, see Working with AWS Lambda authorizers for HTTP APIs.

For JWT, a single entry that specifies where to extract the JSON Web Token (JWT) from inbound requests. Currently only header-based and query parameter-based selections are supported, for example $request.header.Authorization.

Definition at line 545 of file CreateAuthorizerRequest.h.

◆ SetIdentitySource() [2/2]

void Aws::ApiGatewayV2::Model::CreateAuthorizerRequest::SetIdentitySource ( Aws::Vector< Aws::String > &&  value)
inline

The identity source for which authorization is requested.

For a REQUEST authorizer, this is optional. The value is a set of one or more mapping expressions of the specified request parameters. The identity source can be headers, query string parameters, stage variables, and context parameters. For example, if an Auth header and a Name query string parameter are defined as identity sources, this value is route.request.header.Auth, route.request.querystring.Name for WebSocket APIs. For HTTP APIs, use selection expressions prefixed with $, for example, $request.header.Auth, $request.querystring.Name. These parameters are used to perform runtime validation for Lambda-based authorizers by verifying all of the identity-related request parameters are present in the request, 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. For HTTP APIs, identity sources are also used as the cache key when caching is enabled. To learn more, see Working with AWS Lambda authorizers for HTTP APIs.

For JWT, a single entry that specifies where to extract the JSON Web Token (JWT) from inbound requests. Currently only header-based and query parameter-based selections are supported, for example $request.header.Authorization.

Definition at line 569 of file CreateAuthorizerRequest.h.

◆ SetIdentityValidationExpression() [1/3]

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

This parameter is not used.

Definition at line 705 of file CreateAuthorizerRequest.h.

◆ SetIdentityValidationExpression() [2/3]

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

This parameter is not used.

Definition at line 710 of file CreateAuthorizerRequest.h.

◆ SetIdentityValidationExpression() [3/3]

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

This parameter is not used.

Definition at line 715 of file CreateAuthorizerRequest.h.

◆ SetJwtConfiguration() [1/2]

void Aws::ApiGatewayV2::Model::CreateAuthorizerRequest::SetJwtConfiguration ( const JWTConfiguration value)
inline

Represents the configuration of a JWT authorizer. Required for the JWT authorizer type. Supported only for HTTP APIs.

Definition at line 749 of file CreateAuthorizerRequest.h.

◆ SetJwtConfiguration() [2/2]

void Aws::ApiGatewayV2::Model::CreateAuthorizerRequest::SetJwtConfiguration ( JWTConfiguration &&  value)
inline

Represents the configuration of a JWT authorizer. Required for the JWT authorizer type. Supported only for HTTP APIs.

Definition at line 755 of file CreateAuthorizerRequest.h.

◆ SetName() [1/3]

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

The name of the authorizer.

Definition at line 783 of file CreateAuthorizerRequest.h.

◆ SetName() [2/3]

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

The name of the authorizer.

Definition at line 788 of file CreateAuthorizerRequest.h.

◆ SetName() [3/3]

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

The name of the authorizer.

Definition at line 793 of file CreateAuthorizerRequest.h.

◆ WithApiId() [1/3]

CreateAuthorizerRequest& Aws::ApiGatewayV2::Model::CreateAuthorizerRequest::WithApiId ( const Aws::String value)
inline

The API identifier.

Definition at line 70 of file CreateAuthorizerRequest.h.

◆ WithApiId() [2/3]

CreateAuthorizerRequest& Aws::ApiGatewayV2::Model::CreateAuthorizerRequest::WithApiId ( Aws::String &&  value)
inline

The API identifier.

Definition at line 75 of file CreateAuthorizerRequest.h.

◆ WithApiId() [3/3]

CreateAuthorizerRequest& Aws::ApiGatewayV2::Model::CreateAuthorizerRequest::WithApiId ( const char *  value)
inline

The API identifier.

Definition at line 80 of file CreateAuthorizerRequest.h.

◆ WithAuthorizerCredentialsArn() [1/3]

CreateAuthorizerRequest& Aws::ApiGatewayV2::Model::CreateAuthorizerRequest::WithAuthorizerCredentialsArn ( 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, don't specify this parameter. Supported only for REQUEST authorizers.

Definition at line 135 of file CreateAuthorizerRequest.h.

◆ WithAuthorizerCredentialsArn() [2/3]

CreateAuthorizerRequest& Aws::ApiGatewayV2::Model::CreateAuthorizerRequest::WithAuthorizerCredentialsArn ( 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, don't specify this parameter. Supported only for REQUEST authorizers.

Definition at line 144 of file CreateAuthorizerRequest.h.

◆ WithAuthorizerCredentialsArn() [3/3]

CreateAuthorizerRequest& Aws::ApiGatewayV2::Model::CreateAuthorizerRequest::WithAuthorizerCredentialsArn ( 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, don't specify this parameter. Supported only for REQUEST authorizers.

Definition at line 153 of file CreateAuthorizerRequest.h.

◆ WithAuthorizerPayloadFormatVersion() [1/3]

CreateAuthorizerRequest& Aws::ApiGatewayV2::Model::CreateAuthorizerRequest::WithAuthorizerPayloadFormatVersion ( const Aws::String value)
inline

Specifies the format of the payload sent to an HTTP API Lambda authorizer. Required for HTTP API Lambda authorizers. Supported values are 1.0 and 2.0. To learn more, see Working with AWS Lambda authorizers for HTTP APIs.

Definition at line 208 of file CreateAuthorizerRequest.h.

◆ WithAuthorizerPayloadFormatVersion() [2/3]

CreateAuthorizerRequest& Aws::ApiGatewayV2::Model::CreateAuthorizerRequest::WithAuthorizerPayloadFormatVersion ( Aws::String &&  value)
inline

Specifies the format of the payload sent to an HTTP API Lambda authorizer. Required for HTTP API Lambda authorizers. Supported values are 1.0 and 2.0. To learn more, see Working with AWS Lambda authorizers for HTTP APIs.

Definition at line 217 of file CreateAuthorizerRequest.h.

◆ WithAuthorizerPayloadFormatVersion() [3/3]

CreateAuthorizerRequest& Aws::ApiGatewayV2::Model::CreateAuthorizerRequest::WithAuthorizerPayloadFormatVersion ( const char *  value)
inline

Specifies the format of the payload sent to an HTTP API Lambda authorizer. Required for HTTP API Lambda authorizers. Supported values are 1.0 and 2.0. To learn more, see Working with AWS Lambda authorizers for HTTP APIs.

Definition at line 226 of file CreateAuthorizerRequest.h.

◆ WithAuthorizerResultTtlInSeconds()

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

The time to live (TTL) for cached authorizer results, in seconds. If it equals 0, authorization caching is disabled. If it is greater than 0, API Gateway caches authorizer responses. The maximum value is 3600, or 1 hour. Supported only for HTTP API Lambda authorizers.

Definition at line 259 of file CreateAuthorizerRequest.h.

◆ WithAuthorizerType() [1/2]

CreateAuthorizerRequest& Aws::ApiGatewayV2::Model::CreateAuthorizerRequest::WithAuthorizerType ( const AuthorizerType value)
inline

The authorizer type. Specify REQUEST for a Lambda function using incoming request parameters. Specify JWT to use JSON Web Tokens (supported only for HTTP APIs).

Definition at line 295 of file CreateAuthorizerRequest.h.

◆ WithAuthorizerType() [2/2]

CreateAuthorizerRequest& Aws::ApiGatewayV2::Model::CreateAuthorizerRequest::WithAuthorizerType ( AuthorizerType &&  value)
inline

The authorizer type. Specify REQUEST for a Lambda function using incoming request parameters. Specify JWT to use JSON Web Tokens (supported only for HTTP APIs).

Definition at line 302 of file CreateAuthorizerRequest.h.

◆ WithAuthorizerUri() [1/3]

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

The authorizer's Uniform Resource Identifier (URI). For 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:<replaceable>{account_id}</replaceable>:function:<replaceable>{lambda_function_name}</replaceable>/invocations. In general, the URI has this form: arn:aws:apigateway:<replaceable>{region}</replaceable>:lambda:path/<replaceable>{service_api}</replaceable>

, where <replaceable></replaceable>{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. Supported only for REQUEST authorizers.

Definition at line 399 of file CreateAuthorizerRequest.h.

◆ WithAuthorizerUri() [2/3]

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

The authorizer's Uniform Resource Identifier (URI). For 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:<replaceable>{account_id}</replaceable>:function:<replaceable>{lambda_function_name}</replaceable>/invocations. In general, the URI has this form: arn:aws:apigateway:<replaceable>{region}</replaceable>:lambda:path/<replaceable>{service_api}</replaceable>

, where <replaceable></replaceable>{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. Supported only for REQUEST authorizers.

Definition at line 415 of file CreateAuthorizerRequest.h.

◆ WithAuthorizerUri() [3/3]

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

The authorizer's Uniform Resource Identifier (URI). For 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:<replaceable>{account_id}</replaceable>:function:<replaceable>{lambda_function_name}</replaceable>/invocations. In general, the URI has this form: arn:aws:apigateway:<replaceable>{region}</replaceable>:lambda:path/<replaceable>{service_api}</replaceable>

, where <replaceable></replaceable>{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. Supported only for REQUEST authorizers.

Definition at line 431 of file CreateAuthorizerRequest.h.

◆ WithEnableSimpleResponses()

CreateAuthorizerRequest& Aws::ApiGatewayV2::Model::CreateAuthorizerRequest::WithEnableSimpleResponses ( bool  value)
inline

Specifies whether a Lambda authorizer returns a response in a simple format. By default, a Lambda authorizer must return an IAM policy. If enabled, the Lambda authorizer can return a boolean value instead of an IAM policy. Supported only for HTTP APIs. To learn more, see Working with AWS Lambda authorizers for HTTP APIs

Definition at line 472 of file CreateAuthorizerRequest.h.

◆ WithIdentitySource() [1/2]

CreateAuthorizerRequest& Aws::ApiGatewayV2::Model::CreateAuthorizerRequest::WithIdentitySource ( const Aws::Vector< Aws::String > &  value)
inline

The identity source for which authorization is requested.

For a REQUEST authorizer, this is optional. The value is a set of one or more mapping expressions of the specified request parameters. The identity source can be headers, query string parameters, stage variables, and context parameters. For example, if an Auth header and a Name query string parameter are defined as identity sources, this value is route.request.header.Auth, route.request.querystring.Name for WebSocket APIs. For HTTP APIs, use selection expressions prefixed with $, for example, $request.header.Auth, $request.querystring.Name. These parameters are used to perform runtime validation for Lambda-based authorizers by verifying all of the identity-related request parameters are present in the request, 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. For HTTP APIs, identity sources are also used as the cache key when caching is enabled. To learn more, see Working with AWS Lambda authorizers for HTTP APIs.

For JWT, a single entry that specifies where to extract the JSON Web Token (JWT) from inbound requests. Currently only header-based and query parameter-based selections are supported, for example $request.header.Authorization.

Definition at line 593 of file CreateAuthorizerRequest.h.

◆ WithIdentitySource() [2/2]

CreateAuthorizerRequest& Aws::ApiGatewayV2::Model::CreateAuthorizerRequest::WithIdentitySource ( Aws::Vector< Aws::String > &&  value)
inline

The identity source for which authorization is requested.

For a REQUEST authorizer, this is optional. The value is a set of one or more mapping expressions of the specified request parameters. The identity source can be headers, query string parameters, stage variables, and context parameters. For example, if an Auth header and a Name query string parameter are defined as identity sources, this value is route.request.header.Auth, route.request.querystring.Name for WebSocket APIs. For HTTP APIs, use selection expressions prefixed with $, for example, $request.header.Auth, $request.querystring.Name. These parameters are used to perform runtime validation for Lambda-based authorizers by verifying all of the identity-related request parameters are present in the request, 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. For HTTP APIs, identity sources are also used as the cache key when caching is enabled. To learn more, see Working with AWS Lambda authorizers for HTTP APIs.

For JWT, a single entry that specifies where to extract the JSON Web Token (JWT) from inbound requests. Currently only header-based and query parameter-based selections are supported, for example $request.header.Authorization.

Definition at line 617 of file CreateAuthorizerRequest.h.

◆ WithIdentityValidationExpression() [1/3]

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

This parameter is not used.

Definition at line 720 of file CreateAuthorizerRequest.h.

◆ WithIdentityValidationExpression() [2/3]

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

This parameter is not used.

Definition at line 725 of file CreateAuthorizerRequest.h.

◆ WithIdentityValidationExpression() [3/3]

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

This parameter is not used.

Definition at line 730 of file CreateAuthorizerRequest.h.

◆ WithJwtConfiguration() [1/2]

CreateAuthorizerRequest& Aws::ApiGatewayV2::Model::CreateAuthorizerRequest::WithJwtConfiguration ( const JWTConfiguration value)
inline

Represents the configuration of a JWT authorizer. Required for the JWT authorizer type. Supported only for HTTP APIs.

Definition at line 761 of file CreateAuthorizerRequest.h.

◆ WithJwtConfiguration() [2/2]

CreateAuthorizerRequest& Aws::ApiGatewayV2::Model::CreateAuthorizerRequest::WithJwtConfiguration ( JWTConfiguration &&  value)
inline

Represents the configuration of a JWT authorizer. Required for the JWT authorizer type. Supported only for HTTP APIs.

Definition at line 767 of file CreateAuthorizerRequest.h.

◆ WithName() [1/3]

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

The name of the authorizer.

Definition at line 798 of file CreateAuthorizerRequest.h.

◆ WithName() [2/3]

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

The name of the authorizer.

Definition at line 803 of file CreateAuthorizerRequest.h.

◆ WithName() [3/3]

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

The name of the authorizer.

Definition at line 808 of file CreateAuthorizerRequest.h.


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