AWS SDK for C++  1.9.129
AWS SDK for C++
Public Member Functions | List of all members
Aws::AppSync::Model::LambdaAuthorizerConfig Class Reference

#include <LambdaAuthorizerConfig.h>

Public Member Functions

 LambdaAuthorizerConfig ()
 
 LambdaAuthorizerConfig (Aws::Utils::Json::JsonView jsonValue)
 
LambdaAuthorizerConfigoperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
int GetAuthorizerResultTtlInSeconds () const
 
bool AuthorizerResultTtlInSecondsHasBeenSet () const
 
void SetAuthorizerResultTtlInSeconds (int value)
 
LambdaAuthorizerConfigWithAuthorizerResultTtlInSeconds (int value)
 
const Aws::StringGetAuthorizerUri () const
 
bool AuthorizerUriHasBeenSet () const
 
void SetAuthorizerUri (const Aws::String &value)
 
void SetAuthorizerUri (Aws::String &&value)
 
void SetAuthorizerUri (const char *value)
 
LambdaAuthorizerConfigWithAuthorizerUri (const Aws::String &value)
 
LambdaAuthorizerConfigWithAuthorizerUri (Aws::String &&value)
 
LambdaAuthorizerConfigWithAuthorizerUri (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)
 
LambdaAuthorizerConfigWithIdentityValidationExpression (const Aws::String &value)
 
LambdaAuthorizerConfigWithIdentityValidationExpression (Aws::String &&value)
 
LambdaAuthorizerConfigWithIdentityValidationExpression (const char *value)
 

Detailed Description

A LambdaAuthorizerConfig holds configuration on how to authorize AppSync API access when using the AWS_LAMBDA authorizer mode. Be aware that an AppSync API may have only one Lambda authorizer configured at a time.

See Also:

AWS API Reference

Definition at line 34 of file LambdaAuthorizerConfig.h.

Constructor & Destructor Documentation

◆ LambdaAuthorizerConfig() [1/2]

Aws::AppSync::Model::LambdaAuthorizerConfig::LambdaAuthorizerConfig ( )

◆ LambdaAuthorizerConfig() [2/2]

Aws::AppSync::Model::LambdaAuthorizerConfig::LambdaAuthorizerConfig ( Aws::Utils::Json::JsonView  jsonValue)

Member Function Documentation

◆ AuthorizerResultTtlInSecondsHasBeenSet()

bool Aws::AppSync::Model::LambdaAuthorizerConfig::AuthorizerResultTtlInSecondsHasBeenSet ( ) const
inline

The number of seconds a response should be cached for. The default is 5 minutes (300 seconds). The Lambda function can override this by returning a ttlOverride key in its response. A value of 0 disables caching of responses.

Definition at line 57 of file LambdaAuthorizerConfig.h.

◆ AuthorizerUriHasBeenSet()

bool Aws::AppSync::Model::LambdaAuthorizerConfig::AuthorizerUriHasBeenSet ( ) const
inline

The ARN of the Lambda function to be called for authorization. This may be a standard Lambda ARN, a version ARN (.../v3) or alias ARN.

Note: This Lambda function must have the following resource-based policy assigned to it. When configuring Lambda authorizers in the Console, this is done for you. To do so with the Amazon Web Services CLI, run the following:

aws lambda add-permission –function-name "arn:aws:lambda:us-east-2:111122223333:function:my-function" –statement-id "appsync" –principal appsync.amazonaws.com –action lambda:InvokeFunction

Definition at line 100 of file LambdaAuthorizerConfig.h.

◆ GetAuthorizerResultTtlInSeconds()

int Aws::AppSync::Model::LambdaAuthorizerConfig::GetAuthorizerResultTtlInSeconds ( ) const
inline

The number of seconds a response should be cached for. The default is 5 minutes (300 seconds). The Lambda function can override this by returning a ttlOverride key in its response. A value of 0 disables caching of responses.

Definition at line 49 of file LambdaAuthorizerConfig.h.

◆ GetAuthorizerUri()

const Aws::String& Aws::AppSync::Model::LambdaAuthorizerConfig::GetAuthorizerUri ( ) const
inline

The ARN of the Lambda function to be called for authorization. This may be a standard Lambda ARN, a version ARN (.../v3) or alias ARN.

Note: This Lambda function must have the following resource-based policy assigned to it. When configuring Lambda authorizers in the Console, this is done for you. To do so with the Amazon Web Services CLI, run the following:

aws lambda add-permission –function-name "arn:aws:lambda:us-east-2:111122223333:function:my-function" –statement-id "appsync" –principal appsync.amazonaws.com –action lambda:InvokeFunction

Definition at line 87 of file LambdaAuthorizerConfig.h.

◆ GetIdentityValidationExpression()

const Aws::String& Aws::AppSync::Model::LambdaAuthorizerConfig::GetIdentityValidationExpression ( ) const
inline

A regular expression for validation of tokens before the Lambda function is called.

Definition at line 185 of file LambdaAuthorizerConfig.h.

◆ IdentityValidationExpressionHasBeenSet()

bool Aws::AppSync::Model::LambdaAuthorizerConfig::IdentityValidationExpressionHasBeenSet ( ) const
inline

A regular expression for validation of tokens before the Lambda function is called.

Definition at line 191 of file LambdaAuthorizerConfig.h.

◆ Jsonize()

Aws::Utils::Json::JsonValue Aws::AppSync::Model::LambdaAuthorizerConfig::Jsonize ( ) const

◆ operator=()

LambdaAuthorizerConfig& Aws::AppSync::Model::LambdaAuthorizerConfig::operator= ( Aws::Utils::Json::JsonView  jsonValue)

◆ SetAuthorizerResultTtlInSeconds()

void Aws::AppSync::Model::LambdaAuthorizerConfig::SetAuthorizerResultTtlInSeconds ( int  value)
inline

The number of seconds a response should be cached for. The default is 5 minutes (300 seconds). The Lambda function can override this by returning a ttlOverride key in its response. A value of 0 disables caching of responses.

Definition at line 65 of file LambdaAuthorizerConfig.h.

◆ SetAuthorizerUri() [1/3]

void Aws::AppSync::Model::LambdaAuthorizerConfig::SetAuthorizerUri ( Aws::String &&  value)
inline

The ARN of the Lambda function to be called for authorization. This may be a standard Lambda ARN, a version ARN (.../v3) or alias ARN.

Note: This Lambda function must have the following resource-based policy assigned to it. When configuring Lambda authorizers in the Console, this is done for you. To do so with the Amazon Web Services CLI, run the following:

aws lambda add-permission –function-name "arn:aws:lambda:us-east-2:111122223333:function:my-function" –statement-id "appsync" –principal appsync.amazonaws.com –action lambda:InvokeFunction

Definition at line 126 of file LambdaAuthorizerConfig.h.

◆ SetAuthorizerUri() [2/3]

void Aws::AppSync::Model::LambdaAuthorizerConfig::SetAuthorizerUri ( const Aws::String value)
inline

The ARN of the Lambda function to be called for authorization. This may be a standard Lambda ARN, a version ARN (.../v3) or alias ARN.

Note: This Lambda function must have the following resource-based policy assigned to it. When configuring Lambda authorizers in the Console, this is done for you. To do so with the Amazon Web Services CLI, run the following:

aws lambda add-permission –function-name "arn:aws:lambda:us-east-2:111122223333:function:my-function" –statement-id "appsync" –principal appsync.amazonaws.com –action lambda:InvokeFunction

Definition at line 113 of file LambdaAuthorizerConfig.h.

◆ SetAuthorizerUri() [3/3]

void Aws::AppSync::Model::LambdaAuthorizerConfig::SetAuthorizerUri ( const char *  value)
inline

The ARN of the Lambda function to be called for authorization. This may be a standard Lambda ARN, a version ARN (.../v3) or alias ARN.

Note: This Lambda function must have the following resource-based policy assigned to it. When configuring Lambda authorizers in the Console, this is done for you. To do so with the Amazon Web Services CLI, run the following:

aws lambda add-permission –function-name "arn:aws:lambda:us-east-2:111122223333:function:my-function" –statement-id "appsync" –principal appsync.amazonaws.com –action lambda:InvokeFunction

Definition at line 139 of file LambdaAuthorizerConfig.h.

◆ SetIdentityValidationExpression() [1/3]

void Aws::AppSync::Model::LambdaAuthorizerConfig::SetIdentityValidationExpression ( Aws::String &&  value)
inline

A regular expression for validation of tokens before the Lambda function is called.

Definition at line 203 of file LambdaAuthorizerConfig.h.

◆ SetIdentityValidationExpression() [2/3]

void Aws::AppSync::Model::LambdaAuthorizerConfig::SetIdentityValidationExpression ( const Aws::String value)
inline

A regular expression for validation of tokens before the Lambda function is called.

Definition at line 197 of file LambdaAuthorizerConfig.h.

◆ SetIdentityValidationExpression() [3/3]

void Aws::AppSync::Model::LambdaAuthorizerConfig::SetIdentityValidationExpression ( const char *  value)
inline

A regular expression for validation of tokens before the Lambda function is called.

Definition at line 209 of file LambdaAuthorizerConfig.h.

◆ WithAuthorizerResultTtlInSeconds()

LambdaAuthorizerConfig& Aws::AppSync::Model::LambdaAuthorizerConfig::WithAuthorizerResultTtlInSeconds ( int  value)
inline

The number of seconds a response should be cached for. The default is 5 minutes (300 seconds). The Lambda function can override this by returning a ttlOverride key in its response. A value of 0 disables caching of responses.

Definition at line 73 of file LambdaAuthorizerConfig.h.

◆ WithAuthorizerUri() [1/3]

LambdaAuthorizerConfig& Aws::AppSync::Model::LambdaAuthorizerConfig::WithAuthorizerUri ( Aws::String &&  value)
inline

The ARN of the Lambda function to be called for authorization. This may be a standard Lambda ARN, a version ARN (.../v3) or alias ARN.

Note: This Lambda function must have the following resource-based policy assigned to it. When configuring Lambda authorizers in the Console, this is done for you. To do so with the Amazon Web Services CLI, run the following:

aws lambda add-permission –function-name "arn:aws:lambda:us-east-2:111122223333:function:my-function" –statement-id "appsync" –principal appsync.amazonaws.com –action lambda:InvokeFunction

Definition at line 165 of file LambdaAuthorizerConfig.h.

◆ WithAuthorizerUri() [2/3]

LambdaAuthorizerConfig& Aws::AppSync::Model::LambdaAuthorizerConfig::WithAuthorizerUri ( const Aws::String value)
inline

The ARN of the Lambda function to be called for authorization. This may be a standard Lambda ARN, a version ARN (.../v3) or alias ARN.

Note: This Lambda function must have the following resource-based policy assigned to it. When configuring Lambda authorizers in the Console, this is done for you. To do so with the Amazon Web Services CLI, run the following:

aws lambda add-permission –function-name "arn:aws:lambda:us-east-2:111122223333:function:my-function" –statement-id "appsync" –principal appsync.amazonaws.com –action lambda:InvokeFunction

Definition at line 152 of file LambdaAuthorizerConfig.h.

◆ WithAuthorizerUri() [3/3]

LambdaAuthorizerConfig& Aws::AppSync::Model::LambdaAuthorizerConfig::WithAuthorizerUri ( const char *  value)
inline

The ARN of the Lambda function to be called for authorization. This may be a standard Lambda ARN, a version ARN (.../v3) or alias ARN.

Note: This Lambda function must have the following resource-based policy assigned to it. When configuring Lambda authorizers in the Console, this is done for you. To do so with the Amazon Web Services CLI, run the following:

aws lambda add-permission –function-name "arn:aws:lambda:us-east-2:111122223333:function:my-function" –statement-id "appsync" –principal appsync.amazonaws.com –action lambda:InvokeFunction

Definition at line 178 of file LambdaAuthorizerConfig.h.

◆ WithIdentityValidationExpression() [1/3]

LambdaAuthorizerConfig& Aws::AppSync::Model::LambdaAuthorizerConfig::WithIdentityValidationExpression ( Aws::String &&  value)
inline

A regular expression for validation of tokens before the Lambda function is called.

Definition at line 221 of file LambdaAuthorizerConfig.h.

◆ WithIdentityValidationExpression() [2/3]

LambdaAuthorizerConfig& Aws::AppSync::Model::LambdaAuthorizerConfig::WithIdentityValidationExpression ( const Aws::String value)
inline

A regular expression for validation of tokens before the Lambda function is called.

Definition at line 215 of file LambdaAuthorizerConfig.h.

◆ WithIdentityValidationExpression() [3/3]

LambdaAuthorizerConfig& Aws::AppSync::Model::LambdaAuthorizerConfig::WithIdentityValidationExpression ( const char *  value)
inline

A regular expression for validation of tokens before the Lambda function is called.

Definition at line 227 of file LambdaAuthorizerConfig.h.


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