CfnRoutingRuleProps

class aws_cdk.aws_apigatewayv2.CfnRoutingRuleProps(*, actions, conditions, domain_name_arn, priority)

Bases: object

Properties for defining a CfnRoutingRule.

Parameters:

actions (Union[IResolvable, Sequence[Union[IResolvable, ActionProperty, Dict[str, Any]]]]) – The resulting action based on matching a routing rules condition. Only InvokeApi is supported.
conditions (Union[IResolvable, Sequence[Union[IResolvable, ConditionProperty, Dict[str, Any]]]]) – The conditions of the routing rule.
domain_name_arn (str) – The ARN of the domain name.
priority (Union[int, float]) – The order in which API Gateway evaluates a rule. Priority is evaluated from the lowest value to the highest value. Rules can’t have the same priority. Priority values 1-1,000,000 are supported.

See:

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

cfn_routing_rule_props = apigatewayv2.CfnRoutingRuleProps(
    actions=[apigatewayv2.CfnRoutingRule.ActionProperty(
        invoke_api=apigatewayv2.CfnRoutingRule.ActionInvokeApiProperty(
            api_id="apiId",
            stage="stage",

            # the properties below are optional
            strip_base_path=False
        )
    )],
    conditions=[apigatewayv2.CfnRoutingRule.ConditionProperty(
        match_base_paths=apigatewayv2.CfnRoutingRule.MatchBasePathsProperty(
            any_of=["anyOf"]
        ),
        match_headers=apigatewayv2.CfnRoutingRule.MatchHeadersProperty(
            any_of=[apigatewayv2.CfnRoutingRule.MatchHeaderValueProperty(
                header="header",
                value_glob="valueGlob"
            )]
        )
    )],
    domain_name_arn="domainNameArn",
    priority=123
)