CfnModelProps¶
-
class
aws_cdk.aws_apigateway.
CfnModelProps
(*, rest_api_id, content_type=None, description=None, name=None, schema=None)¶ Bases:
object
Properties for defining a
CfnModel
.- Parameters
rest_api_id (
str
) – The ID of a REST API with which to associate this model.content_type (
Optional
[str
]) – The content type for the model.description (
Optional
[str
]) – A description that identifies this model.name (
Optional
[str
]) – A name for the model. If you don’t specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the model name. For more information, see Name Type . .. epigraph:: If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.schema (
Optional
[Any
]) – The schema to use to transform data to one or more output formats. Specify null ({}
) if you don’t want to specify a schema.
- Link
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-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_apigateway as apigateway # schema: Any cfn_model_props = apigateway.CfnModelProps( rest_api_id="restApiId", # the properties below are optional content_type="contentType", description="description", name="name", schema=schema )
Attributes
-
content_type
¶ The content type for the model.
-
description
¶ A description that identifies this model.
-
name
¶ A name for the model.
If you don’t specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the model name. For more information, see Name Type . .. epigraph:
If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.
- Link
- Return type
Optional
[str
]
-
rest_api_id
¶ The ID of a REST API with which to associate this model.
-
schema
¶ The schema to use to transform data to one or more output formats.
Specify null (
{}
) if you don’t want to specify a schema.