AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Container for the parameters to the UpdateAuthorizer operation. Updates an Authorizer.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.ApiGatewayV2.AmazonApiGatewayV2Request
      Amazon.ApiGatewayV2.Model.UpdateAuthorizerRequest

Namespace: Amazon.ApiGatewayV2.Model
Assembly: AWSSDK.ApiGatewayV2.dll
Version: 3.x.y.z

Syntax

C#
public class UpdateAuthorizerRequest : AmazonApiGatewayV2Request
         IAmazonWebServiceRequest

The UpdateAuthorizerRequest type exposes the following members

Constructors

NameDescription
Public Method UpdateAuthorizerRequest()

Properties

NameTypeDescription
Public Property ApiId System.String

Gets and sets the property ApiId.

The API identifier.

Public Property AuthorizerCredentialsArn System.String

Gets and sets the property AuthorizerCredentialsArn.

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.

Public Property AuthorizerId System.String

Gets and sets the property AuthorizerId.

The authorizer identifier.

Public Property AuthorizerResultTtlInSeconds System.Int32

Gets and sets the property AuthorizerResultTtlInSeconds.

Authorizer caching is not currently supported. Don't specify this value for authorizers.

Public Property AuthorizerType Amazon.ApiGatewayV2.AuthorizerType

Gets and sets the property AuthorizerType.

The authorizer type. For WebSocket APIs, specify REQUEST for a Lambda function using incoming request parameters. For HTTP APIs, specify JWT to use JSON Web Tokens.

Public Property AuthorizerUri System.String

Gets and sets the property AuthorizerUri.

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:{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. Supported only for REQUEST authorizers.

Public Property IdentitySource System.Collections.Generic.List<System.String>

Gets and sets the property IdentitySource.

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. Currently, 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. These parameters will be 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 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".

Public Property IdentityValidationExpression System.String

Gets and sets the property IdentityValidationExpression.

This parameter is not used.

Public Property JwtConfiguration Amazon.ApiGatewayV2.Model.JWTConfiguration

Gets and sets the property JwtConfiguration.

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

Public Property Name System.String

Gets and sets the property Name.

The name of the authorizer.

Version Information

.NET Standard:
Supported in: 1.3

.NET Framework:
Supported in: 4.5, 4.0, 3.5

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms