ModelOptions

class aws_cdk.aws_apigateway.ModelOptions(*, schema, content_type=None, description=None, model_name=None)

Bases: object

__init__(*, schema, content_type=None, description=None, model_name=None)
Parameters
  • schema (JsonSchema) – The schema to use to transform data to one or more output formats. Specify null ({}) if you don’t want to specify a schema.

  • content_type (Optional[str]) – The content type for the model. You can also force a content type in the request or response model mapping. Default: -

  • description (Optional[str]) – A description that identifies this model. Default: None

  • model_name (Optional[str]) – A name for the model. Important 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. Default: 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.

Attributes

content_type

The content type for the model.

You can also force a content type in the request or response model mapping.

default :default: -

Return type

Optional[str]

description

A description that identifies this model.

default :default: None

Return type

Optional[str]

model_name

A name for the model.

Important 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.

default :default:

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.

Return type

Optional[str]

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.

Return type

JsonSchema