Show / Hide Table of Contents

Class AuthorizerArgs

Inheritance
System.Object
InputArgs
ResourceArgs
AuthorizerArgs
Inherited Members
ResourceArgs.Empty
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: Pulumi.Aws.ApiGatewayV2
Assembly: Pulumi.Aws.dll
Syntax
public sealed class AuthorizerArgs : ResourceArgs

Constructors

View Source

AuthorizerArgs()

Declaration
public AuthorizerArgs()

Properties

View Source

ApiId

The API identifier.

Declaration
public Input<string> ApiId { get; set; }
Property Value
Type Description
Input<System.String>
View Source

AuthorizerCredentialsArn

The required credentials as an IAM role for API Gateway to invoke the authorizer. Supported only for REQUEST authorizers.

Declaration
public Input<string> AuthorizerCredentialsArn { get; set; }
Property Value
Type Description
Input<System.String>
View Source

AuthorizerType

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

Declaration
public Input<string> AuthorizerType { get; set; }
Property Value
Type Description
Input<System.String>
View Source

AuthorizerUri

The authorizer's Uniform Resource Identifier (URI). For REQUEST authorizers this must be a well-formed Lambda function URI, such as the invoke_arn attribute of the aws.lambda.Function resource. Supported only for REQUEST authorizers.

Declaration
public Input<string> AuthorizerUri { get; set; }
Property Value
Type Description
Input<System.String>
View Source

IdentitySources

The identity sources for which authorization is requested. For REQUEST authorizers the value is a list of one or more mapping expressions of the specified request parameters. For JWT authorizers the single entry specifies where to extract the JSON Web Token (JWT) from inbound requests.

Declaration
public InputList<string> IdentitySources { get; set; }
Property Value
Type Description
InputList<System.String>
View Source

JwtConfiguration

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

Declaration
public Input<AuthorizerJwtConfigurationArgs> JwtConfiguration { get; set; }
Property Value
Type Description
Input<AuthorizerJwtConfigurationArgs>
View Source

Name

The name of the authorizer.

Declaration
public Input<string> Name { get; set; }
Property Value
Type Description
Input<System.String>
  • View Source
Back to top Copyright 2016-2020, Pulumi Corporation.