software.amazon.awscdk.services.apigatewayv2

Interface CfnModelProps

All Known Implementing Classes:

CfnModelProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.73.0 (build 6faeda3)",
           date="2023-01-25T18:29:06.915Z")
public interface CfnModelProps

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.apigatewayv2.*;
 Object schema;
 CfnModelProps cfnModelProps = CfnModelProps.builder()
         .apiId("apiId")
         .name("name")
         .schema(schema)
         // the properties below are optional
         .contentType("contentType")
         .description("description")
         .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()
java.lang.String	getApiId() The API identifier.
default java.lang.String	getContentType() The content-type for the model, for example, "application/json".
default java.lang.String	getDescription() The description of the model.
java.lang.String	getName() The name of the model.
java.lang.Object	getSchema() The schema for the model.

Method Detail

getApiId

java.lang.String getApiId()

The API identifier.

getName

java.lang.String getName()

The name of the model.

getSchema

java.lang.Object getSchema()

The schema for the model.

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

getContentType

default java.lang.String getContentType()

The content-type for the model, for example, "application/json".

getDescription

default java.lang.String getDescription()

The description of the model.

builder

static CfnModelProps.Builder builder()

Returns:

a CfnModelProps.Builder of CfnModelProps