Package software.amazon.awscdk.services.apigateway

Class CfnModel

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.apigateway.CfnModel

All Implemented Interfaces:

IInspectable, IModelRef, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.116.0 (build 0eddcff)",
           date="2025-10-29T11:15:31.435Z")
@Stability(Stable)
public class CfnModel
extends CfnResource
implements IInspectable, IModelRef

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

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;
 CfnModel cfnModel = CfnModel.Builder.create(this, "MyCfnModel")
         .restApiId("restApiId")
         // the properties below are optional
         .contentType("contentType")
         .description("description")
         .name("name")
         .schema(schema)
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-model.html

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	CfnModel.Builder	A fluent builder for CfnModel.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.apigateway.IModelRef

IModelRef.Jsii$Default, IModelRef.Jsii$Proxy

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CfnModel(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnModel(software.amazon.jsii.JsiiObjectRef objRef)
	CfnModel(software.constructs.Construct scope, String id, CfnModelProps props)

Method Summary

Modifier and Type	Method	Description
protected Map<String,Object>	getCfnProperties()
String	getContentType()	The content-type for the model.
String	getDescription()	The description of the model.
ModelReference	getModelRef()	A reference to a Model resource.
String	getName()	A name for the model.
String	getRestApiId()	The string identifier of the associated RestApi.
Object	getSchema()	The schema for the model.
void	inspect(TreeInspector inspector)	Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setContentType(String value)	The content-type for the model.
void	setDescription(String value)	The description of the model.
void	setName(String value)	A name for the model.
void	setRestApiId(String value)	The string identifier of the associated RestApi.
void	setSchema(Object value)	The schema for the model.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.constructs.IConstruct

getNode

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Details

CFN_RESOURCE_TYPE_NAME

@Stability(Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Details

CfnModel

protected CfnModel(software.amazon.jsii.JsiiObjectRef objRef)

CfnModel

protected CfnModel(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnModel

@Stability(Stable)
public CfnModel(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 CfnModelProps props)

Parameters:

scope - Scope in which this resource is defined. This parameter is required.

id - Construct identifier for this resource (unique in its scope). This parameter is required.

props - Resource properties. This parameter is required.

Method Details

inspect

@Stability(Stable)
public void inspect(@NotNull
 TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(Stable)
@NotNull
protected Map<String,Object> renderProperties(@NotNull
 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getCfnProperties

@Stability(Stable)
@NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getModelRef

@Stability(Stable)
@NotNull
public ModelReference getModelRef()

A reference to a Model resource.

Specified by:

getModelRef in interface IModelRef

getRestApiId

@Stability(Stable)
@NotNull
public String getRestApiId()

The string identifier of the associated RestApi.

setRestApiId

@Stability(Stable)
public void setRestApiId(@NotNull
 String value)

The string identifier of the associated RestApi.

getContentType

@Stability(Stable)
@Nullable
public String getContentType()

The content-type for the model.

setContentType

@Stability(Stable)
public void setContentType(@Nullable
 String value)

The content-type for the model.

getDescription

@Stability(Stable)
@Nullable
public String getDescription()

The description of the model.

setDescription

@Stability(Stable)
public void setDescription(@Nullable
 String value)

The description of the model.

getName

@Stability(Stable)
@Nullable
public String getName()

A name for the model.

setName

@Stability(Stable)
public void setName(@Nullable
 String value)

A name for the model.

getSchema

@Stability(Stable)
@Nullable
public Object getSchema()

The schema for the model.

setSchema

@Stability(Stable)
public void setSchema(@Nullable
 Object value)

The schema for the model.