Package software.amazon.awscdk.services.apigatewayv2

Interface CfnModelProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnModelProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2024-12-06T14:43:13.550Z")
@Stability(Stable)
public interface CfnModelProps
extends software.amazon.jsii.JsiiSerializable

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

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnModelProps.Builder	A builder for CfnModelProps
static final class	CfnModelProps.Jsii$Proxy	An implementation for CfnModelProps

Method Summary

Modifier and Type	Method	Description
static CfnModelProps.Builder	builder()
String	getApiId()	The API identifier.
default String	getContentType()	The content-type for the model, for example, "application/json".
default String	getDescription()	The description of the model.
String	getName()	The name of the model.
Object	getSchema()	The schema for the model.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getApiId

@Stability(Stable)
@NotNull
String getApiId()

The API identifier.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-model.html#cfn-apigatewayv2-model-apiid

getName

@Stability(Stable)
@NotNull
String getName()

The name of the model.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-model.html#cfn-apigatewayv2-model-name

getSchema

@Stability(Stable)
@NotNull
Object getSchema()

The schema for the model.

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-model.html#cfn-apigatewayv2-model-schema

getContentType

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

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-model.html#cfn-apigatewayv2-model-contenttype

getDescription

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

The description of the model.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-model.html#cfn-apigatewayv2-model-description

builder

@Stability(Stable)
static CfnModelProps.Builder builder()

Returns:

a CfnModelProps.Builder of CfnModelProps