aws apigateway create-rest-api
Creates a new RestApi resource
Options
| Name | Description |
|---|---|
--name <string> | [Required] The name of the RestApi |
--description <string> | The description of the RestApi |
--clone-from <string> | The ID of the RestApi that you want to clone from |
--binary-media-types <list> | The list of binary media types supported by the RestApi. By default, the RestApi supports only UTF-8-encoded text payloads |
--minimum-compression-size <integer> | A nullable integer that is used to enable compression (with non-negative between 0 and 10485760 (10M) bytes, inclusive) or disable compression (with a null value) on an API. When compression is enabled, compression or decompression is not applied on the payload if the payload size is smaller than this value. Setting it to zero allows compression for any payload size |
--api-key-source <string> | The source of the API key for metering requests according to a usage plan. Valid values are: HEADER to read the API key from the X-API-Key header of a request. AUTHORIZER to read the API key from the UsageIdentifierKey from a custom authorizer |
--endpoint-configuration <structure> | The endpoint configuration of this RestApi showing the endpoint types of the API |
--policy <string> | A stringified JSON policy document that applies to this RestApi regardless of the caller and Method configuration |
--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 |
--disable-execute-api-endpoint | Specifies whether clients can invoke your API by using the default execute-api endpoint. By default, clients can invoke your API with the default https://{api_id}.execute-api.{region}.amazonaws.com endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint |
--no-disable-execute-api-endpoint | Specifies whether clients can invoke your API by using the default execute-api endpoint. By default, clients can invoke your API with the default https://{api_id}.execute-api.{region}.amazonaws.com endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint |
--api-version <string> | A version identifier for the API |
--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 |