CfnRouteResponseMixinProps

class aws_cdk.mixins_preview.aws_apigatewayv2.mixins.CfnRouteResponseMixinProps(*, api_id=None, model_selection_expression=None, response_models=None, response_parameters=None, route_id=None, route_response_key=None)

Bases: object

Properties for CfnRouteResponsePropsMixin.

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

  • model_selection_expression (Optional[str]) – The model selection expression for the route response. Supported only for WebSocket APIs.

  • response_models (Any) – The response models for the route response.

  • response_parameters (Union[IResolvable, Mapping[str, Union[IResolvable, ParameterConstraintsProperty, Dict[str, Any]]], None]) – The route response parameters.

  • route_id (Optional[str]) – The route ID.

  • route_response_key (Optional[str]) – The route response key.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-routeresponse.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

# response_models: Any

cfn_route_response_mixin_props = apigatewayv2_mixins.CfnRouteResponseMixinProps(
    api_id="apiId",
    model_selection_expression="modelSelectionExpression",
    response_models=response_models,
    response_parameters={
        "response_parameters_key": apigatewayv2_mixins.CfnRouteResponsePropsMixin.ParameterConstraintsProperty(
            required=False
        )
    },
    route_id="routeId",
    route_response_key="routeResponseKey"
)

Attributes

api_id

The API identifier.

See:

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

model_selection_expression

The model selection expression for the route response.

Supported only for WebSocket APIs.

See:

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

response_models

The response models for the route response.

See:

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

response_parameters

The route response parameters.

See:

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

route_id

The route ID.

See:

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

route_response_key

The route response key.

See:

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