Package software.amazon.awscdk.services.apigateway

Class CfnModel

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.core.Construct
software.amazon.awscdk.core.CfnElement
software.amazon.awscdk.core.CfnRefElement
software.amazon.awscdk.core.CfnResource
software.amazon.awscdk.services.apigateway.CfnModel
All Implemented Interfaces:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:44.835Z") @Stability(Stable) public class CfnModel extends CfnResource implements IInspectable
A CloudFormation AWS::ApiGateway::Model.

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();

  • 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 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 -
      • scoped id of the resource.
      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

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

    • getSchema

      @Stability(Stable) @NotNull public Object getSchema()
      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.

    • setSchema

      @Stability(Stable) public void setSchema(@NotNull Object value)
      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.

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

      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.

    • setName

      @Stability(Stable) public void setName(@Nullable String value)
      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.