Class RouteArgs

Inheritance
System.Object
InputArgs
ResourceArgs
RouteArgs
Inherited Members
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 RouteArgs : ResourceArgs

Constructors

View Source

RouteArgs()

Declaration
public RouteArgs()

Properties

View Source

ApiId

The API identifier.

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

ApiKeyRequired

Boolean whether an API key is required for the route. Defaults to false.

Declaration
public Input<bool> ApiKeyRequired { get; set; }
Property Value
Type Description
Input<System.Boolean>
View Source

AuthorizationScopes

The authorization scopes supported by this route. The scopes are used with a JWT authorizer to authorize the method invocation.

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

AuthorizationType

The authorization type for the route. For WebSocket APIs, valid values are NONE for open access, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a Lambda authorizer. For HTTP APIs, valid values are NONE for open access, or JWT for using JSON Web Tokens. Defaults to NONE.

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

AuthorizerId

The identifier of the aws.apigatewayv2.Authorizer resource to be associated with this route, if the authorizationType is CUSTOM.

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

ModelSelectionExpression

The model selection expression for the route.

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

OperationName

The operation name for the route.

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

RequestModels

The request models for the route.

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

RouteKey

The route key for the route.

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

RouteResponseSelectionExpression

The route response selection expression for the route.

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

Target

The target for the route.

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