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

#include <Authorizer.h>

Public Member Functions

 Authorizer ()
 
 Authorizer (Aws::Utils::Json::JsonView jsonValue)
 
Authorizeroperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
const Aws::StringGetAuthorizerCredentialsArn () const
 
bool AuthorizerCredentialsArnHasBeenSet () const
 
void SetAuthorizerCredentialsArn (const Aws::String &value)
 
void SetAuthorizerCredentialsArn (Aws::String &&value)
 
void SetAuthorizerCredentialsArn (const char *value)
 
AuthorizerWithAuthorizerCredentialsArn (const Aws::String &value)
 
AuthorizerWithAuthorizerCredentialsArn (Aws::String &&value)
 
AuthorizerWithAuthorizerCredentialsArn (const char *value)
 
const Aws::StringGetAuthorizerId () const
 
bool AuthorizerIdHasBeenSet () const
 
void SetAuthorizerId (const Aws::String &value)
 
void SetAuthorizerId (Aws::String &&value)
 
void SetAuthorizerId (const char *value)
 
AuthorizerWithAuthorizerId (const Aws::String &value)
 
AuthorizerWithAuthorizerId (Aws::String &&value)
 
AuthorizerWithAuthorizerId (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)
 
AuthorizerWithAuthorizerPayloadFormatVersion (const Aws::String &value)
 
AuthorizerWithAuthorizerPayloadFormatVersion (Aws::String &&value)
 
AuthorizerWithAuthorizerPayloadFormatVersion (const char *value)
 
int GetAuthorizerResultTtlInSeconds () const
 
bool AuthorizerResultTtlInSecondsHasBeenSet () const
 
void SetAuthorizerResultTtlInSeconds (int value)
 
AuthorizerWithAuthorizerResultTtlInSeconds (int value)
 
const AuthorizerTypeGetAuthorizerType () const
 
bool AuthorizerTypeHasBeenSet () const
 
void SetAuthorizerType (const AuthorizerType &value)
 
void SetAuthorizerType (AuthorizerType &&value)
 
AuthorizerWithAuthorizerType (const AuthorizerType &value)
 
AuthorizerWithAuthorizerType (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)
 
AuthorizerWithAuthorizerUri (const Aws::String &value)
 
AuthorizerWithAuthorizerUri (Aws::String &&value)
 
AuthorizerWithAuthorizerUri (const char *value)
 
bool GetEnableSimpleResponses () const
 
bool EnableSimpleResponsesHasBeenSet () const
 
void SetEnableSimpleResponses (bool value)
 
AuthorizerWithEnableSimpleResponses (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)
 
AuthorizerWithIdentitySource (const Aws::Vector< Aws::String > &value)
 
AuthorizerWithIdentitySource (Aws::Vector< Aws::String > &&value)
 
AuthorizerAddIdentitySource (const Aws::String &value)
 
AuthorizerAddIdentitySource (Aws::String &&value)
 
AuthorizerAddIdentitySource (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)
 
AuthorizerWithIdentityValidationExpression (const Aws::String &value)
 
AuthorizerWithIdentityValidationExpression (Aws::String &&value)
 
AuthorizerWithIdentityValidationExpression (const char *value)
 
const JWTConfigurationGetJwtConfiguration () const
 
bool JwtConfigurationHasBeenSet () const
 
void SetJwtConfiguration (const JWTConfiguration &value)
 
void SetJwtConfiguration (JWTConfiguration &&value)
 
AuthorizerWithJwtConfiguration (const JWTConfiguration &value)
 
AuthorizerWithJwtConfiguration (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)
 
AuthorizerWithName (const Aws::String &value)
 
AuthorizerWithName (Aws::String &&value)
 
AuthorizerWithName (const char *value)
 

Detailed Description

Represents an authorizer.

See Also:

AWS API Reference

Definition at line 34 of file Authorizer.h.

Constructor & Destructor Documentation

◆ Authorizer() [1/2]

Aws::ApiGatewayV2::Model::Authorizer::Authorizer ( )

◆ Authorizer() [2/2]

Aws::ApiGatewayV2::Model::Authorizer::Authorizer ( Aws::Utils::Json::JsonView  jsonValue)

Member Function Documentation

◆ AddIdentitySource() [1/3]

Authorizer& Aws::ApiGatewayV2::Model::Authorizer::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 638 of file Authorizer.h.

◆ AddIdentitySource() [2/3]

Authorizer& Aws::ApiGatewayV2::Model::Authorizer::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 662 of file Authorizer.h.

◆ AddIdentitySource() [3/3]

Authorizer& Aws::ApiGatewayV2::Model::Authorizer::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 686 of file Authorizer.h.

◆ AuthorizerCredentialsArnHasBeenSet()

bool Aws::ApiGatewayV2::Model::Authorizer::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 59 of file Authorizer.h.

◆ AuthorizerIdHasBeenSet()

bool Aws::ApiGatewayV2::Model::Authorizer::AuthorizerIdHasBeenSet ( ) const
inline

The authorizer identifier.

Definition at line 124 of file Authorizer.h.

◆ AuthorizerPayloadFormatVersionHasBeenSet()

bool Aws::ApiGatewayV2::Model::Authorizer::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 173 of file Authorizer.h.

◆ AuthorizerResultTtlInSecondsHasBeenSet()

bool Aws::ApiGatewayV2::Model::Authorizer::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 244 of file Authorizer.h.

◆ AuthorizerTypeHasBeenSet()

bool Aws::ApiGatewayV2::Model::Authorizer::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 275 of file Authorizer.h.

◆ AuthorizerUriHasBeenSet()

bool Aws::ApiGatewayV2::Model::Authorizer::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 336 of file Authorizer.h.

◆ EnableSimpleResponsesHasBeenSet()

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

Specifies whether a Lambda authorizer returns a response in a simple format. 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 451 of file Authorizer.h.

◆ GetAuthorizerCredentialsArn()

const Aws::String& Aws::ApiGatewayV2::Model::Authorizer::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 50 of file Authorizer.h.

◆ GetAuthorizerId()

const Aws::String& Aws::ApiGatewayV2::Model::Authorizer::GetAuthorizerId ( ) const
inline

The authorizer identifier.

Definition at line 119 of file Authorizer.h.

◆ GetAuthorizerPayloadFormatVersion()

const Aws::String& Aws::ApiGatewayV2::Model::Authorizer::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 164 of file Authorizer.h.

◆ GetAuthorizerResultTtlInSeconds()

int Aws::ApiGatewayV2::Model::Authorizer::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 236 of file Authorizer.h.

◆ GetAuthorizerType()

const AuthorizerType& Aws::ApiGatewayV2::Model::Authorizer::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 268 of file Authorizer.h.

◆ GetAuthorizerUri()

const Aws::String& Aws::ApiGatewayV2::Model::Authorizer::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 320 of file Authorizer.h.

◆ GetEnableSimpleResponses()

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

Specifies whether a Lambda authorizer returns a response in a simple format. 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 Authorizer.h.

◆ GetIdentitySource()

const Aws::Vector<Aws::String>& Aws::ApiGatewayV2::Model::Authorizer::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 494 of file Authorizer.h.

◆ GetIdentityValidationExpression()

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

The validation expression does not apply to the REQUEST authorizer.

Definition at line 692 of file Authorizer.h.

◆ GetJwtConfiguration()

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

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

Definition at line 734 of file Authorizer.h.

◆ GetName()

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

The name of the authorizer.

Definition at line 770 of file Authorizer.h.

◆ IdentitySourceHasBeenSet()

bool Aws::ApiGatewayV2::Model::Authorizer::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 518 of file Authorizer.h.

◆ IdentityValidationExpressionHasBeenSet()

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

The validation expression does not apply to the REQUEST authorizer.

Definition at line 697 of file Authorizer.h.

◆ Jsonize()

Aws::Utils::Json::JsonValue Aws::ApiGatewayV2::Model::Authorizer::Jsonize ( ) const

◆ JwtConfigurationHasBeenSet()

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

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

Definition at line 740 of file Authorizer.h.

◆ NameHasBeenSet()

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

The name of the authorizer.

Definition at line 775 of file Authorizer.h.

◆ operator=()

Authorizer& Aws::ApiGatewayV2::Model::Authorizer::operator= ( Aws::Utils::Json::JsonView  jsonValue)

◆ SetAuthorizerCredentialsArn() [1/3]

void Aws::ApiGatewayV2::Model::Authorizer::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 68 of file Authorizer.h.

◆ SetAuthorizerCredentialsArn() [2/3]

void Aws::ApiGatewayV2::Model::Authorizer::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 77 of file Authorizer.h.

◆ SetAuthorizerCredentialsArn() [3/3]

void Aws::ApiGatewayV2::Model::Authorizer::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 86 of file Authorizer.h.

◆ SetAuthorizerId() [1/3]

void Aws::ApiGatewayV2::Model::Authorizer::SetAuthorizerId ( const Aws::String value)
inline

The authorizer identifier.

Definition at line 129 of file Authorizer.h.

◆ SetAuthorizerId() [2/3]

void Aws::ApiGatewayV2::Model::Authorizer::SetAuthorizerId ( Aws::String &&  value)
inline

The authorizer identifier.

Definition at line 134 of file Authorizer.h.

◆ SetAuthorizerId() [3/3]

void Aws::ApiGatewayV2::Model::Authorizer::SetAuthorizerId ( const char *  value)
inline

The authorizer identifier.

Definition at line 139 of file Authorizer.h.

◆ SetAuthorizerPayloadFormatVersion() [1/3]

void Aws::ApiGatewayV2::Model::Authorizer::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 182 of file Authorizer.h.

◆ SetAuthorizerPayloadFormatVersion() [2/3]

void Aws::ApiGatewayV2::Model::Authorizer::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 191 of file Authorizer.h.

◆ SetAuthorizerPayloadFormatVersion() [3/3]

void Aws::ApiGatewayV2::Model::Authorizer::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 200 of file Authorizer.h.

◆ SetAuthorizerResultTtlInSeconds()

void Aws::ApiGatewayV2::Model::Authorizer::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 252 of file Authorizer.h.

◆ SetAuthorizerType() [1/2]

void Aws::ApiGatewayV2::Model::Authorizer::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 282 of file Authorizer.h.

◆ SetAuthorizerType() [2/2]

void Aws::ApiGatewayV2::Model::Authorizer::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 289 of file Authorizer.h.

◆ SetAuthorizerUri() [1/3]

void Aws::ApiGatewayV2::Model::Authorizer::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 352 of file Authorizer.h.

◆ SetAuthorizerUri() [2/3]

void Aws::ApiGatewayV2::Model::Authorizer::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 368 of file Authorizer.h.

◆ SetAuthorizerUri() [3/3]

void Aws::ApiGatewayV2::Model::Authorizer::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 384 of file Authorizer.h.

◆ SetEnableSimpleResponses()

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

Specifies whether a Lambda authorizer returns a response in a simple format. 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 460 of file Authorizer.h.

◆ SetIdentitySource() [1/2]

void Aws::ApiGatewayV2::Model::Authorizer::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 542 of file Authorizer.h.

◆ SetIdentitySource() [2/2]

void Aws::ApiGatewayV2::Model::Authorizer::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 566 of file Authorizer.h.

◆ SetIdentityValidationExpression() [1/3]

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

The validation expression does not apply to the REQUEST authorizer.

Definition at line 702 of file Authorizer.h.

◆ SetIdentityValidationExpression() [2/3]

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

The validation expression does not apply to the REQUEST authorizer.

Definition at line 707 of file Authorizer.h.

◆ SetIdentityValidationExpression() [3/3]

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

The validation expression does not apply to the REQUEST authorizer.

Definition at line 712 of file Authorizer.h.

◆ SetJwtConfiguration() [1/2]

void Aws::ApiGatewayV2::Model::Authorizer::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 746 of file Authorizer.h.

◆ SetJwtConfiguration() [2/2]

void Aws::ApiGatewayV2::Model::Authorizer::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 752 of file Authorizer.h.

◆ SetName() [1/3]

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

The name of the authorizer.

Definition at line 780 of file Authorizer.h.

◆ SetName() [2/3]

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

The name of the authorizer.

Definition at line 785 of file Authorizer.h.

◆ SetName() [3/3]

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

The name of the authorizer.

Definition at line 790 of file Authorizer.h.

◆ WithAuthorizerCredentialsArn() [1/3]

Authorizer& Aws::ApiGatewayV2::Model::Authorizer::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 95 of file Authorizer.h.

◆ WithAuthorizerCredentialsArn() [2/3]

Authorizer& Aws::ApiGatewayV2::Model::Authorizer::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 104 of file Authorizer.h.

◆ WithAuthorizerCredentialsArn() [3/3]

Authorizer& Aws::ApiGatewayV2::Model::Authorizer::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 113 of file Authorizer.h.

◆ WithAuthorizerId() [1/3]

Authorizer& Aws::ApiGatewayV2::Model::Authorizer::WithAuthorizerId ( const Aws::String value)
inline

The authorizer identifier.

Definition at line 144 of file Authorizer.h.

◆ WithAuthorizerId() [2/3]

Authorizer& Aws::ApiGatewayV2::Model::Authorizer::WithAuthorizerId ( Aws::String &&  value)
inline

The authorizer identifier.

Definition at line 149 of file Authorizer.h.

◆ WithAuthorizerId() [3/3]

Authorizer& Aws::ApiGatewayV2::Model::Authorizer::WithAuthorizerId ( const char *  value)
inline

The authorizer identifier.

Definition at line 154 of file Authorizer.h.

◆ WithAuthorizerPayloadFormatVersion() [1/3]

Authorizer& Aws::ApiGatewayV2::Model::Authorizer::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 209 of file Authorizer.h.

◆ WithAuthorizerPayloadFormatVersion() [2/3]

Authorizer& Aws::ApiGatewayV2::Model::Authorizer::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 218 of file Authorizer.h.

◆ WithAuthorizerPayloadFormatVersion() [3/3]

Authorizer& Aws::ApiGatewayV2::Model::Authorizer::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 227 of file Authorizer.h.

◆ WithAuthorizerResultTtlInSeconds()

Authorizer& Aws::ApiGatewayV2::Model::Authorizer::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 260 of file Authorizer.h.

◆ WithAuthorizerType() [1/2]

Authorizer& Aws::ApiGatewayV2::Model::Authorizer::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 296 of file Authorizer.h.

◆ WithAuthorizerType() [2/2]

Authorizer& Aws::ApiGatewayV2::Model::Authorizer::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 303 of file Authorizer.h.

◆ WithAuthorizerUri() [1/3]

Authorizer& Aws::ApiGatewayV2::Model::Authorizer::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 400 of file Authorizer.h.

◆ WithAuthorizerUri() [2/3]

Authorizer& Aws::ApiGatewayV2::Model::Authorizer::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 416 of file Authorizer.h.

◆ WithAuthorizerUri() [3/3]

Authorizer& Aws::ApiGatewayV2::Model::Authorizer::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 432 of file Authorizer.h.

◆ WithEnableSimpleResponses()

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

Specifies whether a Lambda authorizer returns a response in a simple format. 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 469 of file Authorizer.h.

◆ WithIdentitySource() [1/2]

Authorizer& Aws::ApiGatewayV2::Model::Authorizer::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 590 of file Authorizer.h.

◆ WithIdentitySource() [2/2]

Authorizer& Aws::ApiGatewayV2::Model::Authorizer::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 614 of file Authorizer.h.

◆ WithIdentityValidationExpression() [1/3]

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

The validation expression does not apply to the REQUEST authorizer.

Definition at line 717 of file Authorizer.h.

◆ WithIdentityValidationExpression() [2/3]

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

The validation expression does not apply to the REQUEST authorizer.

Definition at line 722 of file Authorizer.h.

◆ WithIdentityValidationExpression() [3/3]

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

The validation expression does not apply to the REQUEST authorizer.

Definition at line 727 of file Authorizer.h.

◆ WithJwtConfiguration() [1/2]

Authorizer& Aws::ApiGatewayV2::Model::Authorizer::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 758 of file Authorizer.h.

◆ WithJwtConfiguration() [2/2]

Authorizer& Aws::ApiGatewayV2::Model::Authorizer::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 764 of file Authorizer.h.

◆ WithName() [1/3]

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

The name of the authorizer.

Definition at line 795 of file Authorizer.h.

◆ WithName() [2/3]

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

The name of the authorizer.

Definition at line 800 of file Authorizer.h.

◆ WithName() [3/3]

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

The name of the authorizer.

Definition at line 805 of file Authorizer.h.


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