software.amazon.awscdk.services.apigateway

Interface CfnModelProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnModelProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:36.128Z")
 @Stability(value=Stable)
public interface CfnModelProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a `CfnModel`.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.apigateway.*;
 Object schema;
 CfnModelProps cfnModelProps = CfnModelProps.builder()
         .restApiId("restApiId")
         // the properties below are optional
         .contentType("contentType")
         .description("description")
         .name("name")
         .schema(schema)
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CfnModelProps.Builder A builder for CfnModelProps
static class	CfnModelProps.Jsii$Proxy An implementation for CfnModelProps

Method Summary

Modifier and Type	Method and Description
static CfnModelProps.Builder	builder()
default String	getContentType() The content type for the model.
default String	getDescription() A description that identifies this model.
default String	getName() A name for the model.
String	getRestApiId() The ID of a REST API with which to associate this model.
default Object	getSchema() The schema to use to transform data to one or more output formats.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getRestApiId

@Stability(value=Stable)
 @NotNull
String getRestApiId()

The ID of a REST API with which to associate this model.

getContentType

@Stability(value=Stable)
 @Nullable
default String getContentType()

The content type for the model.

getDescription

@Stability(value=Stable)
 @Nullable
default String getDescription()

A description that identifies this model.

getName

@Stability(value=Stable)
 @Nullable
default String getName()

A name for the model.

If you don't specify a name, AWS CloudFormation 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.

getSchema

@Stability(value=Stable)
 @Nullable
default Object getSchema()

The schema to use to transform data to one or more output formats.

Specify null ( {} ) if you don't want to specify a schema.

builder

@Stability(value=Stable)
static CfnModelProps.Builder builder()

Returns:

a CfnModelProps.Builder of CfnModelProps