Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

[ aws . apigatewayv2 ]

create-stage

Description

Creates a Stage for an API.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  create-stage
[--access-log-settings <value>]
--api-id <value>
[--client-certificate-id <value>]
[--default-route-settings <value>]
[--deployment-id <value>]
[--description <value>]
[--route-settings <value>]
--stage-name <value>
[--stage-variables <value>]
[--tags <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--access-log-settings (structure)

Settings for logging access in this stage.

Shorthand Syntax:

DestinationArn=string,Format=string

JSON Syntax:

{
  "DestinationArn": "string",
  "Format": "string"
}

--api-id (string)

The API identifier.

--client-certificate-id (string)

The identifier of a client certificate for a Stage.

--default-route-settings (structure)

The default route settings for the stage.

Shorthand Syntax:

DataTraceEnabled=boolean,DetailedMetricsEnabled=boolean,LoggingLevel=string,ThrottlingBurstLimit=integer,ThrottlingRateLimit=double

JSON Syntax:

{
  "DataTraceEnabled": true|false,
  "DetailedMetricsEnabled": true|false,
  "LoggingLevel": "ERROR"|"INFO"|"false",
  "ThrottlingBurstLimit": integer,
  "ThrottlingRateLimit": double
}

--deployment-id (string)

The deployment identifier of the API stage.

--description (string)

The description for the API stage.

--route-settings (map)

Route settings for the stage.

Shorthand Syntax:

KeyName1=DataTraceEnabled=boolean,DetailedMetricsEnabled=boolean,LoggingLevel=string,ThrottlingBurstLimit=integer,ThrottlingRateLimit=double,KeyName2=DataTraceEnabled=boolean,DetailedMetricsEnabled=boolean,LoggingLevel=string,ThrottlingBurstLimit=integer,ThrottlingRateLimit=double

JSON Syntax:

{"string": {
      "DataTraceEnabled": true|false,
      "DetailedMetricsEnabled": true|false,
      "LoggingLevel": "ERROR"|"INFO"|"false",
      "ThrottlingBurstLimit": integer,
      "ThrottlingRateLimit": double
    }
  ...}

--stage-name (string)

The name of the stage.

--stage-variables (map)

A map that defines the stage variables for a Stage. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+.

Shorthand Syntax:

KeyName1=string,KeyName2=string

JSON Syntax:

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

--tags (map)

The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws:. The tag value can be up to 256 characters..

Shorthand Syntax:

KeyName1=string,KeyName2=string

JSON Syntax:

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

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI 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.

--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. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.

Output

AccessLogSettings -> (structure)

Settings for logging access in this stage.

DestinationArn -> (string)

The ARN of the CloudWatch Logs log group to receive access logs.

Format -> (string)

A single line format of the access logs of data, as specified by selected $context variables. The format must include at least $context.requestId.

ClientCertificateId -> (string)

The identifier of a client certificate for a Stage.

CreatedDate -> (timestamp)

The timestamp when the stage was created.

DefaultRouteSettings -> (structure)

Default route settings for the stage.

DataTraceEnabled -> (boolean)

Specifies whether (true) or not (false) data trace logging is enabled for this route. This property affects the log entries pushed to Amazon CloudWatch Logs.

DetailedMetricsEnabled -> (boolean)

Specifies whether detailed metrics are enabled.

LoggingLevel -> (string)

Specifies the logging level for this route: DEBUG, INFO, or WARN. This property affects the log entries pushed to Amazon CloudWatch Logs.

ThrottlingBurstLimit -> (integer)

Specifies the throttling burst limit.

ThrottlingRateLimit -> (double)

Specifies the throttling rate limit.

DeploymentId -> (string)

The identifier of the Deployment that the Stage is associated with.

Description -> (string)

The description of the stage.

LastUpdatedDate -> (timestamp)

The timestamp when the stage was last updated.

RouteSettings -> (map)

Route settings for the stage.

key -> (string)

value -> (structure)

Represents a collection of route settings.

DataTraceEnabled -> (boolean)

Specifies whether (true) or not (false) data trace logging is enabled for this route. This property affects the log entries pushed to Amazon CloudWatch Logs.

DetailedMetricsEnabled -> (boolean)

Specifies whether detailed metrics are enabled.

LoggingLevel -> (string)

Specifies the logging level for this route: DEBUG, INFO, or WARN. This property affects the log entries pushed to Amazon CloudWatch Logs.

ThrottlingBurstLimit -> (integer)

Specifies the throttling burst limit.

ThrottlingRateLimit -> (double)

Specifies the throttling rate limit.

StageName -> (string)

The name of the stage.

StageVariables -> (map)

A map that defines the stage variables for a stage resource. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+.

key -> (string)

value -> (string)

A string with a length between [0-2048].

Tags -> (map)

The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws:. The tag value can be up to 256 characters..

key -> (string)

value -> (string)

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