CfnModelMixinProps

class aws_cdk.mixins_preview.aws_apigatewayv2.mixins.CfnModelMixinProps(*, api_id=None, content_type=None, description=None, name=None, schema=None)

Bases: object

Properties for CfnModelPropsMixin.

Parameters:
  • api_id (Optional[str]) – The API identifier.

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

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

  • name (Optional[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.

See:

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.
from aws_cdk.mixins_preview.aws_apigatewayv2 import mixins as apigatewayv2_mixins

# schema: Any

cfn_model_mixin_props = apigatewayv2_mixins.CfnModelMixinProps(
    api_id="apiId",
    content_type="contentType",
    description="description",
    name="name",
    schema=schema
)

Attributes

api_id

The API identifier.

See:

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

content_type

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

See:

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

description

The description of the model.

See:

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

name

The name of the model.

See:

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

schema

The schema for the model.

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

See:

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