software.amazon.awscdk.services.apigatewayv2

Class CfnModel

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.apigatewayv2.CfnModel

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:36.280Z")
 @Stability(value=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();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnModel.Builder A fluent builder for CfnModel.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnModel(software.constructs.Construct scope, String id, CfnModelProps props) Create a new `AWS::ApiGatewayV2::Model`.
protected	CfnModel(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnModel(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
String	getApiId() The API identifier.
protected Map<String,Object>	getCfnProperties()
String	getContentType() The content-type for the model, for example, "application/json".
String	getDescription() The description of the model.
String	getName() The name of the model.
Object	getSchema() The schema for the model.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setApiId(String value) The API identifier.
void	setContentType(String value) The content-type for the model, for example, "application/json".
void	setDescription(String value) The description of the model.
void	setName(String value) The name of the model.
void	setSchema(Object value) The schema for the model.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnModel

protected CfnModel(software.amazon.jsii.JsiiObjectRef objRef)

CfnModel

protected CfnModel(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnModel

@Stability(value=Stable)
public CfnModel(@NotNull
                                         software.constructs.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 Detail

inspect

@Stability(value=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(value=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(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getApiId

@Stability(value=Stable)
 @NotNull
public String getApiId()

The API identifier.

setApiId

@Stability(value=Stable)
public void setApiId(@NotNull
                                              String value)

The API identifier.

getName

@Stability(value=Stable)
 @NotNull
public String getName()

The name of the model.

setName

@Stability(value=Stable)
public void setName(@NotNull
                                             String value)

The name of the model.

getSchema

@Stability(value=Stable)
 @NotNull
public Object getSchema()

The schema for the model.

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

setSchema

@Stability(value=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(value=Stable)
 @Nullable
public String getContentType()

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

setContentType

@Stability(value=Stable)
public void setContentType(@Nullable
                                                    String value)

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

getDescription

@Stability(value=Stable)
 @Nullable
public String getDescription()

The description of the model.

setDescription

@Stability(value=Stable)
public void setDescription(@Nullable
                                                    String value)

The description of the model.