apigateway_create_rest_api: Creates a new RestApi resource

View source: R/apigateway_operations.R

apigateway_create_rest_apiR Documentation

Creates a new RestApi resource


Creates a new RestApi resource.

See https://www.paws-r-sdk.com/docs/apigateway_create_rest_api/ for full documentation.


  description = NULL,
  version = NULL,
  cloneFrom = NULL,
  binaryMediaTypes = NULL,
  minimumCompressionSize = NULL,
  apiKeySource = NULL,
  endpointConfiguration = NULL,
  policy = NULL,
  tags = NULL,
  disableExecuteApiEndpoint = NULL



[required] The name of the RestApi.


The description of the RestApi.


A version identifier for the API.


The ID of the RestApi that you want to clone from.


The list of binary media types supported by the RestApi. By default, the RestApi supports only UTF-8-encoded text payloads.


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.


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.


The endpoint configuration of this RestApi showing the endpoint types of the API.


A stringified JSON policy document that applies to this RestApi regardless of the caller and Method configuration.


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.


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

paws.networking documentation built on May 29, 2024, 10:12 a.m.