CfnModelProps

class aws_cdk.aws_apigatewayv2.CfnModelProps(*, api_id, name, schema, content_type=None, description=None)

Bases: object

Properties for defining a CfnModel.

Parameters
  • api_id (str) – The API identifier.

  • name (str) – The name of the model.

  • schema (Any) – The schema for the model. For application/json models, this should be JSON schema draft 4 model.

  • content_type (Optional[str]) – The content-type for the model, for example, “application/json”.

  • description (Optional[str]) – The description of the model.

Link

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

ExampleMetadata

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_apigatewayv2 as apigatewayv2

# schema: Any

cfn_model_props = apigatewayv2.CfnModelProps(
    api_id="apiId",
    name="name",
    schema=schema,

    # the properties below are optional
    content_type="contentType",
    description="description"
)

Attributes

api_id

The API identifier.

Link

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

Return type

str

content_type

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

Link

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

Return type

Optional[str]

description

The description of the model.

Link

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

Return type

Optional[str]

name

The name of the model.

Link

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

Return type

str

schema

The schema for the model.

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

Link

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

Return type

Any