Package software.amazon.awscdk.services.apigatewayv2

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.apigatewayv2.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:43.217Z") @Stability(Stable) public class CfnModel extends CfnResource implements IInspectable
A CloudFormation AWS::ApiGatewayV2::Model.

The AWS::ApiGatewayV2::Model resource updates data model for a WebSocket API. For more information, see Model Selection Expressions in the API Gateway Developer Guide .

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.apigatewayv2.*;
 Object schema;
 CfnModel cfnModel = CfnModel.Builder.create(this, "MyCfnModel")
         .apiId("apiId")
         .name("name")
         .schema(schema)
         // the properties below are optional
         .contentType("contentType")
         .description("description")
         .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::ApiGatewayV2::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.

    • getAttrModelId

      @Stability(Stable) @NotNull public String getAttrModelId()
      The model ID.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getApiId

      @Stability(Stable) @NotNull public String getApiId()
      The API identifier.

    • setApiId

      @Stability(Stable) public void setApiId(@NotNull String value)
      The API identifier.

    • getName

      @Stability(Stable) @NotNull public String getName()
      The name of the model.

    • setName

      @Stability(Stable) public void setName(@NotNull String value)
      The name of the model.

    • getSchema

      @Stability(Stable) @NotNull public Object getSchema()
      The schema for the model.

      For application/json models, this should be JSON schema draft 4 model.

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

    • getContentType

      @Stability(Stable) @Nullable public String getContentType()
      The content-type for the model, for example, "application/json".

    • setContentType

      @Stability(Stable) public void setContentType(@Nullable String value)
      The content-type for the model, for example, "application/json".

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