[ aws . apigatewayv2 ]

create-route

Description

Creates a Route for an API.

See also: AWS API Documentation

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>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]

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, JWT for using JSON Web Tokens, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a Lambda authorizer.

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. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

• json
• text
• table
• yaml
• yaml-stream

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

• on
• off
• auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

• base64
• raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

Examples

Note

To use the following examples, you must have the AWS CLI installed and configured. See the Getting started guide in the AWS CLI User Guide for more information.

Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal’s quoting rules. See Using quotation marks with strings in the AWS CLI User Guide .

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, JWT for using JSON Web Tokens, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a Lambda authorizer.

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)

The target for the route.