Class CfnModel
A CloudFormation AWS::ApiGatewayV2::Model
.
Inherited Members
Namespace: Amazon.CDK.AWS.APIGatewayv2
Assembly: Amazon.CDK.AWS.APIGatewayv2.dll
Syntax (csharp)
public class CfnModel : CfnResource, IConstruct, IDependable, IInspectable
Syntax (vb)
Public Class CfnModel
Inherits CfnResource
Implements IConstruct, IDependable, IInspectable
Remarks
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 .
CloudformationResource: AWS::ApiGatewayV2::Model
Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-model.html
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.APIGatewayv2;
var schema;
var cfnModel = new CfnModel(this, "MyCfnModel", new CfnModelProps {
ApiId = "apiId",
Name = "name",
Schema = schema,
// the properties below are optional
ContentType = "contentType",
Description = "description"
});
Synopsis
Constructors
CfnModel(Construct, String, ICfnModelProps) | Create a new |
CfnModel(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnModel(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
Properties
ApiId | The API identifier. |
AttrModelId | The model ID. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
ContentType | The content-type for the model, for example, "application/json". |
Description | The description of the model. |
Name | The name of the model. |
Schema | The schema for the model. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnModel(Construct, String, ICfnModelProps)
Create a new AWS::ApiGatewayV2::Model
.
public CfnModel(Construct scope, string id, ICfnModelProps props)
Parameters
- scope Construct
- scope in which this resource is defined.
- id System.String
- scoped id of the resource.
- props ICfnModelProps
- resource properties.
CfnModel(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnModel(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnModel(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnModel(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
Properties
ApiId
The API identifier.
public virtual string ApiId { get; set; }
Property Value
System.String
Remarks
AttrModelId
The model ID.
public virtual string AttrModelId { get; }
Property Value
System.String
Remarks
CloudformationAttribute: ModelId
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
ContentType
The content-type for the model, for example, "application/json".
public virtual string ContentType { get; set; }
Property Value
System.String
Remarks
Description
The description of the model.
public virtual string Description { get; set; }
Property Value
System.String
Remarks
Name
The name of the model.
public virtual string Name { get; set; }
Property Value
System.String
Remarks
Schema
The schema for the model.
public virtual object Schema { get; set; }
Property Value
System.Object
Remarks
For application/json models, this should be JSON schema draft 4 model.
Methods
Inspect(TreeInspector)
Examines the CloudFormation resource and discloses attributes.
public virtual void Inspect(TreeInspector inspector)
Parameters
- inspector TreeInspector
- tree inspector to collect and process attributes.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>