Skip to content

Create Rest Api

apigateway_create_rest_api R Documentation

Creates a new RestApi resource

Description

Creates a new RestApi resource.

Usage

apigateway_create_rest_api(name, description, version, cloneFrom,
  binaryMediaTypes, minimumCompressionSize, apiKeySource,
  endpointConfiguration, policy, tags, disableExecuteApiEndpoint)

Arguments

name

[required] The name of the RestApi.

description

The description of the RestApi.

version

A version identifier for the API.

cloneFrom

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

binaryMediaTypes

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

minimumCompressionSize

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.

apiKeySource

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.

endpointConfiguration

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

policy

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

tags

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.

disableExecuteApiEndpoint

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

Value

A list with the following syntax: 

list(
  id = "string",
  name = "string",
  description = "string",
  createdDate = as.POSIXct(
    "2015-01-01"
  ),
  version = "string",
  warnings = list(
    "string"
  ),
  binaryMediaTypes = list(
    "string"
  ),
  minimumCompressionSize = 123,
  apiKeySource = "HEADER"|"AUTHORIZER",
  endpointConfiguration = list(
    types = list(
      "REGIONAL"|"EDGE"|"PRIVATE"
    ),
    vpcEndpointIds = list(
      "string"
    )
  ),
  policy = "string",
  tags = list(
    "string"
  ),
  disableExecuteApiEndpoint = TRUE|FALSE,
  rootResourceId = "string"
)

Request syntax

svc$create_rest_api(
  name = "string",
  description = "string",
  version = "string",
  cloneFrom = "string",
  binaryMediaTypes = list(
    "string"
  ),
  minimumCompressionSize = 123,
  apiKeySource = "HEADER"|"AUTHORIZER",
  endpointConfiguration = list(
    types = list(
      "REGIONAL"|"EDGE"|"PRIVATE"
    ),
    vpcEndpointIds = list(
      "string"
    )
  ),
  policy = "string",
  tags = list(
    "string"
  ),
  disableExecuteApiEndpoint = TRUE|FALSE
)