Class Route

Manages an Amazon API Gateway Version 2 route. More information can be found in the Amazon API Gateway Developer Guide.

Example Usage

Basic

using Pulumi;
using Aws = Pulumi.Aws;

class MyStack : Stack
{
public MyStack()
{
    var example = new Aws.ApiGatewayV2.Route("example", new Aws.ApiGatewayV2.RouteArgs
    {
        ApiId = aws_apigatewayv2_api.Example.Id,
        RouteKey = "$$default",
    });
}

}

Inheritance

System.Object

Resource

CustomResource

Route

Inherited Members

CustomResource.Id

Resource.GetResourceType()

Resource.GetResourceName()

Resource.Urn

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 class Route : CustomResource

Constructors

Route(String, RouteArgs, CustomResourceOptions)

Create a Route resource with the given unique name, arguments, and options.

Declaration

public Route(string name, RouteArgs args, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resource
RouteArgs	args	The arguments used to populate this resource's properties
CustomResourceOptions	options	A bag of options that control this resource's behavior

Properties

ApiId

The API identifier.

Declaration

public Output<string> ApiId { get; }

Property Value

Type	Description
Output<System.String>

ApiKeyRequired

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

Declaration

public Output<bool?> ApiKeyRequired { get; }

Property Value

Type	Description
Output<System.Nullable<System.Boolean>>

AuthorizationScopes

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

Declaration

public Output<ImmutableArray<string>> AuthorizationScopes { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableArray<System.String>>

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 Output<string> AuthorizationType { get; }

Property Value

Type	Description
Output<System.String>

AuthorizerId

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

Declaration

public Output<string> AuthorizerId { get; }

Property Value

Type	Description
Output<System.String>

ModelSelectionExpression

The model selection expression for the route.

Declaration

public Output<string> ModelSelectionExpression { get; }

Property Value

Type	Description
Output<System.String>

OperationName

The operation name for the route.

Declaration

public Output<string> OperationName { get; }

Property Value

Type	Description
Output<System.String>

RequestModels

The request models for the route.

Declaration

public Output<ImmutableDictionary<string, string>> RequestModels { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableDictionary<System.String, System.String>>

RouteKey

The route key for the route.

Declaration

public Output<string> RouteKey { get; }

Property Value

Type	Description
Output<System.String>

RouteResponseSelectionExpression

The route response selection expression for the route.

Declaration

public Output<string> RouteResponseSelectionExpression { get; }

Property Value

Type	Description
Output<System.String>

Target

The target for the route.

Declaration

public Output<string> Target { get; }

Property Value

Type	Description
Output<System.String>

Methods

Get(String, Input<String>, RouteState, CustomResourceOptions)

Get an existing Route resource's state with the given name, ID, and optional extra properties used to qualify the lookup.

Declaration

public static Route Get(string name, Input<string> id, RouteState state = null, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resulting resource.
Input<System.String>	id	The unique provider ID of the resource to lookup.
RouteState	state	Any extra arguments used during the lookup.
CustomResourceOptions	options	A bag of options that control this resource's behavior

Returns

Type	Description
Route