CreateApiResponse

Types

Link copied to clipboard
class Builder
Link copied to clipboard
object Companion

Properties

Link copied to clipboard

The URI of the API, of the form {api-id}.execute-api.{region}.amazonaws.com. The stage name is typically appended to this URI to form a complete path to a deployed API stage.

Link copied to clipboard

Specifies whether an API is managed by API Gateway. You can't update or delete a managed API by using API Gateway. A managed API can be deleted only through the tooling or service that created it.

Link copied to clipboard

The API ID.

Link copied to clipboard

An API key selection expression. Supported only for WebSocket APIs. See API Key Selection Expressions.

Link copied to clipboard

A CORS configuration. Supported only for HTTP APIs.

Link copied to clipboard

The timestamp when the API was created.

Link copied to clipboard

The description of the API.

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

Avoid validating models when creating a deployment. Supported only for WebSocket APIs.

Link copied to clipboard

The validation information during API import. This may include particular properties of your OpenAPI definition which are ignored during import. Supported only for HTTP APIs.

Link copied to clipboard

The IP address types that can invoke the API.

Link copied to clipboard
val name: String?

The name of the API.

Link copied to clipboard

The API protocol.

Link copied to clipboard

The route selection expression for the API. For HTTP APIs, the routeSelectionExpression must be

${request.method} $

{request.path}. If not provided, this will be the default for HTTP APIs. This property is required for WebSocket APIs.

Link copied to clipboard

A collection of tags associated with the API.

Link copied to clipboard

A version identifier for the API.

Link copied to clipboard

The warning messages reported when failonwarnings is turned on during API import.

Functions

Link copied to clipboard
inline fun copy(block: CreateApiResponse.Builder.() -> Unit = {}): CreateApiResponse
Link copied to clipboard
open operator override fun equals(other: Any?): Boolean
Link copied to clipboard
open override fun hashCode(): Int
Link copied to clipboard
open override fun toString(): String