CfnRoutingRuleMixinProps

class aws_cdk.mixins_preview.aws_apigatewayv2.mixins.CfnRoutingRuleMixinProps(*, actions=None, conditions=None, domain_name_arn=None, priority=None)

Bases: object

Properties for CfnRoutingRulePropsMixin.

Parameters:
  • actions (Union[IResolvable, Sequence[Union[IResolvable, ActionProperty, Dict[str, Any]]], None]) – The resulting action based on matching a routing rules condition. Only InvokeApi is supported.

  • conditions (Union[IResolvable, Sequence[Union[IResolvable, ConditionProperty, Dict[str, Any]]], None]) – The conditions of the routing rule.

  • domain_name_arn (Optional[str]) – The ARN of the domain name.

  • priority (Union[int, float, None]) – 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.mixins_preview.aws_apigatewayv2 import mixins as apigatewayv2_mixins

cfn_routing_rule_mixin_props = apigatewayv2_mixins.CfnRoutingRuleMixinProps(
    actions=[apigatewayv2_mixins.CfnRoutingRulePropsMixin.ActionProperty(
        invoke_api=apigatewayv2_mixins.CfnRoutingRulePropsMixin.ActionInvokeApiProperty(
            api_id="apiId",
            stage="stage",
            strip_base_path=False
        )
    )],
    conditions=[apigatewayv2_mixins.CfnRoutingRulePropsMixin.ConditionProperty(
        match_base_paths=apigatewayv2_mixins.CfnRoutingRulePropsMixin.MatchBasePathsProperty(
            any_of=["anyOf"]
        ),
        match_headers=apigatewayv2_mixins.CfnRoutingRulePropsMixin.MatchHeadersProperty(
            any_of=[apigatewayv2_mixins.CfnRoutingRulePropsMixin.MatchHeaderValueProperty(
                header="header",
                value_glob="valueGlob"
            )]
        )
    )],
    domain_name_arn="domainNameArn",
    priority=123
)

Attributes

actions

The resulting action based on matching a routing rules condition.

Only InvokeApi is supported.

See:

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

conditions

The conditions of the routing rule.

See:

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

domain_name_arn

The ARN of the domain name.

See:

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

priority

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#cfn-apigatewayv2-routingrule-priority