Package software.amazon.awscdk.cfnpropertymixins.services.apigatewayv2

Interface CfnModelMixinProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnModelMixinProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)",
           date="2026-03-11T13:19:55.533Z")
@Stability(Stable)
public interface CfnModelMixinProps
extends software.amazon.jsii.JsiiSerializable

Properties for CfnModelPropsMixin.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.cfnpropertymixins.services.apigatewayv2.*;
 Object schema;
 CfnModelMixinProps cfnModelMixinProps = CfnModelMixinProps.builder()
         .apiId("apiId")
         .contentType("contentType")
         .description("description")
         .name("name")
         .schema(schema)
         .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	CfnModelMixinProps.Builder	A builder for CfnModelMixinProps
static final class	CfnModelMixinProps.Jsii$Proxy	An implementation for CfnModelMixinProps

Method Summary

Modifier and Type	Method	Description
static CfnModelMixinProps.Builder	builder()
default Object	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.
default String	getName()	The name of the model.
default Object	getSchema()	The schema for the model.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getApiId

@Stability(Stable)
@Nullable
default Object getApiId()

The API identifier.

Returns union: either String or IApiRef

See Also:

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

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

getName

@Stability(Stable)
@Nullable
default 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)
@Nullable
default 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

builder

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

Returns:

a CfnModelMixinProps.Builder of CfnModelMixinProps