CfnRouteResponsePropsMixin

class aws_cdk.mixins_preview.aws_apigatewayv2.mixins.CfnRouteResponsePropsMixin(props, *, strategy=None)

Bases: Mixin

The AWS::ApiGatewayV2::RouteResponse resource creates a route response for a WebSocket API.

For more information, see Set up Route Responses for a WebSocket API in API Gateway in the API Gateway Developer Guide .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-routeresponse.html
CloudformationResource:: AWS::ApiGatewayV2::RouteResponse
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_apigatewayv2 import mixins as apigatewayv2_mixins

# response_models: Any

cfn_route_response_props_mixin = apigatewayv2_mixins.CfnRouteResponsePropsMixin(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"
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

Create a mixin to apply properties to AWS::ApiGatewayV2::RouteResponse.

Parameters:

props (Union[CfnRouteResponseMixinProps, 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:: IConstruct

supports(construct)

Check if this mixin supports the given construct.

Parameters:: construct (IConstruct)
Return type:: bool

Attributes

CFN_PROPERTY_KEYS = ['apiId', 'modelSelectionExpression', 'responseModels', 'responseParameters', 'routeId', 'routeResponseKey']

Static Methods

classmethod is_mixin(x)

(experimental) Checks if x is a Mixin.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Mixin.
Stability:: experimental

ParameterConstraintsProperty

class CfnRouteResponsePropsMixin.ParameterConstraintsProperty(*, required=None)

Bases: object

Specifies whether the parameter is required.

Parameters:: required (Union[bool, IResolvable, None]) – Specifies whether the parameter is required.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-routeresponse-parameterconstraints.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

parameter_constraints_property = apigatewayv2_mixins.CfnRouteResponsePropsMixin.ParameterConstraintsProperty(
    required=False
)

Attributes

required

Specifies whether the parameter is required.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-routeresponse-parameterconstraints.html#cfn-apigatewayv2-routeresponse-parameterconstraints-required