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

#include <UpdateAuthorizerResult.h>

Public Member Functions

 UpdateAuthorizerResult ()
 
 UpdateAuthorizerResult (const Aws::AmazonWebServiceResult< Aws::Utils::Json::JsonValue > &result)
 
UpdateAuthorizerResultoperator= (const Aws::AmazonWebServiceResult< Aws::Utils::Json::JsonValue > &result)
 
const Aws::StringGetId () const
 
void SetId (const Aws::String &value)
 
void SetId (Aws::String &&value)
 
void SetId (const char *value)
 
UpdateAuthorizerResultWithId (const Aws::String &value)
 
UpdateAuthorizerResultWithId (Aws::String &&value)
 
UpdateAuthorizerResultWithId (const char *value)
 
const Aws::StringGetName () const
 
void SetName (const Aws::String &value)
 
void SetName (Aws::String &&value)
 
void SetName (const char *value)
 
UpdateAuthorizerResultWithName (const Aws::String &value)
 
UpdateAuthorizerResultWithName (Aws::String &&value)
 
UpdateAuthorizerResultWithName (const char *value)
 
const AuthorizerTypeGetType () const
 
void SetType (const AuthorizerType &value)
 
void SetType (AuthorizerType &&value)
 
UpdateAuthorizerResultWithType (const AuthorizerType &value)
 
UpdateAuthorizerResultWithType (AuthorizerType &&value)
 
const Aws::Vector< Aws::String > & GetProviderARNs () const
 
void SetProviderARNs (const Aws::Vector< Aws::String > &value)
 
void SetProviderARNs (Aws::Vector< Aws::String > &&value)
 
UpdateAuthorizerResultWithProviderARNs (const Aws::Vector< Aws::String > &value)
 
UpdateAuthorizerResultWithProviderARNs (Aws::Vector< Aws::String > &&value)
 
UpdateAuthorizerResultAddProviderARNs (const Aws::String &value)
 
UpdateAuthorizerResultAddProviderARNs (Aws::String &&value)
 
UpdateAuthorizerResultAddProviderARNs (const char *value)
 
const Aws::StringGetAuthType () const
 
void SetAuthType (const Aws::String &value)
 
void SetAuthType (Aws::String &&value)
 
void SetAuthType (const char *value)
 
UpdateAuthorizerResultWithAuthType (const Aws::String &value)
 
UpdateAuthorizerResultWithAuthType (Aws::String &&value)
 
UpdateAuthorizerResultWithAuthType (const char *value)
 
const Aws::StringGetAuthorizerUri () const
 
void SetAuthorizerUri (const Aws::String &value)
 
void SetAuthorizerUri (Aws::String &&value)
 
void SetAuthorizerUri (const char *value)
 
UpdateAuthorizerResultWithAuthorizerUri (const Aws::String &value)
 
UpdateAuthorizerResultWithAuthorizerUri (Aws::String &&value)
 
UpdateAuthorizerResultWithAuthorizerUri (const char *value)
 
const Aws::StringGetAuthorizerCredentials () const
 
void SetAuthorizerCredentials (const Aws::String &value)
 
void SetAuthorizerCredentials (Aws::String &&value)
 
void SetAuthorizerCredentials (const char *value)
 
UpdateAuthorizerResultWithAuthorizerCredentials (const Aws::String &value)
 
UpdateAuthorizerResultWithAuthorizerCredentials (Aws::String &&value)
 
UpdateAuthorizerResultWithAuthorizerCredentials (const char *value)
 
const Aws::StringGetIdentitySource () const
 
void SetIdentitySource (const Aws::String &value)
 
void SetIdentitySource (Aws::String &&value)
 
void SetIdentitySource (const char *value)
 
UpdateAuthorizerResultWithIdentitySource (const Aws::String &value)
 
UpdateAuthorizerResultWithIdentitySource (Aws::String &&value)
 
UpdateAuthorizerResultWithIdentitySource (const char *value)
 
const Aws::StringGetIdentityValidationExpression () const
 
void SetIdentityValidationExpression (const Aws::String &value)
 
void SetIdentityValidationExpression (Aws::String &&value)
 
void SetIdentityValidationExpression (const char *value)
 
UpdateAuthorizerResultWithIdentityValidationExpression (const Aws::String &value)
 
UpdateAuthorizerResultWithIdentityValidationExpression (Aws::String &&value)
 
UpdateAuthorizerResultWithIdentityValidationExpression (const char *value)
 
int GetAuthorizerResultTtlInSeconds () const
 
void SetAuthorizerResultTtlInSeconds (int value)
 
UpdateAuthorizerResultWithAuthorizerResultTtlInSeconds (int value)
 

Detailed Description

Represents an authorization layer for methods. If enabled on a method, API Gateway will activate the authorizer when a client calls the method.

See Also:

AWS API Reference

Definition at line 40 of file UpdateAuthorizerResult.h.

Constructor & Destructor Documentation

◆ UpdateAuthorizerResult() [1/2]

Aws::APIGateway::Model::UpdateAuthorizerResult::UpdateAuthorizerResult ( )

◆ UpdateAuthorizerResult() [2/2]

Aws::APIGateway::Model::UpdateAuthorizerResult::UpdateAuthorizerResult ( const Aws::AmazonWebServiceResult< Aws::Utils::Json::JsonValue > &  result)

Member Function Documentation

◆ AddProviderARNs() [1/3]

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

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

Definition at line 222 of file UpdateAuthorizerResult.h.

◆ AddProviderARNs() [2/3]

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

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

Definition at line 213 of file UpdateAuthorizerResult.h.

◆ AddProviderARNs() [3/3]

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

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

Definition at line 231 of file UpdateAuthorizerResult.h.

◆ GetAuthorizerCredentials()

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

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

Definition at line 389 of file UpdateAuthorizerResult.h.

◆ GetAuthorizerResultTtlInSeconds()

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

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

Definition at line 700 of file UpdateAuthorizerResult.h.

◆ GetAuthorizerUri()

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

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

Definition at line 290 of file UpdateAuthorizerResult.h.

◆ GetAuthType()

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

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

Definition at line 238 of file UpdateAuthorizerResult.h.

◆ GetId()

const Aws::String& Aws::APIGateway::Model::UpdateAuthorizerResult::GetId ( ) const
inline

The identifier for the authorizer resource.

Definition at line 51 of file UpdateAuthorizerResult.h.

◆ GetIdentitySource()

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

The identity source for which authorization is requested.

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

Definition at line 462 of file UpdateAuthorizerResult.h.

◆ GetIdentityValidationExpression()

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

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

Definition at line 619 of file UpdateAuthorizerResult.h.

◆ GetName()

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

[Required] The name of the authorizer.

Definition at line 87 of file UpdateAuthorizerResult.h.

◆ GetProviderARNs()

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

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

Definition at line 168 of file UpdateAuthorizerResult.h.

◆ GetType()

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

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

Definition at line 126 of file UpdateAuthorizerResult.h.

◆ operator=()

UpdateAuthorizerResult& Aws::APIGateway::Model::UpdateAuthorizerResult::operator= ( const Aws::AmazonWebServiceResult< Aws::Utils::Json::JsonValue > &  result)

◆ SetAuthorizerCredentials() [1/3]

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

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

Definition at line 405 of file UpdateAuthorizerResult.h.

◆ SetAuthorizerCredentials() [2/3]

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

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

Definition at line 397 of file UpdateAuthorizerResult.h.

◆ SetAuthorizerCredentials() [3/3]

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

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

Definition at line 413 of file UpdateAuthorizerResult.h.

◆ SetAuthorizerResultTtlInSeconds()

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

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

Definition at line 708 of file UpdateAuthorizerResult.h.

◆ SetAuthorizerUri() [1/3]

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

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

Definition at line 320 of file UpdateAuthorizerResult.h.

◆ SetAuthorizerUri() [2/3]

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

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

Definition at line 305 of file UpdateAuthorizerResult.h.

◆ SetAuthorizerUri() [3/3]

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

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

Definition at line 335 of file UpdateAuthorizerResult.h.

◆ SetAuthType() [1/3]

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

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

Definition at line 250 of file UpdateAuthorizerResult.h.

◆ SetAuthType() [2/3]

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

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

Definition at line 244 of file UpdateAuthorizerResult.h.

◆ SetAuthType() [3/3]

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

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

Definition at line 256 of file UpdateAuthorizerResult.h.

◆ SetId() [1/3]

void Aws::APIGateway::Model::UpdateAuthorizerResult::SetId ( Aws::String &&  value)
inline

The identifier for the authorizer resource.

Definition at line 61 of file UpdateAuthorizerResult.h.

◆ SetId() [2/3]

void Aws::APIGateway::Model::UpdateAuthorizerResult::SetId ( const Aws::String value)
inline

The identifier for the authorizer resource.

Definition at line 56 of file UpdateAuthorizerResult.h.

◆ SetId() [3/3]

void Aws::APIGateway::Model::UpdateAuthorizerResult::SetId ( const char *  value)
inline

The identifier for the authorizer resource.

Definition at line 66 of file UpdateAuthorizerResult.h.

◆ SetIdentitySource() [1/3]

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

The identity source for which authorization is requested.

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

Definition at line 510 of file UpdateAuthorizerResult.h.

◆ SetIdentitySource() [2/3]

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

The identity source for which authorization is requested.

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

Definition at line 486 of file UpdateAuthorizerResult.h.

◆ SetIdentitySource() [3/3]

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

The identity source for which authorization is requested.

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

Definition at line 534 of file UpdateAuthorizerResult.h.

◆ SetIdentityValidationExpression() [1/3]

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

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

Definition at line 643 of file UpdateAuthorizerResult.h.

◆ SetIdentityValidationExpression() [2/3]

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

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

Definition at line 631 of file UpdateAuthorizerResult.h.

◆ SetIdentityValidationExpression() [3/3]

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

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

Definition at line 655 of file UpdateAuthorizerResult.h.

◆ SetName() [1/3]

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

[Required] The name of the authorizer.

Definition at line 97 of file UpdateAuthorizerResult.h.

◆ SetName() [2/3]

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

[Required] The name of the authorizer.

Definition at line 92 of file UpdateAuthorizerResult.h.

◆ SetName() [3/3]

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

[Required] The name of the authorizer.

Definition at line 102 of file UpdateAuthorizerResult.h.

◆ SetProviderARNs() [1/2]

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

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

Definition at line 186 of file UpdateAuthorizerResult.h.

◆ SetProviderARNs() [2/2]

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

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

Definition at line 177 of file UpdateAuthorizerResult.h.

◆ SetType() [1/2]

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

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

Definition at line 142 of file UpdateAuthorizerResult.h.

◆ SetType() [2/2]

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

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

Definition at line 134 of file UpdateAuthorizerResult.h.

◆ WithAuthorizerCredentials() [1/3]

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

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

Definition at line 429 of file UpdateAuthorizerResult.h.

◆ WithAuthorizerCredentials() [2/3]

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

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

Definition at line 421 of file UpdateAuthorizerResult.h.

◆ WithAuthorizerCredentials() [3/3]

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

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

Definition at line 437 of file UpdateAuthorizerResult.h.

◆ WithAuthorizerResultTtlInSeconds()

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

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

Definition at line 716 of file UpdateAuthorizerResult.h.

◆ WithAuthorizerUri() [1/3]

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

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

Definition at line 365 of file UpdateAuthorizerResult.h.

◆ WithAuthorizerUri() [2/3]

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

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

Definition at line 350 of file UpdateAuthorizerResult.h.

◆ WithAuthorizerUri() [3/3]

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

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

Definition at line 380 of file UpdateAuthorizerResult.h.

◆ WithAuthType() [1/3]

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

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

Definition at line 268 of file UpdateAuthorizerResult.h.

◆ WithAuthType() [2/3]

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

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

Definition at line 262 of file UpdateAuthorizerResult.h.

◆ WithAuthType() [3/3]

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

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

Definition at line 274 of file UpdateAuthorizerResult.h.

◆ WithId() [1/3]

UpdateAuthorizerResult& Aws::APIGateway::Model::UpdateAuthorizerResult::WithId ( Aws::String &&  value)
inline

The identifier for the authorizer resource.

Definition at line 76 of file UpdateAuthorizerResult.h.

◆ WithId() [2/3]

UpdateAuthorizerResult& Aws::APIGateway::Model::UpdateAuthorizerResult::WithId ( const Aws::String value)
inline

The identifier for the authorizer resource.

Definition at line 71 of file UpdateAuthorizerResult.h.

◆ WithId() [3/3]

UpdateAuthorizerResult& Aws::APIGateway::Model::UpdateAuthorizerResult::WithId ( const char *  value)
inline

The identifier for the authorizer resource.

Definition at line 81 of file UpdateAuthorizerResult.h.

◆ WithIdentitySource() [1/3]

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

The identity source for which authorization is requested.

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

Definition at line 582 of file UpdateAuthorizerResult.h.

◆ WithIdentitySource() [2/3]

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

The identity source for which authorization is requested.

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

Definition at line 558 of file UpdateAuthorizerResult.h.

◆ WithIdentitySource() [3/3]

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

The identity source for which authorization is requested.

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

Definition at line 606 of file UpdateAuthorizerResult.h.

◆ WithIdentityValidationExpression() [1/3]

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

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

Definition at line 679 of file UpdateAuthorizerResult.h.

◆ WithIdentityValidationExpression() [2/3]

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

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

Definition at line 667 of file UpdateAuthorizerResult.h.

◆ WithIdentityValidationExpression() [3/3]

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

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

Definition at line 691 of file UpdateAuthorizerResult.h.

◆ WithName() [1/3]

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

[Required] The name of the authorizer.

Definition at line 112 of file UpdateAuthorizerResult.h.

◆ WithName() [2/3]

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

[Required] The name of the authorizer.

Definition at line 107 of file UpdateAuthorizerResult.h.

◆ WithName() [3/3]

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

[Required] The name of the authorizer.

Definition at line 117 of file UpdateAuthorizerResult.h.

◆ WithProviderARNs() [1/2]

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

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

Definition at line 204 of file UpdateAuthorizerResult.h.

◆ WithProviderARNs() [2/2]

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

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

Definition at line 195 of file UpdateAuthorizerResult.h.

◆ WithType() [1/2]

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

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

Definition at line 158 of file UpdateAuthorizerResult.h.

◆ WithType() [2/2]

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

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

Definition at line 150 of file UpdateAuthorizerResult.h.


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