CfnModelPropsMixin
- class aws_cdk.mixins_preview.aws_apigateway.mixins.CfnModelPropsMixin(props, *, strategy=None)
Bases:
MixinThe
AWS::ApiGateway::Modelresource defines the structure of a request or response payload for an API method.- See:
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-model.html
- CloudformationResource:
AWS::ApiGateway::Model
- Mixin:
true
- 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 import mixins from aws_cdk.mixins_preview.aws_apigateway import mixins as apigateway_mixins # schema: Any cfn_model_props_mixin = apigateway_mixins.CfnModelPropsMixin(apigateway_mixins.CfnModelMixinProps( content_type="contentType", description="description", name="name", rest_api_id="restApiId", schema=schema ), strategy=mixins.PropertyMergeStrategy.OVERRIDE )
Create a mixin to apply properties to
AWS::ApiGateway::Model.- Parameters:
props (
Union[CfnModelMixinProps,Dict[str,Any]]) – L1 properties to apply.strategy (
Optional[PropertyMergeStrategy]) – (experimental) Strategy for merging nested properties. Default: - PropertyMergeStrategy.MERGE
Methods
- apply_to(construct)
Apply the mixin properties to the construct.
- Parameters:
construct (
IConstruct)- Return type:
- supports(construct)
Check if this mixin supports the given construct.
- Parameters:
construct (
IConstruct)- Return type:
bool
Attributes
- CFN_PROPERTY_KEYS = ['contentType', 'description', 'name', 'restApiId', 'schema']
Static Methods
- classmethod is_mixin(x)
(experimental) Checks if
xis a Mixin.- Parameters:
x (
Any) – Any object.- Return type:
bool- Returns:
true if
xis an object created from a class which extendsMixin.- Stability:
experimental