apigateway/aws.sdk.kotlin.services.apigateway.model/PutRestApiRequest

PutRestApiRequest

class PutRestApiRequest

A PUT request to update an existing API, with external API definitions specified as the request body.

Types

Builder

class Builder

Companion

object Companion

Properties

body

val body: ByteArray?

The PUT request body containing external API definitions. Currently, only OpenAPI definition JSON/YAML files are supported. The maximum size of the API definition file is 6MB.

failOnWarnings

val failOnWarnings: Boolean?

A query parameter to indicate whether to rollback the API update (true) or not (false) when a warning is encountered. The default value is false.

mode

val mode: PutMode?

The mode query parameter to specify the update mode. Valid values are "merge" and "overwrite". By default, the update mode is "merge".

parameters

val parameters: Map<String, String>?

Custom header parameters as part of the request. For example, to exclude DocumentationParts from an imported API, set ignore=documentation as a parameters value, as in the AWS CLI command of aws apigateway import-rest-api --parameters ignore=documentation --body 'file:///path/to/imported-api-body.json'.

restApiId

val restApiId: String?

The string identifier of the associated RestApi.

Functions

copy

inline fun copy(block: PutRestApiRequest.Builder.() -> Unit = {}): PutRestApiRequest

equals

open operator override fun equals(other: Any?): Boolean

hashCode

open override fun hashCode(): Int

toString

open override fun toString(): String