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, IEnvironmentAware, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.121.0 (build d7af9b9)", date="2025-12-18T18:20:04.121Z") @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:

  • 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)
      Create a new AWS::ApiGateway::Model.

      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

    • isCfnModel

      @Stability(Stable) @NotNull public static Boolean isCfnModel(@NotNull Object x)
      Checks whether the given object is a CfnModel.

      Parameters:
      x - This parameter is required.

    • 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.