CfnGatewayRoutePropsMixin

class aws_cdk.mixins_preview.aws_appmesh.mixins.CfnGatewayRoutePropsMixin(props, *, strategy=None)

Bases: Mixin

Creates a gateway route.

A gateway route is attached to a virtual gateway and routes traffic to an existing virtual service. If a route matches a request, it can distribute traffic to a target virtual service.

For more information about gateway routes, see Gateway routes .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appmesh-gatewayroute.html
CloudformationResource:: AWS::AppMesh::GatewayRoute
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_appmesh import mixins as appmesh_mixins

cfn_gateway_route_props_mixin = appmesh_mixins.CfnGatewayRoutePropsMixin(appmesh_mixins.CfnGatewayRouteMixinProps(
    gateway_route_name="gatewayRouteName",
    mesh_name="meshName",
    mesh_owner="meshOwner",
    spec=appmesh_mixins.CfnGatewayRoutePropsMixin.GatewayRouteSpecProperty(
        grpc_route=appmesh_mixins.CfnGatewayRoutePropsMixin.GrpcGatewayRouteProperty(
            action=appmesh_mixins.CfnGatewayRoutePropsMixin.GrpcGatewayRouteActionProperty(
                rewrite=appmesh_mixins.CfnGatewayRoutePropsMixin.GrpcGatewayRouteRewriteProperty(
                    hostname=appmesh_mixins.CfnGatewayRoutePropsMixin.GatewayRouteHostnameRewriteProperty(
                        default_target_hostname="defaultTargetHostname"
                    )
                ),
                target=appmesh_mixins.CfnGatewayRoutePropsMixin.GatewayRouteTargetProperty(
                    port=123,
                    virtual_service=appmesh_mixins.CfnGatewayRoutePropsMixin.GatewayRouteVirtualServiceProperty(
                        virtual_service_name="virtualServiceName"
                    )
                )
            ),
            match=appmesh_mixins.CfnGatewayRoutePropsMixin.GrpcGatewayRouteMatchProperty(
                hostname=appmesh_mixins.CfnGatewayRoutePropsMixin.GatewayRouteHostnameMatchProperty(
                    exact="exact",
                    suffix="suffix"
                ),
                metadata=[appmesh_mixins.CfnGatewayRoutePropsMixin.GrpcGatewayRouteMetadataProperty(
                    invert=False,
                    match=appmesh_mixins.CfnGatewayRoutePropsMixin.GatewayRouteMetadataMatchProperty(
                        exact="exact",
                        prefix="prefix",
                        range=appmesh_mixins.CfnGatewayRoutePropsMixin.GatewayRouteRangeMatchProperty(
                            end=123,
                            start=123
                        ),
                        regex="regex",
                        suffix="suffix"
                    ),
                    name="name"
                )],
                port=123,
                service_name="serviceName"
            )
        ),
        http2_route=appmesh_mixins.CfnGatewayRoutePropsMixin.HttpGatewayRouteProperty(
            action=appmesh_mixins.CfnGatewayRoutePropsMixin.HttpGatewayRouteActionProperty(
                rewrite=appmesh_mixins.CfnGatewayRoutePropsMixin.HttpGatewayRouteRewriteProperty(
                    hostname=appmesh_mixins.CfnGatewayRoutePropsMixin.GatewayRouteHostnameRewriteProperty(
                        default_target_hostname="defaultTargetHostname"
                    ),
                    path=appmesh_mixins.CfnGatewayRoutePropsMixin.HttpGatewayRoutePathRewriteProperty(
                        exact="exact"
                    ),
                    prefix=appmesh_mixins.CfnGatewayRoutePropsMixin.HttpGatewayRoutePrefixRewriteProperty(
                        default_prefix="defaultPrefix",
                        value="value"
                    )
                ),
                target=appmesh_mixins.CfnGatewayRoutePropsMixin.GatewayRouteTargetProperty(
                    port=123,
                    virtual_service=appmesh_mixins.CfnGatewayRoutePropsMixin.GatewayRouteVirtualServiceProperty(
                        virtual_service_name="virtualServiceName"
                    )
                )
            ),
            match=appmesh_mixins.CfnGatewayRoutePropsMixin.HttpGatewayRouteMatchProperty(
                headers=[appmesh_mixins.CfnGatewayRoutePropsMixin.HttpGatewayRouteHeaderProperty(
                    invert=False,
                    match=appmesh_mixins.CfnGatewayRoutePropsMixin.HttpGatewayRouteHeaderMatchProperty(
                        exact="exact",
                        prefix="prefix",
                        range=appmesh_mixins.CfnGatewayRoutePropsMixin.GatewayRouteRangeMatchProperty(
                            end=123,
                            start=123
                        ),
                        regex="regex",
                        suffix="suffix"
                    ),
                    name="name"
                )],
                hostname=appmesh_mixins.CfnGatewayRoutePropsMixin.GatewayRouteHostnameMatchProperty(
                    exact="exact",
                    suffix="suffix"
                ),
                method="method",
                path=appmesh_mixins.CfnGatewayRoutePropsMixin.HttpPathMatchProperty(
                    exact="exact",
                    regex="regex"
                ),
                port=123,
                prefix="prefix",
                query_parameters=[appmesh_mixins.CfnGatewayRoutePropsMixin.QueryParameterProperty(
                    match=appmesh_mixins.CfnGatewayRoutePropsMixin.HttpQueryParameterMatchProperty(
                        exact="exact"
                    ),
                    name="name"
                )]
            )
        ),
        http_route=appmesh_mixins.CfnGatewayRoutePropsMixin.HttpGatewayRouteProperty(
            action=appmesh_mixins.CfnGatewayRoutePropsMixin.HttpGatewayRouteActionProperty(
                rewrite=appmesh_mixins.CfnGatewayRoutePropsMixin.HttpGatewayRouteRewriteProperty(
                    hostname=appmesh_mixins.CfnGatewayRoutePropsMixin.GatewayRouteHostnameRewriteProperty(
                        default_target_hostname="defaultTargetHostname"
                    ),
                    path=appmesh_mixins.CfnGatewayRoutePropsMixin.HttpGatewayRoutePathRewriteProperty(
                        exact="exact"
                    ),
                    prefix=appmesh_mixins.CfnGatewayRoutePropsMixin.HttpGatewayRoutePrefixRewriteProperty(
                        default_prefix="defaultPrefix",
                        value="value"
                    )
                ),
                target=appmesh_mixins.CfnGatewayRoutePropsMixin.GatewayRouteTargetProperty(
                    port=123,
                    virtual_service=appmesh_mixins.CfnGatewayRoutePropsMixin.GatewayRouteVirtualServiceProperty(
                        virtual_service_name="virtualServiceName"
                    )
                )
            ),
            match=appmesh_mixins.CfnGatewayRoutePropsMixin.HttpGatewayRouteMatchProperty(
                headers=[appmesh_mixins.CfnGatewayRoutePropsMixin.HttpGatewayRouteHeaderProperty(
                    invert=False,
                    match=appmesh_mixins.CfnGatewayRoutePropsMixin.HttpGatewayRouteHeaderMatchProperty(
                        exact="exact",
                        prefix="prefix",
                        range=appmesh_mixins.CfnGatewayRoutePropsMixin.GatewayRouteRangeMatchProperty(
                            end=123,
                            start=123
                        ),
                        regex="regex",
                        suffix="suffix"
                    ),
                    name="name"
                )],
                hostname=appmesh_mixins.CfnGatewayRoutePropsMixin.GatewayRouteHostnameMatchProperty(
                    exact="exact",
                    suffix="suffix"
                ),
                method="method",
                path=appmesh_mixins.CfnGatewayRoutePropsMixin.HttpPathMatchProperty(
                    exact="exact",
                    regex="regex"
                ),
                port=123,
                prefix="prefix",
                query_parameters=[appmesh_mixins.CfnGatewayRoutePropsMixin.QueryParameterProperty(
                    match=appmesh_mixins.CfnGatewayRoutePropsMixin.HttpQueryParameterMatchProperty(
                        exact="exact"
                    ),
                    name="name"
                )]
            )
        ),
        priority=123
    ),
    tags=[CfnTag(
        key="key",
        value="value"
    )],
    virtual_gateway_name="virtualGatewayName"
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

Create a mixin to apply properties to AWS::AppMesh::GatewayRoute.

Parameters:

props (Union[CfnGatewayRouteMixinProps, 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 = ['gatewayRouteName', 'meshName', 'meshOwner', 'spec', 'tags', 'virtualGatewayName']

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

GatewayRouteHostnameMatchProperty

class CfnGatewayRoutePropsMixin.GatewayRouteHostnameMatchProperty(*, exact=None, suffix=None)

Bases: object

An object representing the gateway route host name to match.

Parameters:

exact (Optional[str]) – The exact host name to match on.
suffix (Optional[str]) – The specified ending characters of the host name to match on.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-gatewayroutehostnamematch.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_appmesh import mixins as appmesh_mixins

gateway_route_hostname_match_property = appmesh_mixins.CfnGatewayRoutePropsMixin.GatewayRouteHostnameMatchProperty(
    exact="exact",
    suffix="suffix"
)

Attributes

exact

The exact host name to match on.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-gatewayroutehostnamematch.html#cfn-appmesh-gatewayroute-gatewayroutehostnamematch-exact

suffix

The specified ending characters of the host name to match on.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-gatewayroutehostnamematch.html#cfn-appmesh-gatewayroute-gatewayroutehostnamematch-suffix

GatewayRouteHostnameRewriteProperty

class CfnGatewayRoutePropsMixin.GatewayRouteHostnameRewriteProperty(*, default_target_hostname=None)

Bases: object

An object representing the gateway route host name to rewrite.

Parameters:: default_target_hostname (Optional[str]) – The default target host name to write to.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-gatewayroutehostnamerewrite.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_appmesh import mixins as appmesh_mixins

gateway_route_hostname_rewrite_property = appmesh_mixins.CfnGatewayRoutePropsMixin.GatewayRouteHostnameRewriteProperty(
    default_target_hostname="defaultTargetHostname"
)

Attributes

default_target_hostname

The default target host name to write to.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-gatewayroutehostnamerewrite.html#cfn-appmesh-gatewayroute-gatewayroutehostnamerewrite-defaulttargethostname

GatewayRouteMetadataMatchProperty

class CfnGatewayRoutePropsMixin.GatewayRouteMetadataMatchProperty(*, exact=None, prefix=None, range=None, regex=None, suffix=None)

Bases: object

An object representing the method header to be matched.

Parameters:

exact (Optional[str]) – The exact method header to be matched on.
prefix (Optional[str]) – The specified beginning characters of the method header to be matched on.
range (Union[IResolvable, GatewayRouteRangeMatchProperty, Dict[str, Any], None]) – An object that represents the range of values to match on.
regex (Optional[str]) – The regex used to match the method header.
suffix (Optional[str]) – The specified ending characters of the method header to match on.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-gatewayroutemetadatamatch.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_appmesh import mixins as appmesh_mixins

gateway_route_metadata_match_property = appmesh_mixins.CfnGatewayRoutePropsMixin.GatewayRouteMetadataMatchProperty(
    exact="exact",
    prefix="prefix",
    range=appmesh_mixins.CfnGatewayRoutePropsMixin.GatewayRouteRangeMatchProperty(
        end=123,
        start=123
    ),
    regex="regex",
    suffix="suffix"
)

Attributes

exact

The exact method header to be matched on.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-gatewayroutemetadatamatch.html#cfn-appmesh-gatewayroute-gatewayroutemetadatamatch-exact

prefix

The specified beginning characters of the method header to be matched on.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-gatewayroutemetadatamatch.html#cfn-appmesh-gatewayroute-gatewayroutemetadatamatch-prefix

range

An object that represents the range of values to match on.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-gatewayroutemetadatamatch.html#cfn-appmesh-gatewayroute-gatewayroutemetadatamatch-range

regex

The regex used to match the method header.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-gatewayroutemetadatamatch.html#cfn-appmesh-gatewayroute-gatewayroutemetadatamatch-regex

suffix

The specified ending characters of the method header to match on.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-gatewayroutemetadatamatch.html#cfn-appmesh-gatewayroute-gatewayroutemetadatamatch-suffix

GatewayRouteRangeMatchProperty

class CfnGatewayRoutePropsMixin.GatewayRouteRangeMatchProperty(*, end=None, start=None)

Bases: object

An object that represents the range of values to match on.

The first character of the range is included in the range, though the last character is not. For example, if the range specified were 1-100, only values 1-99 would be matched.

Parameters:

end (Union[int, float, None]) – The end of the range.
start (Union[int, float, None]) – The start of the range.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-gatewayrouterangematch.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_appmesh import mixins as appmesh_mixins

gateway_route_range_match_property = appmesh_mixins.CfnGatewayRoutePropsMixin.GatewayRouteRangeMatchProperty(
    end=123,
    start=123
)

Attributes

end

The end of the range.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-gatewayrouterangematch.html#cfn-appmesh-gatewayroute-gatewayrouterangematch-end

start

The start of the range.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-gatewayrouterangematch.html#cfn-appmesh-gatewayroute-gatewayrouterangematch-start

GatewayRouteSpecProperty

class CfnGatewayRoutePropsMixin.GatewayRouteSpecProperty(*, grpc_route=None, http2_route=None, http_route=None, priority=None)

Bases: object

An object that represents a gateway route specification.

Specify one gateway route type.

Parameters:

grpc_route (Union[IResolvable, GrpcGatewayRouteProperty, Dict[str, Any], None]) – An object that represents the specification of a gRPC gateway route.
http2_route (Union[IResolvable, HttpGatewayRouteProperty, Dict[str, Any], None]) – An object that represents the specification of an HTTP/2 gateway route.
http_route (Union[IResolvable, HttpGatewayRouteProperty, Dict[str, Any], None]) – An object that represents the specification of an HTTP gateway route.
priority (Union[int, float, None]) – The ordering of the gateway routes spec.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-gatewayroutespec.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_appmesh import mixins as appmesh_mixins

gateway_route_spec_property = appmesh_mixins.CfnGatewayRoutePropsMixin.GatewayRouteSpecProperty(
    grpc_route=appmesh_mixins.CfnGatewayRoutePropsMixin.GrpcGatewayRouteProperty(
        action=appmesh_mixins.CfnGatewayRoutePropsMixin.GrpcGatewayRouteActionProperty(
            rewrite=appmesh_mixins.CfnGatewayRoutePropsMixin.GrpcGatewayRouteRewriteProperty(
                hostname=appmesh_mixins.CfnGatewayRoutePropsMixin.GatewayRouteHostnameRewriteProperty(
                    default_target_hostname="defaultTargetHostname"
                )
            ),
            target=appmesh_mixins.CfnGatewayRoutePropsMixin.GatewayRouteTargetProperty(
                port=123,
                virtual_service=appmesh_mixins.CfnGatewayRoutePropsMixin.GatewayRouteVirtualServiceProperty(
                    virtual_service_name="virtualServiceName"
                )
            )
        ),
        match=appmesh_mixins.CfnGatewayRoutePropsMixin.GrpcGatewayRouteMatchProperty(
            hostname=appmesh_mixins.CfnGatewayRoutePropsMixin.GatewayRouteHostnameMatchProperty(
                exact="exact",
                suffix="suffix"
            ),
            metadata=[appmesh_mixins.CfnGatewayRoutePropsMixin.GrpcGatewayRouteMetadataProperty(
                invert=False,
                match=appmesh_mixins.CfnGatewayRoutePropsMixin.GatewayRouteMetadataMatchProperty(
                    exact="exact",
                    prefix="prefix",
                    range=appmesh_mixins.CfnGatewayRoutePropsMixin.GatewayRouteRangeMatchProperty(
                        end=123,
                        start=123
                    ),
                    regex="regex",
                    suffix="suffix"
                ),
                name="name"
            )],
            port=123,
            service_name="serviceName"
        )
    ),
    http2_route=appmesh_mixins.CfnGatewayRoutePropsMixin.HttpGatewayRouteProperty(
        action=appmesh_mixins.CfnGatewayRoutePropsMixin.HttpGatewayRouteActionProperty(
            rewrite=appmesh_mixins.CfnGatewayRoutePropsMixin.HttpGatewayRouteRewriteProperty(
                hostname=appmesh_mixins.CfnGatewayRoutePropsMixin.GatewayRouteHostnameRewriteProperty(
                    default_target_hostname="defaultTargetHostname"
                ),
                path=appmesh_mixins.CfnGatewayRoutePropsMixin.HttpGatewayRoutePathRewriteProperty(
                    exact="exact"
                ),
                prefix=appmesh_mixins.CfnGatewayRoutePropsMixin.HttpGatewayRoutePrefixRewriteProperty(
                    default_prefix="defaultPrefix",
                    value="value"
                )
            ),
            target=appmesh_mixins.CfnGatewayRoutePropsMixin.GatewayRouteTargetProperty(
                port=123,
                virtual_service=appmesh_mixins.CfnGatewayRoutePropsMixin.GatewayRouteVirtualServiceProperty(
                    virtual_service_name="virtualServiceName"
                )
            )
        ),
        match=appmesh_mixins.CfnGatewayRoutePropsMixin.HttpGatewayRouteMatchProperty(
            headers=[appmesh_mixins.CfnGatewayRoutePropsMixin.HttpGatewayRouteHeaderProperty(
                invert=False,
                match=appmesh_mixins.CfnGatewayRoutePropsMixin.HttpGatewayRouteHeaderMatchProperty(
                    exact="exact",
                    prefix="prefix",
                    range=appmesh_mixins.CfnGatewayRoutePropsMixin.GatewayRouteRangeMatchProperty(
                        end=123,
                        start=123
                    ),
                    regex="regex",
                    suffix="suffix"
                ),
                name="name"
            )],
            hostname=appmesh_mixins.CfnGatewayRoutePropsMixin.GatewayRouteHostnameMatchProperty(
                exact="exact",
                suffix="suffix"
            ),
            method="method",
            path=appmesh_mixins.CfnGatewayRoutePropsMixin.HttpPathMatchProperty(
                exact="exact",
                regex="regex"
            ),
            port=123,
            prefix="prefix",
            query_parameters=[appmesh_mixins.CfnGatewayRoutePropsMixin.QueryParameterProperty(
                match=appmesh_mixins.CfnGatewayRoutePropsMixin.HttpQueryParameterMatchProperty(
                    exact="exact"
                ),
                name="name"
            )]
        )
    ),
    http_route=appmesh_mixins.CfnGatewayRoutePropsMixin.HttpGatewayRouteProperty(
        action=appmesh_mixins.CfnGatewayRoutePropsMixin.HttpGatewayRouteActionProperty(
            rewrite=appmesh_mixins.CfnGatewayRoutePropsMixin.HttpGatewayRouteRewriteProperty(
                hostname=appmesh_mixins.CfnGatewayRoutePropsMixin.GatewayRouteHostnameRewriteProperty(
                    default_target_hostname="defaultTargetHostname"
                ),
                path=appmesh_mixins.CfnGatewayRoutePropsMixin.HttpGatewayRoutePathRewriteProperty(
                    exact="exact"
                ),
                prefix=appmesh_mixins.CfnGatewayRoutePropsMixin.HttpGatewayRoutePrefixRewriteProperty(
                    default_prefix="defaultPrefix",
                    value="value"
                )
            ),
            target=appmesh_mixins.CfnGatewayRoutePropsMixin.GatewayRouteTargetProperty(
                port=123,
                virtual_service=appmesh_mixins.CfnGatewayRoutePropsMixin.GatewayRouteVirtualServiceProperty(
                    virtual_service_name="virtualServiceName"
                )
            )
        ),
        match=appmesh_mixins.CfnGatewayRoutePropsMixin.HttpGatewayRouteMatchProperty(
            headers=[appmesh_mixins.CfnGatewayRoutePropsMixin.HttpGatewayRouteHeaderProperty(
                invert=False,
                match=appmesh_mixins.CfnGatewayRoutePropsMixin.HttpGatewayRouteHeaderMatchProperty(
                    exact="exact",
                    prefix="prefix",
                    range=appmesh_mixins.CfnGatewayRoutePropsMixin.GatewayRouteRangeMatchProperty(
                        end=123,
                        start=123
                    ),
                    regex="regex",
                    suffix="suffix"
                ),
                name="name"
            )],
            hostname=appmesh_mixins.CfnGatewayRoutePropsMixin.GatewayRouteHostnameMatchProperty(
                exact="exact",
                suffix="suffix"
            ),
            method="method",
            path=appmesh_mixins.CfnGatewayRoutePropsMixin.HttpPathMatchProperty(
                exact="exact",
                regex="regex"
            ),
            port=123,
            prefix="prefix",
            query_parameters=[appmesh_mixins.CfnGatewayRoutePropsMixin.QueryParameterProperty(
                match=appmesh_mixins.CfnGatewayRoutePropsMixin.HttpQueryParameterMatchProperty(
                    exact="exact"
                ),
                name="name"
            )]
        )
    ),
    priority=123
)

Attributes

grpc_route

An object that represents the specification of a gRPC gateway route.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-gatewayroutespec.html#cfn-appmesh-gatewayroute-gatewayroutespec-grpcroute

http2_route

An object that represents the specification of an HTTP/2 gateway route.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-gatewayroutespec.html#cfn-appmesh-gatewayroute-gatewayroutespec-http2route

http_route

An object that represents the specification of an HTTP gateway route.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-gatewayroutespec.html#cfn-appmesh-gatewayroute-gatewayroutespec-httproute

priority

The ordering of the gateway routes spec.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-gatewayroutespec.html#cfn-appmesh-gatewayroute-gatewayroutespec-priority

GatewayRouteTargetProperty

class CfnGatewayRoutePropsMixin.GatewayRouteTargetProperty(*, port=None, virtual_service=None)

Bases: object

An object that represents a gateway route target.

Parameters:

port (Union[int, float, None]) – The port number of the gateway route target.
virtual_service (Union[IResolvable, GatewayRouteVirtualServiceProperty, Dict[str, Any], None]) – An object that represents a virtual service gateway route target.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-gatewayroutetarget.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_appmesh import mixins as appmesh_mixins

gateway_route_target_property = appmesh_mixins.CfnGatewayRoutePropsMixin.GatewayRouteTargetProperty(
    port=123,
    virtual_service=appmesh_mixins.CfnGatewayRoutePropsMixin.GatewayRouteVirtualServiceProperty(
        virtual_service_name="virtualServiceName"
    )
)

Attributes

port

The port number of the gateway route target.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-gatewayroutetarget.html#cfn-appmesh-gatewayroute-gatewayroutetarget-port

virtual_service

An object that represents a virtual service gateway route target.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-gatewayroutetarget.html#cfn-appmesh-gatewayroute-gatewayroutetarget-virtualservice

GatewayRouteVirtualServiceProperty

class CfnGatewayRoutePropsMixin.GatewayRouteVirtualServiceProperty(*, virtual_service_name=None)

Bases: object

An object that represents the virtual service that traffic is routed to.

Parameters:: virtual_service_name (Optional[str]) – The name of the virtual service that traffic is routed to.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-gatewayroutevirtualservice.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_appmesh import mixins as appmesh_mixins

gateway_route_virtual_service_property = appmesh_mixins.CfnGatewayRoutePropsMixin.GatewayRouteVirtualServiceProperty(
    virtual_service_name="virtualServiceName"
)

Attributes

virtual_service_name

The name of the virtual service that traffic is routed to.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-gatewayroutevirtualservice.html#cfn-appmesh-gatewayroute-gatewayroutevirtualservice-virtualservicename

GrpcGatewayRouteActionProperty

class CfnGatewayRoutePropsMixin.GrpcGatewayRouteActionProperty(*, rewrite=None, target=None)

Bases: object

An object that represents the action to take if a match is determined.

Parameters:

rewrite (Union[IResolvable, GrpcGatewayRouteRewriteProperty, Dict[str, Any], None]) – The gateway route action to rewrite.
target (Union[IResolvable, GatewayRouteTargetProperty, Dict[str, Any], None]) – An object that represents the target that traffic is routed to when a request matches the gateway route.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-grpcgatewayrouteaction.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_appmesh import mixins as appmesh_mixins

grpc_gateway_route_action_property = appmesh_mixins.CfnGatewayRoutePropsMixin.GrpcGatewayRouteActionProperty(
    rewrite=appmesh_mixins.CfnGatewayRoutePropsMixin.GrpcGatewayRouteRewriteProperty(
        hostname=appmesh_mixins.CfnGatewayRoutePropsMixin.GatewayRouteHostnameRewriteProperty(
            default_target_hostname="defaultTargetHostname"
        )
    ),
    target=appmesh_mixins.CfnGatewayRoutePropsMixin.GatewayRouteTargetProperty(
        port=123,
        virtual_service=appmesh_mixins.CfnGatewayRoutePropsMixin.GatewayRouteVirtualServiceProperty(
            virtual_service_name="virtualServiceName"
        )
    )
)

Attributes

rewrite

The gateway route action to rewrite.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-grpcgatewayrouteaction.html#cfn-appmesh-gatewayroute-grpcgatewayrouteaction-rewrite

target

An object that represents the target that traffic is routed to when a request matches the gateway route.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-grpcgatewayrouteaction.html#cfn-appmesh-gatewayroute-grpcgatewayrouteaction-target

GrpcGatewayRouteMatchProperty

class CfnGatewayRoutePropsMixin.GrpcGatewayRouteMatchProperty(*, hostname=None, metadata=None, port=None, service_name=None)

Bases: object

An object that represents the criteria for determining a request match.

Parameters:

hostname (Union[IResolvable, GatewayRouteHostnameMatchProperty, Dict[str, Any], None]) – The gateway route host name to be matched on.
metadata (Union[IResolvable, Sequence[Union[IResolvable, GrpcGatewayRouteMetadataProperty, Dict[str, Any]]], None]) – The gateway route metadata to be matched on.
port (Union[int, float, None]) – The gateway route port to be matched on.
service_name (Optional[str]) – The fully qualified domain name for the service to match from the request.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-grpcgatewayroutematch.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_appmesh import mixins as appmesh_mixins

grpc_gateway_route_match_property = appmesh_mixins.CfnGatewayRoutePropsMixin.GrpcGatewayRouteMatchProperty(
    hostname=appmesh_mixins.CfnGatewayRoutePropsMixin.GatewayRouteHostnameMatchProperty(
        exact="exact",
        suffix="suffix"
    ),
    metadata=[appmesh_mixins.CfnGatewayRoutePropsMixin.GrpcGatewayRouteMetadataProperty(
        invert=False,
        match=appmesh_mixins.CfnGatewayRoutePropsMixin.GatewayRouteMetadataMatchProperty(
            exact="exact",
            prefix="prefix",
            range=appmesh_mixins.CfnGatewayRoutePropsMixin.GatewayRouteRangeMatchProperty(
                end=123,
                start=123
            ),
            regex="regex",
            suffix="suffix"
        ),
        name="name"
    )],
    port=123,
    service_name="serviceName"
)

Attributes

hostname

The gateway route host name to be matched on.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-grpcgatewayroutematch.html#cfn-appmesh-gatewayroute-grpcgatewayroutematch-hostname

metadata

The gateway route metadata to be matched on.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-grpcgatewayroutematch.html#cfn-appmesh-gatewayroute-grpcgatewayroutematch-metadata

port

The gateway route port to be matched on.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-grpcgatewayroutematch.html#cfn-appmesh-gatewayroute-grpcgatewayroutematch-port

service_name

The fully qualified domain name for the service to match from the request.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-grpcgatewayroutematch.html#cfn-appmesh-gatewayroute-grpcgatewayroutematch-servicename

GrpcGatewayRouteMetadataProperty

class CfnGatewayRoutePropsMixin.GrpcGatewayRouteMetadataProperty(*, invert=None, match=None, name=None)

Bases: object

An object representing the metadata of the gateway route.

Parameters:

invert (Union[bool, IResolvable, None]) – Specify True to match anything except the match criteria. The default value is False .
match (Union[IResolvable, GatewayRouteMetadataMatchProperty, Dict[str, Any], None]) – The criteria for determining a metadata match.
name (Optional[str]) – A name for the gateway route metadata.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-grpcgatewayroutemetadata.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_appmesh import mixins as appmesh_mixins

grpc_gateway_route_metadata_property = appmesh_mixins.CfnGatewayRoutePropsMixin.GrpcGatewayRouteMetadataProperty(
    invert=False,
    match=appmesh_mixins.CfnGatewayRoutePropsMixin.GatewayRouteMetadataMatchProperty(
        exact="exact",
        prefix="prefix",
        range=appmesh_mixins.CfnGatewayRoutePropsMixin.GatewayRouteRangeMatchProperty(
            end=123,
            start=123
        ),
        regex="regex",
        suffix="suffix"
    ),
    name="name"
)

Attributes

invert

Specify True to match anything except the match criteria.

The default value is False .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-grpcgatewayroutemetadata.html#cfn-appmesh-gatewayroute-grpcgatewayroutemetadata-invert

match

The criteria for determining a metadata match.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-grpcgatewayroutemetadata.html#cfn-appmesh-gatewayroute-grpcgatewayroutemetadata-match

name

A name for the gateway route metadata.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-grpcgatewayroutemetadata.html#cfn-appmesh-gatewayroute-grpcgatewayroutemetadata-name

GrpcGatewayRouteProperty

class CfnGatewayRoutePropsMixin.GrpcGatewayRouteProperty(*, action=None, match=None)

Bases: object

An object that represents a gRPC gateway route.

Parameters:

action (Union[IResolvable, GrpcGatewayRouteActionProperty, Dict[str, Any], None]) – An object that represents the action to take if a match is determined.
match (Union[IResolvable, GrpcGatewayRouteMatchProperty, Dict[str, Any], None]) – An object that represents the criteria for determining a request match.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-grpcgatewayroute.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_appmesh import mixins as appmesh_mixins

grpc_gateway_route_property = appmesh_mixins.CfnGatewayRoutePropsMixin.GrpcGatewayRouteProperty(
    action=appmesh_mixins.CfnGatewayRoutePropsMixin.GrpcGatewayRouteActionProperty(
        rewrite=appmesh_mixins.CfnGatewayRoutePropsMixin.GrpcGatewayRouteRewriteProperty(
            hostname=appmesh_mixins.CfnGatewayRoutePropsMixin.GatewayRouteHostnameRewriteProperty(
                default_target_hostname="defaultTargetHostname"
            )
        ),
        target=appmesh_mixins.CfnGatewayRoutePropsMixin.GatewayRouteTargetProperty(
            port=123,
            virtual_service=appmesh_mixins.CfnGatewayRoutePropsMixin.GatewayRouteVirtualServiceProperty(
                virtual_service_name="virtualServiceName"
            )
        )
    ),
    match=appmesh_mixins.CfnGatewayRoutePropsMixin.GrpcGatewayRouteMatchProperty(
        hostname=appmesh_mixins.CfnGatewayRoutePropsMixin.GatewayRouteHostnameMatchProperty(
            exact="exact",
            suffix="suffix"
        ),
        metadata=[appmesh_mixins.CfnGatewayRoutePropsMixin.GrpcGatewayRouteMetadataProperty(
            invert=False,
            match=appmesh_mixins.CfnGatewayRoutePropsMixin.GatewayRouteMetadataMatchProperty(
                exact="exact",
                prefix="prefix",
                range=appmesh_mixins.CfnGatewayRoutePropsMixin.GatewayRouteRangeMatchProperty(
                    end=123,
                    start=123
                ),
                regex="regex",
                suffix="suffix"
            ),
            name="name"
        )],
        port=123,
        service_name="serviceName"
    )
)

Attributes

action

An object that represents the action to take if a match is determined.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-grpcgatewayroute.html#cfn-appmesh-gatewayroute-grpcgatewayroute-action

match

An object that represents the criteria for determining a request match.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-grpcgatewayroute.html#cfn-appmesh-gatewayroute-grpcgatewayroute-match

GrpcGatewayRouteRewriteProperty

class CfnGatewayRoutePropsMixin.GrpcGatewayRouteRewriteProperty(*, hostname=None)

Bases: object

An object that represents the gateway route to rewrite.

Parameters:: hostname (Union[IResolvable, GatewayRouteHostnameRewriteProperty, Dict[str, Any], None]) – The host name of the gateway route to rewrite.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-grpcgatewayrouterewrite.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_appmesh import mixins as appmesh_mixins

grpc_gateway_route_rewrite_property = appmesh_mixins.CfnGatewayRoutePropsMixin.GrpcGatewayRouteRewriteProperty(
    hostname=appmesh_mixins.CfnGatewayRoutePropsMixin.GatewayRouteHostnameRewriteProperty(
        default_target_hostname="defaultTargetHostname"
    )
)

Attributes

hostname

The host name of the gateway route to rewrite.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-grpcgatewayrouterewrite.html#cfn-appmesh-gatewayroute-grpcgatewayrouterewrite-hostname

HttpGatewayRouteActionProperty

class CfnGatewayRoutePropsMixin.HttpGatewayRouteActionProperty(*, rewrite=None, target=None)

Bases: object

An object that represents the action to take if a match is determined.

Parameters:

rewrite (Union[IResolvable, HttpGatewayRouteRewriteProperty, Dict[str, Any], None]) – The gateway route action to rewrite.
target (Union[IResolvable, GatewayRouteTargetProperty, Dict[str, Any], None]) – An object that represents the target that traffic is routed to when a request matches the gateway route.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-httpgatewayrouteaction.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_appmesh import mixins as appmesh_mixins

http_gateway_route_action_property = appmesh_mixins.CfnGatewayRoutePropsMixin.HttpGatewayRouteActionProperty(
    rewrite=appmesh_mixins.CfnGatewayRoutePropsMixin.HttpGatewayRouteRewriteProperty(
        hostname=appmesh_mixins.CfnGatewayRoutePropsMixin.GatewayRouteHostnameRewriteProperty(
            default_target_hostname="defaultTargetHostname"
        ),
        path=appmesh_mixins.CfnGatewayRoutePropsMixin.HttpGatewayRoutePathRewriteProperty(
            exact="exact"
        ),
        prefix=appmesh_mixins.CfnGatewayRoutePropsMixin.HttpGatewayRoutePrefixRewriteProperty(
            default_prefix="defaultPrefix",
            value="value"
        )
    ),
    target=appmesh_mixins.CfnGatewayRoutePropsMixin.GatewayRouteTargetProperty(
        port=123,
        virtual_service=appmesh_mixins.CfnGatewayRoutePropsMixin.GatewayRouteVirtualServiceProperty(
            virtual_service_name="virtualServiceName"
        )
    )
)

Attributes

rewrite

The gateway route action to rewrite.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-httpgatewayrouteaction.html#cfn-appmesh-gatewayroute-httpgatewayrouteaction-rewrite

target

An object that represents the target that traffic is routed to when a request matches the gateway route.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-httpgatewayrouteaction.html#cfn-appmesh-gatewayroute-httpgatewayrouteaction-target

HttpGatewayRouteHeaderMatchProperty

class CfnGatewayRoutePropsMixin.HttpGatewayRouteHeaderMatchProperty(*, exact=None, prefix=None, range=None, regex=None, suffix=None)

Bases: object

An object that represents the method and value to match with the header value sent in a request.

Specify one match method.

Parameters:

exact (Optional[str]) – The value sent by the client must match the specified value exactly.
prefix (Optional[str]) – The value sent by the client must begin with the specified characters.
range (Union[IResolvable, GatewayRouteRangeMatchProperty, Dict[str, Any], None]) – An object that represents the range of values to match on.
regex (Optional[str]) – The value sent by the client must include the specified characters.
suffix (Optional[str]) – The value sent by the client must end with the specified characters.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-httpgatewayrouteheadermatch.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_appmesh import mixins as appmesh_mixins

http_gateway_route_header_match_property = appmesh_mixins.CfnGatewayRoutePropsMixin.HttpGatewayRouteHeaderMatchProperty(
    exact="exact",
    prefix="prefix",
    range=appmesh_mixins.CfnGatewayRoutePropsMixin.GatewayRouteRangeMatchProperty(
        end=123,
        start=123
    ),
    regex="regex",
    suffix="suffix"
)

Attributes

exact

The value sent by the client must match the specified value exactly.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-httpgatewayrouteheadermatch.html#cfn-appmesh-gatewayroute-httpgatewayrouteheadermatch-exact

prefix

The value sent by the client must begin with the specified characters.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-httpgatewayrouteheadermatch.html#cfn-appmesh-gatewayroute-httpgatewayrouteheadermatch-prefix

range

An object that represents the range of values to match on.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-httpgatewayrouteheadermatch.html#cfn-appmesh-gatewayroute-httpgatewayrouteheadermatch-range

regex

The value sent by the client must include the specified characters.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-httpgatewayrouteheadermatch.html#cfn-appmesh-gatewayroute-httpgatewayrouteheadermatch-regex

suffix

The value sent by the client must end with the specified characters.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-httpgatewayrouteheadermatch.html#cfn-appmesh-gatewayroute-httpgatewayrouteheadermatch-suffix

HttpGatewayRouteHeaderProperty

class CfnGatewayRoutePropsMixin.HttpGatewayRouteHeaderProperty(*, invert=None, match=None, name=None)

Bases: object

An object that represents the HTTP header in the gateway route.

Parameters:

invert (Union[bool, IResolvable, None]) – Specify True to match anything except the match criteria. The default value is False .
match (Union[IResolvable, HttpGatewayRouteHeaderMatchProperty, Dict[str, Any], None]) – An object that represents the method and value to match with the header value sent in a request. Specify one match method.
name (Optional[str]) – A name for the HTTP header in the gateway route that will be matched on.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-httpgatewayrouteheader.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_appmesh import mixins as appmesh_mixins

http_gateway_route_header_property = appmesh_mixins.CfnGatewayRoutePropsMixin.HttpGatewayRouteHeaderProperty(
    invert=False,
    match=appmesh_mixins.CfnGatewayRoutePropsMixin.HttpGatewayRouteHeaderMatchProperty(
        exact="exact",
        prefix="prefix",
        range=appmesh_mixins.CfnGatewayRoutePropsMixin.GatewayRouteRangeMatchProperty(
            end=123,
            start=123
        ),
        regex="regex",
        suffix="suffix"
    ),
    name="name"
)

Attributes

invert

Specify True to match anything except the match criteria.

The default value is False .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-httpgatewayrouteheader.html#cfn-appmesh-gatewayroute-httpgatewayrouteheader-invert

match

An object that represents the method and value to match with the header value sent in a request.

Specify one match method.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-httpgatewayrouteheader.html#cfn-appmesh-gatewayroute-httpgatewayrouteheader-match

name

A name for the HTTP header in the gateway route that will be matched on.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-httpgatewayrouteheader.html#cfn-appmesh-gatewayroute-httpgatewayrouteheader-name

HttpGatewayRouteMatchProperty

class CfnGatewayRoutePropsMixin.HttpGatewayRouteMatchProperty(*, headers=None, hostname=None, method=None, path=None, port=None, prefix=None, query_parameters=None)

Bases: object

An object that represents the criteria for determining a request match.

Parameters:

headers (Union[IResolvable, Sequence[Union[IResolvable, HttpGatewayRouteHeaderProperty, Dict[str, Any]]], None]) – The client request headers to match on.
hostname (Union[IResolvable, GatewayRouteHostnameMatchProperty, Dict[str, Any], None]) – The host name to match on.
method (Optional[str]) – The method to match on.
path (Union[IResolvable, HttpPathMatchProperty, Dict[str, Any], None]) – The path to match on.
port (Union[int, float, None]) – The port number to match on.
prefix (Optional[str]) – Specifies the path to match requests with. This parameter must always start with / , which by itself matches all requests to the virtual service name. You can also match for path-based routing of requests. For example, if your virtual service name is my-service.local and you want the route to match requests to my-service.local/metrics , your prefix should be /metrics .
query_parameters (Union[IResolvable, Sequence[Union[IResolvable, QueryParameterProperty, Dict[str, Any]]], None]) – The query parameter to match on.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-httpgatewayroutematch.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_appmesh import mixins as appmesh_mixins

http_gateway_route_match_property = appmesh_mixins.CfnGatewayRoutePropsMixin.HttpGatewayRouteMatchProperty(
    headers=[appmesh_mixins.CfnGatewayRoutePropsMixin.HttpGatewayRouteHeaderProperty(
        invert=False,
        match=appmesh_mixins.CfnGatewayRoutePropsMixin.HttpGatewayRouteHeaderMatchProperty(
            exact="exact",
            prefix="prefix",
            range=appmesh_mixins.CfnGatewayRoutePropsMixin.GatewayRouteRangeMatchProperty(
                end=123,
                start=123
            ),
            regex="regex",
            suffix="suffix"
        ),
        name="name"
    )],
    hostname=appmesh_mixins.CfnGatewayRoutePropsMixin.GatewayRouteHostnameMatchProperty(
        exact="exact",
        suffix="suffix"
    ),
    method="method",
    path=appmesh_mixins.CfnGatewayRoutePropsMixin.HttpPathMatchProperty(
        exact="exact",
        regex="regex"
    ),
    port=123,
    prefix="prefix",
    query_parameters=[appmesh_mixins.CfnGatewayRoutePropsMixin.QueryParameterProperty(
        match=appmesh_mixins.CfnGatewayRoutePropsMixin.HttpQueryParameterMatchProperty(
            exact="exact"
        ),
        name="name"
    )]
)

Attributes

headers

The client request headers to match on.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-httpgatewayroutematch.html#cfn-appmesh-gatewayroute-httpgatewayroutematch-headers

hostname

The host name to match on.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-httpgatewayroutematch.html#cfn-appmesh-gatewayroute-httpgatewayroutematch-hostname

method

The method to match on.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-httpgatewayroutematch.html#cfn-appmesh-gatewayroute-httpgatewayroutematch-method

path

The path to match on.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-httpgatewayroutematch.html#cfn-appmesh-gatewayroute-httpgatewayroutematch-path

port

The port number to match on.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-httpgatewayroutematch.html#cfn-appmesh-gatewayroute-httpgatewayroutematch-port

prefix

Specifies the path to match requests with.

This parameter must always start with / , which by itself matches all requests to the virtual service name. You can also match for path-based routing of requests. For example, if your virtual service name is my-service.local and you want the route to match requests to my-service.local/metrics , your prefix should be /metrics .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-httpgatewayroutematch.html#cfn-appmesh-gatewayroute-httpgatewayroutematch-prefix

query_parameters

The query parameter to match on.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-httpgatewayroutematch.html#cfn-appmesh-gatewayroute-httpgatewayroutematch-queryparameters

HttpGatewayRoutePathRewriteProperty

class CfnGatewayRoutePropsMixin.HttpGatewayRoutePathRewriteProperty(*, exact=None)

Bases: object

An object that represents the path to rewrite.

Parameters:: exact (Optional[str]) – The exact path to rewrite.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-httpgatewayroutepathrewrite.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_appmesh import mixins as appmesh_mixins

http_gateway_route_path_rewrite_property = appmesh_mixins.CfnGatewayRoutePropsMixin.HttpGatewayRoutePathRewriteProperty(
    exact="exact"
)

Attributes

exact

The exact path to rewrite.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-httpgatewayroutepathrewrite.html#cfn-appmesh-gatewayroute-httpgatewayroutepathrewrite-exact

HttpGatewayRoutePrefixRewriteProperty

class CfnGatewayRoutePropsMixin.HttpGatewayRoutePrefixRewriteProperty(*, default_prefix=None, value=None)

Bases: object

An object representing the beginning characters of the route to rewrite.

Parameters:

default_prefix (Optional[str]) – The default prefix used to replace the incoming route prefix when rewritten.
value (Optional[str]) – The value used to replace the incoming route prefix when rewritten.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-httpgatewayrouteprefixrewrite.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_appmesh import mixins as appmesh_mixins

http_gateway_route_prefix_rewrite_property = appmesh_mixins.CfnGatewayRoutePropsMixin.HttpGatewayRoutePrefixRewriteProperty(
    default_prefix="defaultPrefix",
    value="value"
)

Attributes

default_prefix

The default prefix used to replace the incoming route prefix when rewritten.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-httpgatewayrouteprefixrewrite.html#cfn-appmesh-gatewayroute-httpgatewayrouteprefixrewrite-defaultprefix

value

The value used to replace the incoming route prefix when rewritten.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-httpgatewayrouteprefixrewrite.html#cfn-appmesh-gatewayroute-httpgatewayrouteprefixrewrite-value

HttpGatewayRouteProperty

class CfnGatewayRoutePropsMixin.HttpGatewayRouteProperty(*, action=None, match=None)

Bases: object

An object that represents an HTTP gateway route.

Parameters:

action (Union[IResolvable, HttpGatewayRouteActionProperty, Dict[str, Any], None]) – An object that represents the action to take if a match is determined.
match (Union[IResolvable, HttpGatewayRouteMatchProperty, Dict[str, Any], None]) – An object that represents the criteria for determining a request match.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-httpgatewayroute.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_appmesh import mixins as appmesh_mixins

http_gateway_route_property = appmesh_mixins.CfnGatewayRoutePropsMixin.HttpGatewayRouteProperty(
    action=appmesh_mixins.CfnGatewayRoutePropsMixin.HttpGatewayRouteActionProperty(
        rewrite=appmesh_mixins.CfnGatewayRoutePropsMixin.HttpGatewayRouteRewriteProperty(
            hostname=appmesh_mixins.CfnGatewayRoutePropsMixin.GatewayRouteHostnameRewriteProperty(
                default_target_hostname="defaultTargetHostname"
            ),
            path=appmesh_mixins.CfnGatewayRoutePropsMixin.HttpGatewayRoutePathRewriteProperty(
                exact="exact"
            ),
            prefix=appmesh_mixins.CfnGatewayRoutePropsMixin.HttpGatewayRoutePrefixRewriteProperty(
                default_prefix="defaultPrefix",
                value="value"
            )
        ),
        target=appmesh_mixins.CfnGatewayRoutePropsMixin.GatewayRouteTargetProperty(
            port=123,
            virtual_service=appmesh_mixins.CfnGatewayRoutePropsMixin.GatewayRouteVirtualServiceProperty(
                virtual_service_name="virtualServiceName"
            )
        )
    ),
    match=appmesh_mixins.CfnGatewayRoutePropsMixin.HttpGatewayRouteMatchProperty(
        headers=[appmesh_mixins.CfnGatewayRoutePropsMixin.HttpGatewayRouteHeaderProperty(
            invert=False,
            match=appmesh_mixins.CfnGatewayRoutePropsMixin.HttpGatewayRouteHeaderMatchProperty(
                exact="exact",
                prefix="prefix",
                range=appmesh_mixins.CfnGatewayRoutePropsMixin.GatewayRouteRangeMatchProperty(
                    end=123,
                    start=123
                ),
                regex="regex",
                suffix="suffix"
            ),
            name="name"
        )],
        hostname=appmesh_mixins.CfnGatewayRoutePropsMixin.GatewayRouteHostnameMatchProperty(
            exact="exact",
            suffix="suffix"
        ),
        method="method",
        path=appmesh_mixins.CfnGatewayRoutePropsMixin.HttpPathMatchProperty(
            exact="exact",
            regex="regex"
        ),
        port=123,
        prefix="prefix",
        query_parameters=[appmesh_mixins.CfnGatewayRoutePropsMixin.QueryParameterProperty(
            match=appmesh_mixins.CfnGatewayRoutePropsMixin.HttpQueryParameterMatchProperty(
                exact="exact"
            ),
            name="name"
        )]
    )
)

Attributes

action

An object that represents the action to take if a match is determined.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-httpgatewayroute.html#cfn-appmesh-gatewayroute-httpgatewayroute-action

match

An object that represents the criteria for determining a request match.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-httpgatewayroute.html#cfn-appmesh-gatewayroute-httpgatewayroute-match

HttpGatewayRouteRewriteProperty

class CfnGatewayRoutePropsMixin.HttpGatewayRouteRewriteProperty(*, hostname=None, path=None, prefix=None)

Bases: object

An object representing the gateway route to rewrite.

Parameters:

hostname (Union[IResolvable, GatewayRouteHostnameRewriteProperty, Dict[str, Any], None]) – The host name to rewrite.
path (Union[IResolvable, HttpGatewayRoutePathRewriteProperty, Dict[str, Any], None]) – The path to rewrite.
prefix (Union[IResolvable, HttpGatewayRoutePrefixRewriteProperty, Dict[str, Any], None]) – The specified beginning characters to rewrite.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-httpgatewayrouterewrite.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_appmesh import mixins as appmesh_mixins

http_gateway_route_rewrite_property = appmesh_mixins.CfnGatewayRoutePropsMixin.HttpGatewayRouteRewriteProperty(
    hostname=appmesh_mixins.CfnGatewayRoutePropsMixin.GatewayRouteHostnameRewriteProperty(
        default_target_hostname="defaultTargetHostname"
    ),
    path=appmesh_mixins.CfnGatewayRoutePropsMixin.HttpGatewayRoutePathRewriteProperty(
        exact="exact"
    ),
    prefix=appmesh_mixins.CfnGatewayRoutePropsMixin.HttpGatewayRoutePrefixRewriteProperty(
        default_prefix="defaultPrefix",
        value="value"
    )
)

Attributes

hostname

The host name to rewrite.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-httpgatewayrouterewrite.html#cfn-appmesh-gatewayroute-httpgatewayrouterewrite-hostname

path

The path to rewrite.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-httpgatewayrouterewrite.html#cfn-appmesh-gatewayroute-httpgatewayrouterewrite-path

prefix

The specified beginning characters to rewrite.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-httpgatewayrouterewrite.html#cfn-appmesh-gatewayroute-httpgatewayrouterewrite-prefix

HttpPathMatchProperty

class CfnGatewayRoutePropsMixin.HttpPathMatchProperty(*, exact=None, regex=None)

Bases: object

An object representing the path to match in the request.

Parameters:

exact (Optional[str]) – The exact path to match on.
regex (Optional[str]) – The regex used to match the path.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-httppathmatch.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_appmesh import mixins as appmesh_mixins

http_path_match_property = appmesh_mixins.CfnGatewayRoutePropsMixin.HttpPathMatchProperty(
    exact="exact",
    regex="regex"
)

Attributes

exact

The exact path to match on.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-httppathmatch.html#cfn-appmesh-gatewayroute-httppathmatch-exact

regex

The regex used to match the path.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-httppathmatch.html#cfn-appmesh-gatewayroute-httppathmatch-regex

HttpQueryParameterMatchProperty

class CfnGatewayRoutePropsMixin.HttpQueryParameterMatchProperty(*, exact=None)

Bases: object

An object representing the query parameter to match.

Parameters:: exact (Optional[str]) – The exact query parameter to match on.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-httpqueryparametermatch.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_appmesh import mixins as appmesh_mixins

http_query_parameter_match_property = appmesh_mixins.CfnGatewayRoutePropsMixin.HttpQueryParameterMatchProperty(
    exact="exact"
)

Attributes

exact

The exact query parameter to match on.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-httpqueryparametermatch.html#cfn-appmesh-gatewayroute-httpqueryparametermatch-exact

QueryParameterProperty

class CfnGatewayRoutePropsMixin.QueryParameterProperty(*, match=None, name=None)

Bases: object

An object that represents the query parameter in the request.

Parameters:

match (Union[IResolvable, HttpQueryParameterMatchProperty, Dict[str, Any], None]) – The query parameter to match on.
name (Optional[str]) – A name for the query parameter that will be matched on.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-queryparameter.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_appmesh import mixins as appmesh_mixins

query_parameter_property = appmesh_mixins.CfnGatewayRoutePropsMixin.QueryParameterProperty(
    match=appmesh_mixins.CfnGatewayRoutePropsMixin.HttpQueryParameterMatchProperty(
        exact="exact"
    ),
    name="name"
)

Attributes

match

The query parameter to match on.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-queryparameter.html#cfn-appmesh-gatewayroute-queryparameter-match

name

A name for the query parameter that will be matched on.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-gatewayroute-queryparameter.html#cfn-appmesh-gatewayroute-queryparameter-name