pulumi-aws-native-kotlin/com.pulumi.awsnative.apigateway.kotlin/ModelArgs

ModelArgs

data class ModelArgs(val contentType: Output<String>? = null, val description: Output<String>? = null, val name: Output<String>? = null, val restApiId: Output<String>? = null, val schema: Output<Any>? = null) : ConvertibleToJava<ModelArgs>

/* /* The `AWS::ApiGateway::Model` resource defines the structure of a request or response payload for an API method.

Constructors

ModelArgs

constructor(contentType: Output<String>? = null, description: Output<String>? = null, name: Output<String>? = null, restApiId: Output<String>? = null, schema: Output<Any>? = null)

Properties

contentType

val contentType: Output<String>? = null

The content-type for the model.

description

val description: Output<String>? = null

The description of the model.

name

val name: Output<String>? = null

A name for the model. If you don't specify a name, CFN generates a unique physical ID and uses that ID for the model name. For more information, see Name Type. If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.

restApiId

val restApiId: Output<String>? = null

The string identifier of the associated RestApi.

schema

val schema: Output<Any>? = null

The schema for the model. For application/json models, this should be JSON schema draft 4 model. Do not include "\*/" characters in the description of any properties because such "\*/" characters may be interpreted as the closing marker for comments in some languages, such as Java or JavaScript, causing the installation of your API's SDK generated by API Gateway to fail. Search the CloudFormation User Guide for AWS::ApiGateway::Model for more information about the expected schema for this property.

Functions

toJava

open override fun toJava(): ModelArgs