CfnLinkRoutingRulePropsMixin

class aws_cdk.cfn_property_mixins.aws_rtbfabric.CfnLinkRoutingRulePropsMixin(props, *, strategy=None)

Bases: Mixin

Resource Type definition for AWS::RTBFabric::LinkRoutingRule.

A routing rule on a link within RTB Fabric that controls request routing based on conditions such as host headers, path matching, and query string parameters.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rtbfabric-linkroutingrule.html
CloudformationResource:: AWS::RTBFabric::LinkRoutingRule
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.cfn_property_mixins import aws_rtbfabric as rtbfabric
import aws_cdk as cdk

# merge_strategy: cdk.IMergeStrategy

cfn_link_routing_rule_props_mixin = rtbfabric.CfnLinkRoutingRulePropsMixin(rtbfabric.CfnLinkRoutingRuleMixinProps(
    conditions=rtbfabric.CfnLinkRoutingRulePropsMixin.RuleConditionProperty(
        host_header="hostHeader",
        host_header_wildcard="hostHeaderWildcard",
        path_exact="pathExact",
        path_prefix="pathPrefix",
        query_string_equals=rtbfabric.CfnLinkRoutingRulePropsMixin.QueryStringKeyValuePairProperty(
            key="key",
            value="value"
        ),
        query_string_exists="queryStringExists"
    ),
    gateway_id="gatewayId",
    link_id="linkId",
    priority=123,
    tags=[cdk.CfnTag(
        key="key",
        value="value"
    )]
),
    strategy=merge_strategy
)

Create a mixin to apply properties to AWS::RTBFabric::LinkRoutingRule.

Parameters:

props (Union[CfnLinkRoutingRuleMixinProps, Dict[str, Any]]) – L1 properties to apply.
strategy (Optional[IMergeStrategy]) – Strategy for merging nested properties. Default: - PropertyMergeStrategy.combine()

Methods

apply_to(construct)

Apply the mixin properties to the construct.

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

supports(construct)

Check if this mixin supports the given construct.

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

Attributes

CFN_PROPERTY_KEYS = ['conditions', 'gatewayId', 'linkId', 'priority', 'tags']

Static Methods

classmethod is_mixin(x)

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.

QueryStringKeyValuePairProperty

class CfnLinkRoutingRulePropsMixin.QueryStringKeyValuePairProperty(*, key=None, value=None)

Bases: object

Parameters:

key (Optional[str]) – Query string key — RFC 3986 unreserved characters.
value (Optional[str]) – Query string value — RFC 3986 unreserved characters.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rtbfabric-linkroutingrule-querystringkeyvaluepair.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.cfn_property_mixins import aws_rtbfabric as rtbfabric

query_string_key_value_pair_property = rtbfabric.CfnLinkRoutingRulePropsMixin.QueryStringKeyValuePairProperty(
    key="key",
    value="value"
)

Attributes

key

Query string key — RFC 3986 unreserved characters.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rtbfabric-linkroutingrule-querystringkeyvaluepair.html#cfn-rtbfabric-linkroutingrule-querystringkeyvaluepair-key

value

Query string value — RFC 3986 unreserved characters.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rtbfabric-linkroutingrule-querystringkeyvaluepair.html#cfn-rtbfabric-linkroutingrule-querystringkeyvaluepair-value

RuleConditionProperty

class CfnLinkRoutingRulePropsMixin.RuleConditionProperty(*, host_header=None, host_header_wildcard=None, path_exact=None, path_prefix=None, query_string_equals=None, query_string_exists=None)

Bases: object

Conditions for a routing rule.

All non-null fields must match (AND logic). At least one field must be set. HostHeader and HostHeaderWildcard are mutually exclusive. PathPrefix and PathExact are mutually exclusive.

Parameters:

host_header (Optional[str]) – Exact host match — RFC 3986 unreserved characters. Mutually exclusive with HostHeaderWildcard.
host_header_wildcard (Optional[str]) – Wildcard host pattern (e.g., *.example.com) — RFC 3986 unreserved characters plus *. Mutually exclusive with HostHeader.
path_exact (Optional[str]) – Exact path match — must start with /. Mutually exclusive with PathPrefix.
path_prefix (Optional[str]) – Path prefix matching — strict starts-with, must start with /. Mutually exclusive with PathExact.
query_string_equals (Union[IResolvable, QueryStringKeyValuePairProperty, Dict[str, Any], None])
query_string_exists (Optional[str]) – Query string key presence check (any value accepted).

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rtbfabric-linkroutingrule-rulecondition.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.cfn_property_mixins import aws_rtbfabric as rtbfabric

rule_condition_property = rtbfabric.CfnLinkRoutingRulePropsMixin.RuleConditionProperty(
    host_header="hostHeader",
    host_header_wildcard="hostHeaderWildcard",
    path_exact="pathExact",
    path_prefix="pathPrefix",
    query_string_equals=rtbfabric.CfnLinkRoutingRulePropsMixin.QueryStringKeyValuePairProperty(
        key="key",
        value="value"
    ),
    query_string_exists="queryStringExists"
)