CfnRoutePropsMixin

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

Bases: Mixin

The AWS::ApiGatewayV2::Route resource creates a route for an API.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-route.html

CloudformationResource:

AWS::ApiGatewayV2::Route

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

# request_models: Any
# request_parameters: Any

cfn_route_props_mixin = apigatewayv2_mixins.CfnRoutePropsMixin(apigatewayv2_mixins.CfnRouteMixinProps(
    api_id="apiId",
    api_key_required=False,
    authorization_scopes=["authorizationScopes"],
    authorization_type="authorizationType",
    authorizer_id="authorizerId",
    model_selection_expression="modelSelectionExpression",
    operation_name="operationName",
    request_models=request_models,
    request_parameters=request_parameters,
    route_key="routeKey",
    route_response_selection_expression="routeResponseSelectionExpression",
    target="target"
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

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

Parameters:

• props (Union[CfnRouteMixinProps, 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', 'apiKeyRequired', 'authorizationScopes', 'authorizationType', 'authorizerId', 'modelSelectionExpression', 'operationName', 'requestModels', 'requestParameters', 'routeKey', 'routeResponseSelectionExpression', 'target']

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