Builder

class Builder

Properties

Link copied to clipboard

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.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

The description of the RestApi.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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.

Link copied to clipboard
var name: String?

The name of the RestApi.

Link copied to clipboard

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

Link copied to clipboard

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.

Link copied to clipboard

A version identifier for the API.