Class AuthorizerState
Inherited Members
Namespace: Pulumi.Aws.ApiGatewayV2
Assembly: Pulumi.Aws.dll
Syntax
public sealed class AuthorizerState : ResourceArgs
Constructors
View SourceAuthorizerState()
Declaration
public AuthorizerState()
Properties
View SourceApiId
The API identifier.
Declaration
public Input<string> ApiId { get; set; }
Property Value
| Type | Description |
|---|---|
| Input<System.String> |
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> |
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> |
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> |
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> |
JwtConfiguration
The configuration of a JWT authorizer. Required for the JWT authorizer type.
Supported only for HTTP APIs.
Declaration
public Input<AuthorizerJwtConfigurationGetArgs> JwtConfiguration { get; set; }
Property Value
| Type | Description |
|---|---|
| Input<AuthorizerJwtConfigurationGetArgs> |
Name
The name of the authorizer.
Declaration
public Input<string> Name { get; set; }
Property Value
| Type | Description |
|---|---|
| Input<System.String> |