create-route¶

Description¶

Creates a Route for an API.

Synopsis¶

  create-route
--api-id <value>
[--api-key-required | --no-api-key-required]
[--authorization-scopes <value>]
[--authorization-type <value>]
[--authorizer-id <value>]
[--model-selection-expression <value>]
[--operation-name <value>]
[--request-models <value>]
[--request-parameters <value>]
--route-key <value>
[--route-response-selection-expression <value>]
[--target <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--cli-auto-prompt <value>]

Options¶

--api-id (string)

The API identifier.

--api-key-required | --no-api-key-required (boolean)

Specifies whether an API key is required for the route. Supported only for WebSocket APIs.

--authorization-scopes (list)

The authorization scopes supported by this route.

(string)

A string with a length between [1-64].

Syntax:

"string" "string" ...

--authorization-type (string)

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.

Possible values:

NONE

AWS_IAM

CUSTOM

JWT

--authorizer-id (string)

The identifier of the Authorizer resource to be associated with this route. The authorizer identifier is generated by API Gateway when you created the authorizer.

--model-selection-expression (string)

The model selection expression for the route. Supported only for WebSocket APIs.

--operation-name (string)

The operation name for the route.

--request-models (map)

The request models for the route. Supported only for WebSocket APIs.

key -> (string)

value -> (string)

A string with a length between [1-128].

Shorthand Syntax:

KeyName1=string,KeyName2=string

JSON Syntax:

{"string": "string"
  ...}

--request-parameters (map)

The request parameters for the route. Supported only for WebSocket APIs.

key -> (string)

value -> (structure)

Validation constraints imposed on parameters of a request (path, query string, headers).

Required -> (boolean)

Whether or not the parameter is required.

Shorthand Syntax:

KeyName1=Required=boolean,KeyName2=Required=boolean

JSON Syntax:

{"string": {
      "Required": true|false
    }
  ...}

--route-key (string)

The route key for the route.

--route-response-selection-expression (string)

The route response selection expression for the route. Supported only for WebSocket APIs.

--target (string)

The target for the route.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

--cli-auto-prompt (boolean) Automatically prompt for CLI input parameters.

See ‘aws help’ for descriptions of global parameters.

Examples¶

To create a $default route for a WebSocket or HTTP API

The following create-route example creates a $default route for a WebSocket or HTTP API.

aws apigatewayv2 create-route \
    --api-id aabbccddee \
    --route-key '$default'

Output:

{
    "ApiKeyRequired": false,
    "AuthorizationType": "NONE",
    "RouteKey": "$default",
    "RouteId": "1122334"
}

For more information, see Working with routes for WebSocket APIs in the Amazon API Gateway Developer Guide

To create a route for an HTTP API

The following create-route example creates a route named signup that accepts POST requests.

aws apigatewayv2 create-route \
    --api-id aabbccddee \
    --route-key 'POST /signup'

Output:

{
    "ApiKeyRequired": false,
    "AuthorizationType": "NONE",
    "RouteKey": "POST /signup",
    "RouteId": "1122334"
}

For more information, see Working with routes for HTTP APIs in the Amazon API Gateway Developer Guide

Output¶

ApiGatewayManaged -> (boolean)

Specifies whether a route is managed by API Gateway. If you created an API using quick create, the $default route is managed by API Gateway. You can’t modify the $default route key.

ApiKeyRequired -> (boolean)

Specifies whether an API key is required for this route. Supported only for WebSocket APIs.

AuthorizationScopes -> (list)

A list of authorization scopes configured on a route. The scopes are used with a JWT authorizer to authorize the method invocation. The authorization works by matching the route scopes against the scopes parsed from the access token in the incoming request. The method invocation is authorized if any route scope matches a claimed scope in the access token. Otherwise, the invocation is not authorized. When the route scope is configured, the client must provide an access token instead of an identity token for authorization purposes.

(string)

A string with a length between [1-64].

AuthorizationType -> (string)

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.

AuthorizerId -> (string)

The identifier of the Authorizer resource to be associated with this route. The authorizer identifier is generated by API Gateway when you created the authorizer.

ModelSelectionExpression -> (string)

The model selection expression for the route. Supported only for WebSocket APIs.

OperationName -> (string)

The operation name for the route.

RequestModels -> (map)

The request models for the route. Supported only for WebSocket APIs.

key -> (string)

value -> (string)

A string with a length between [1-128].

RequestParameters -> (map)

The request parameters for the route. Supported only for WebSocket APIs.

key -> (string)

value -> (structure)

Validation constraints imposed on parameters of a request (path, query string, headers).

Required -> (boolean)

Whether or not the parameter is required.

RouteId -> (string)

The route ID.

RouteKey -> (string)

The route key for the route.

RouteResponseSelectionExpression -> (string)

The route response selection expression for the route. Supported only for WebSocket APIs.

Target -> (string)