CfnGatewayRoute

class aws_cdk.aws_appmesh.CfnGatewayRoute(scope, id, *, mesh_name, spec, virtual_gateway_name, gateway_route_name=None, mesh_owner=None, tags=None)

Bases: aws_cdk.core.CfnResource

A CloudFormation AWS::AppMesh::GatewayRoute.

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 .

CloudformationResource

AWS::AppMesh::GatewayRoute

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appmesh-gatewayroute.html

ExampleMetadata

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_appmesh as appmesh

cfn_gateway_route = appmesh.CfnGatewayRoute(self, "MyCfnGatewayRoute",
    mesh_name="meshName",
    spec=appmesh.CfnGatewayRoute.GatewayRouteSpecProperty(
        grpc_route=appmesh.CfnGatewayRoute.GrpcGatewayRouteProperty(
            action=appmesh.CfnGatewayRoute.GrpcGatewayRouteActionProperty(
                target=appmesh.CfnGatewayRoute.GatewayRouteTargetProperty(
                    virtual_service=appmesh.CfnGatewayRoute.GatewayRouteVirtualServiceProperty(
                        virtual_service_name="virtualServiceName"
                    )
                ),

                # the properties below are optional
                rewrite=appmesh.CfnGatewayRoute.GrpcGatewayRouteRewriteProperty(
                    hostname=appmesh.CfnGatewayRoute.GatewayRouteHostnameRewriteProperty(
                        default_target_hostname="defaultTargetHostname"
                    )
                )
            ),
            match=appmesh.CfnGatewayRoute.GrpcGatewayRouteMatchProperty(
                hostname=appmesh.CfnGatewayRoute.GatewayRouteHostnameMatchProperty(
                    exact="exact",
                    suffix="suffix"
                ),
                metadata=[appmesh.CfnGatewayRoute.GrpcGatewayRouteMetadataProperty(
                    name="name",

                    # the properties below are optional
                    invert=False,
                    match=appmesh.CfnGatewayRoute.GatewayRouteMetadataMatchProperty(
                        exact="exact",
                        prefix="prefix",
                        range=appmesh.CfnGatewayRoute.GatewayRouteRangeMatchProperty(
                            end=123,
                            start=123
                        ),
                        regex="regex",
                        suffix="suffix"
                    )
                )],
                service_name="serviceName"
            )
        ),
        http2_route=appmesh.CfnGatewayRoute.HttpGatewayRouteProperty(
            action=appmesh.CfnGatewayRoute.HttpGatewayRouteActionProperty(
                target=appmesh.CfnGatewayRoute.GatewayRouteTargetProperty(
                    virtual_service=appmesh.CfnGatewayRoute.GatewayRouteVirtualServiceProperty(
                        virtual_service_name="virtualServiceName"
                    )
                ),

                # the properties below are optional
                rewrite=appmesh.CfnGatewayRoute.HttpGatewayRouteRewriteProperty(
                    hostname=appmesh.CfnGatewayRoute.GatewayRouteHostnameRewriteProperty(
                        default_target_hostname="defaultTargetHostname"
                    ),
                    path=appmesh.CfnGatewayRoute.HttpGatewayRoutePathRewriteProperty(
                        exact="exact"
                    ),
                    prefix=appmesh.CfnGatewayRoute.HttpGatewayRoutePrefixRewriteProperty(
                        default_prefix="defaultPrefix",
                        value="value"
                    )
                )
            ),
            match=appmesh.CfnGatewayRoute.HttpGatewayRouteMatchProperty(
                headers=[appmesh.CfnGatewayRoute.HttpGatewayRouteHeaderProperty(
                    name="name",

                    # the properties below are optional
                    invert=False,
                    match=appmesh.CfnGatewayRoute.HttpGatewayRouteHeaderMatchProperty(
                        exact="exact",
                        prefix="prefix",
                        range=appmesh.CfnGatewayRoute.GatewayRouteRangeMatchProperty(
                            end=123,
                            start=123
                        ),
                        regex="regex",
                        suffix="suffix"
                    )
                )],
                hostname=appmesh.CfnGatewayRoute.GatewayRouteHostnameMatchProperty(
                    exact="exact",
                    suffix="suffix"
                ),
                method="method",
                path=appmesh.CfnGatewayRoute.HttpPathMatchProperty(
                    exact="exact",
                    regex="regex"
                ),
                prefix="prefix",
                query_parameters=[appmesh.CfnGatewayRoute.QueryParameterProperty(
                    name="name",

                    # the properties below are optional
                    match=appmesh.CfnGatewayRoute.HttpQueryParameterMatchProperty(
                        exact="exact"
                    )
                )]
            )
        ),
        http_route=appmesh.CfnGatewayRoute.HttpGatewayRouteProperty(
            action=appmesh.CfnGatewayRoute.HttpGatewayRouteActionProperty(
                target=appmesh.CfnGatewayRoute.GatewayRouteTargetProperty(
                    virtual_service=appmesh.CfnGatewayRoute.GatewayRouteVirtualServiceProperty(
                        virtual_service_name="virtualServiceName"
                    )
                ),

                # the properties below are optional
                rewrite=appmesh.CfnGatewayRoute.HttpGatewayRouteRewriteProperty(
                    hostname=appmesh.CfnGatewayRoute.GatewayRouteHostnameRewriteProperty(
                        default_target_hostname="defaultTargetHostname"
                    ),
                    path=appmesh.CfnGatewayRoute.HttpGatewayRoutePathRewriteProperty(
                        exact="exact"
                    ),
                    prefix=appmesh.CfnGatewayRoute.HttpGatewayRoutePrefixRewriteProperty(
                        default_prefix="defaultPrefix",
                        value="value"
                    )
                )
            ),
            match=appmesh.CfnGatewayRoute.HttpGatewayRouteMatchProperty(
                headers=[appmesh.CfnGatewayRoute.HttpGatewayRouteHeaderProperty(
                    name="name",

                    # the properties below are optional
                    invert=False,
                    match=appmesh.CfnGatewayRoute.HttpGatewayRouteHeaderMatchProperty(
                        exact="exact",
                        prefix="prefix",
                        range=appmesh.CfnGatewayRoute.GatewayRouteRangeMatchProperty(
                            end=123,
                            start=123
                        ),
                        regex="regex",
                        suffix="suffix"
                    )
                )],
                hostname=appmesh.CfnGatewayRoute.GatewayRouteHostnameMatchProperty(
                    exact="exact",
                    suffix="suffix"
                ),
                method="method",
                path=appmesh.CfnGatewayRoute.HttpPathMatchProperty(
                    exact="exact",
                    regex="regex"
                ),
                prefix="prefix",
                query_parameters=[appmesh.CfnGatewayRoute.QueryParameterProperty(
                    name="name",

                    # the properties below are optional
                    match=appmesh.CfnGatewayRoute.HttpQueryParameterMatchProperty(
                        exact="exact"
                    )
                )]
            )
        ),
        priority=123
    ),
    virtual_gateway_name="virtualGatewayName",

    # the properties below are optional
    gateway_route_name="gatewayRouteName",
    mesh_owner="meshOwner",
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)

Create a new AWS::AppMesh::GatewayRoute.

Parameters
  • scope (Construct) –

    • scope in which this resource is defined.

  • id (str) –

    • scoped id of the resource.

  • mesh_name (str) – The name of the service mesh that the resource resides in.

  • spec (Union[GatewayRouteSpecProperty, IResolvable]) – The specifications of the gateway route.

  • virtual_gateway_name (str) – The virtual gateway that the gateway route is associated with.

  • gateway_route_name (Optional[str]) – The name of the gateway route.

  • mesh_owner (Optional[str]) – The AWS IAM account ID of the service mesh owner. If the account ID is not your own, then it’s the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes .

  • tags (Optional[Sequence[CfnTag]]) – Optional metadata that you can apply to the gateway route to assist with categorization and organization. Each tag consists of a key and an optional value, both of which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.

Methods

add_deletion_override(path)

Syntactic sugar for addOverride(path, undefined).

Parameters

path (str) – The path of the value to delete.

Return type

None

add_depends_on(target)

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

Parameters

target (CfnResource) –

Return type

None

add_metadata(key, value)

Add a value to the CloudFormation Resource Metadata.

Parameters
  • key (str) –

  • value (Any) –

See

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

Return type

None

add_override(path, value)

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use addPropertyOverride or prefix path with “Properties.” (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example:

cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides Example:

"Properties": {
   "GlobalSecondaryIndexes": [
     {
       "Projection": {
         "NonKeyAttributes": [ "myattribute" ]
         ...
       }
       ...
     },
     {
       "ProjectionType": "INCLUDE"
       ...
     },
   ]
   ...
}

The value argument to addOverride will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

Parameters
  • path (str) –

    • The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.

  • value (Any) –

    • The value. Could be primitive or complex.

Return type

None

add_property_deletion_override(property_path)

Adds an override that deletes the value of a property from the resource definition.

Parameters

property_path (str) – The path to the property.

Return type

None

add_property_override(property_path, value)

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

Parameters
  • property_path (str) – The path of the property.

  • value (Any) – The value.

Return type

None

apply_removal_policy(policy=None, *, apply_to_update_replace_policy=None, default=None)

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you’ve removed it from the CDK application or because you’ve made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

Parameters
  • policy (Optional[RemovalPolicy]) –

  • apply_to_update_replace_policy (Optional[bool]) – Apply the same deletion policy to the resource’s “UpdateReplacePolicy”. Default: true

  • default (Optional[RemovalPolicy]) – The default policy to apply in case the removal policy is not defined. Default: - Default value is resource specific. To determine the default value for a resoure, please consult that specific resource’s documentation.

Return type

None

get_att(attribute_name)

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters

attribute_name (str) – The name of the attribute.

Return type

Reference

get_metadata(key)

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters

key (str) –

See

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

Return type

Any

inspect(inspector)

Examines the CloudFormation resource and discloses attributes.

Parameters

inspector (TreeInspector) –

  • tree inspector to collect and process attributes.

Return type

None

override_logical_id(new_logical_id)

Overrides the auto-generated logical ID with a specific ID.

Parameters

new_logical_id (str) – The new logical ID to use for this stack element.

Return type

None

to_string()

Returns a string representation of this construct.

Return type

str

Returns

a string representation of this resource

Attributes

CFN_RESOURCE_TYPE_NAME = 'AWS::AppMesh::GatewayRoute'
attr_arn

The full Amazon Resource Name (ARN) for the gateway route.

CloudformationAttribute

Arn

Return type

str

attr_gateway_route_name

The name of the gateway route.

CloudformationAttribute

GatewayRouteName

Return type

str

attr_mesh_name

The name of the service mesh that the gateway route resides in.

CloudformationAttribute

MeshName

Return type

str

attr_mesh_owner

The AWS IAM account ID of the service mesh owner.

If the account ID is not your own, then it’s the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with Shared Meshes .

CloudformationAttribute

MeshOwner

Return type

str

attr_resource_owner

The IAM account ID of the resource owner.

If the account ID is not your own, then it’s the ID of the mesh owner or of another account that the mesh is shared with. For more information about mesh sharing, see Working with Shared Meshes .

CloudformationAttribute

ResourceOwner

Return type

str

attr_uid

The unique identifier for the gateway route.

CloudformationAttribute

Uid

Return type

str

attr_virtual_gateway_name

The name of the virtual gateway that the gateway route is associated with.

CloudformationAttribute

VirtualGatewayName

Return type

str

cfn_options

Options for this resource, such as condition, update policy etc.

Return type

ICfnResourceOptions

cfn_resource_type

AWS resource type.

Return type

str

creation_stack

return:

the stack trace of the point where this Resource was created from, sourced from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most node +internal+ entries filtered.

Return type

List[str]

gateway_route_name

The name of the gateway route.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appmesh-gatewayroute.html#cfn-appmesh-gatewayroute-gatewayroutename

Return type

Optional[str]

logical_id

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

Return type

str

Returns

the logical ID as a stringified token. This value will only get resolved during synthesis.

mesh_name

The name of the service mesh that the resource resides in.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appmesh-gatewayroute.html#cfn-appmesh-gatewayroute-meshname

Return type

str

mesh_owner

The AWS IAM account ID of the service mesh owner.

If the account ID is not your own, then it’s the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes .

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appmesh-gatewayroute.html#cfn-appmesh-gatewayroute-meshowner

Return type

Optional[str]

node

The construct tree node associated with this construct.

Return type

ConstructNode

ref

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

Return type

str

spec

The specifications of the gateway route.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appmesh-gatewayroute.html#cfn-appmesh-gatewayroute-spec

Return type

Union[GatewayRouteSpecProperty, IResolvable]

stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

Return type

Stack

tags

Optional metadata that you can apply to the gateway route to assist with categorization and organization.

Each tag consists of a key and an optional value, both of which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appmesh-gatewayroute.html#cfn-appmesh-gatewayroute-tags

Return type

TagManager

virtual_gateway_name

The virtual gateway that the gateway route is associated with.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appmesh-gatewayroute.html#cfn-appmesh-gatewayroute-virtualgatewayname

Return type

str

Static Methods

classmethod is_cfn_element(x)

Returns true if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of instanceof to allow stack elements from different versions of this library to be included in the same stack.

Parameters

x (Any) –

Return type

bool

Returns

The construct as a stack element or undefined if it is not a stack element.

classmethod is_cfn_resource(construct)

Check whether the given construct is a CfnResource.

Parameters

construct (IConstruct) –

Return type

bool

classmethod is_construct(x)

Return whether the given object is a Construct.

Parameters

x (Any) –

Return type

bool

GatewayRouteHostnameMatchProperty

class CfnGatewayRoute.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.

Link

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.
import aws_cdk.aws_appmesh as appmesh

gateway_route_hostname_match_property = appmesh.CfnGatewayRoute.GatewayRouteHostnameMatchProperty(
    exact="exact",
    suffix="suffix"
)

Attributes

exact

The exact host name to match on.

Link

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

Return type

Optional[str]

suffix

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

Link

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

Return type

Optional[str]

GatewayRouteHostnameRewriteProperty

class CfnGatewayRoute.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.

Link

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.
import aws_cdk.aws_appmesh as appmesh

gateway_route_hostname_rewrite_property = appmesh.CfnGatewayRoute.GatewayRouteHostnameRewriteProperty(
    default_target_hostname="defaultTargetHostname"
)

Attributes

default_target_hostname

The default target host name to write to.

Link

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

Return type

Optional[str]

GatewayRouteMetadataMatchProperty

class CfnGatewayRoute.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, 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.

Link

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.
import aws_cdk.aws_appmesh as appmesh

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

Attributes

exact

The exact method header to be matched on.

Link

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

Return type

Optional[str]

prefix

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

Link

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

Return type

Optional[str]

range

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

Link

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

Return type

Union[IResolvable, GatewayRouteRangeMatchProperty, None]

regex

The regex used to match the method header.

Link

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

Return type

Optional[str]

suffix

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

Link

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

Return type

Optional[str]

GatewayRouteRangeMatchProperty

class CfnGatewayRoute.GatewayRouteRangeMatchProperty(*, end, start)

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]) – The end of the range.

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

Link

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.
import aws_cdk.aws_appmesh as appmesh

gateway_route_range_match_property = appmesh.CfnGatewayRoute.GatewayRouteRangeMatchProperty(
    end=123,
    start=123
)

Attributes

end

The end of the range.

Link

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

Return type

Union[int, float]

start

The start of the range.

Link

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

Return type

Union[int, float]

GatewayRouteSpecProperty

class CfnGatewayRoute.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
Link

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.
import aws_cdk.aws_appmesh as appmesh

gateway_route_spec_property = appmesh.CfnGatewayRoute.GatewayRouteSpecProperty(
    grpc_route=appmesh.CfnGatewayRoute.GrpcGatewayRouteProperty(
        action=appmesh.CfnGatewayRoute.GrpcGatewayRouteActionProperty(
            target=appmesh.CfnGatewayRoute.GatewayRouteTargetProperty(
                virtual_service=appmesh.CfnGatewayRoute.GatewayRouteVirtualServiceProperty(
                    virtual_service_name="virtualServiceName"
                )
            ),

            # the properties below are optional
            rewrite=appmesh.CfnGatewayRoute.GrpcGatewayRouteRewriteProperty(
                hostname=appmesh.CfnGatewayRoute.GatewayRouteHostnameRewriteProperty(
                    default_target_hostname="defaultTargetHostname"
                )
            )
        ),
        match=appmesh.CfnGatewayRoute.GrpcGatewayRouteMatchProperty(
            hostname=appmesh.CfnGatewayRoute.GatewayRouteHostnameMatchProperty(
                exact="exact",
                suffix="suffix"
            ),
            metadata=[appmesh.CfnGatewayRoute.GrpcGatewayRouteMetadataProperty(
                name="name",

                # the properties below are optional
                invert=False,
                match=appmesh.CfnGatewayRoute.GatewayRouteMetadataMatchProperty(
                    exact="exact",
                    prefix="prefix",
                    range=appmesh.CfnGatewayRoute.GatewayRouteRangeMatchProperty(
                        end=123,
                        start=123
                    ),
                    regex="regex",
                    suffix="suffix"
                )
            )],
            service_name="serviceName"
        )
    ),
    http2_route=appmesh.CfnGatewayRoute.HttpGatewayRouteProperty(
        action=appmesh.CfnGatewayRoute.HttpGatewayRouteActionProperty(
            target=appmesh.CfnGatewayRoute.GatewayRouteTargetProperty(
                virtual_service=appmesh.CfnGatewayRoute.GatewayRouteVirtualServiceProperty(
                    virtual_service_name="virtualServiceName"
                )
            ),

            # the properties below are optional
            rewrite=appmesh.CfnGatewayRoute.HttpGatewayRouteRewriteProperty(
                hostname=appmesh.CfnGatewayRoute.GatewayRouteHostnameRewriteProperty(
                    default_target_hostname="defaultTargetHostname"
                ),
                path=appmesh.CfnGatewayRoute.HttpGatewayRoutePathRewriteProperty(
                    exact="exact"
                ),
                prefix=appmesh.CfnGatewayRoute.HttpGatewayRoutePrefixRewriteProperty(
                    default_prefix="defaultPrefix",
                    value="value"
                )
            )
        ),
        match=appmesh.CfnGatewayRoute.HttpGatewayRouteMatchProperty(
            headers=[appmesh.CfnGatewayRoute.HttpGatewayRouteHeaderProperty(
                name="name",

                # the properties below are optional
                invert=False,
                match=appmesh.CfnGatewayRoute.HttpGatewayRouteHeaderMatchProperty(
                    exact="exact",
                    prefix="prefix",
                    range=appmesh.CfnGatewayRoute.GatewayRouteRangeMatchProperty(
                        end=123,
                        start=123
                    ),
                    regex="regex",
                    suffix="suffix"
                )
            )],
            hostname=appmesh.CfnGatewayRoute.GatewayRouteHostnameMatchProperty(
                exact="exact",
                suffix="suffix"
            ),
            method="method",
            path=appmesh.CfnGatewayRoute.HttpPathMatchProperty(
                exact="exact",
                regex="regex"
            ),
            prefix="prefix",
            query_parameters=[appmesh.CfnGatewayRoute.QueryParameterProperty(
                name="name",

                # the properties below are optional
                match=appmesh.CfnGatewayRoute.HttpQueryParameterMatchProperty(
                    exact="exact"
                )
            )]
        )
    ),
    http_route=appmesh.CfnGatewayRoute.HttpGatewayRouteProperty(
        action=appmesh.CfnGatewayRoute.HttpGatewayRouteActionProperty(
            target=appmesh.CfnGatewayRoute.GatewayRouteTargetProperty(
                virtual_service=appmesh.CfnGatewayRoute.GatewayRouteVirtualServiceProperty(
                    virtual_service_name="virtualServiceName"
                )
            ),

            # the properties below are optional
            rewrite=appmesh.CfnGatewayRoute.HttpGatewayRouteRewriteProperty(
                hostname=appmesh.CfnGatewayRoute.GatewayRouteHostnameRewriteProperty(
                    default_target_hostname="defaultTargetHostname"
                ),
                path=appmesh.CfnGatewayRoute.HttpGatewayRoutePathRewriteProperty(
                    exact="exact"
                ),
                prefix=appmesh.CfnGatewayRoute.HttpGatewayRoutePrefixRewriteProperty(
                    default_prefix="defaultPrefix",
                    value="value"
                )
            )
        ),
        match=appmesh.CfnGatewayRoute.HttpGatewayRouteMatchProperty(
            headers=[appmesh.CfnGatewayRoute.HttpGatewayRouteHeaderProperty(
                name="name",

                # the properties below are optional
                invert=False,
                match=appmesh.CfnGatewayRoute.HttpGatewayRouteHeaderMatchProperty(
                    exact="exact",
                    prefix="prefix",
                    range=appmesh.CfnGatewayRoute.GatewayRouteRangeMatchProperty(
                        end=123,
                        start=123
                    ),
                    regex="regex",
                    suffix="suffix"
                )
            )],
            hostname=appmesh.CfnGatewayRoute.GatewayRouteHostnameMatchProperty(
                exact="exact",
                suffix="suffix"
            ),
            method="method",
            path=appmesh.CfnGatewayRoute.HttpPathMatchProperty(
                exact="exact",
                regex="regex"
            ),
            prefix="prefix",
            query_parameters=[appmesh.CfnGatewayRoute.QueryParameterProperty(
                name="name",

                # the properties below are optional
                match=appmesh.CfnGatewayRoute.HttpQueryParameterMatchProperty(
                    exact="exact"
                )
            )]
        )
    ),
    priority=123
)

Attributes

grpc_route

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

Link

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

Return type

Union[IResolvable, GrpcGatewayRouteProperty, None]

http2_route

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

Link

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

Return type

Union[IResolvable, HttpGatewayRouteProperty, None]

http_route

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

Link

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

Return type

Union[IResolvable, HttpGatewayRouteProperty, None]

priority

The ordering of the gateway routes spec.

Link

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

Return type

Union[int, float, None]

GatewayRouteTargetProperty

class CfnGatewayRoute.GatewayRouteTargetProperty(*, virtual_service)

Bases: object

An object that represents a gateway route target.

Parameters

virtual_service (Union[IResolvable, GatewayRouteVirtualServiceProperty]) – An object that represents a virtual service gateway route target.

Link

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.
import aws_cdk.aws_appmesh as appmesh

gateway_route_target_property = appmesh.CfnGatewayRoute.GatewayRouteTargetProperty(
    virtual_service=appmesh.CfnGatewayRoute.GatewayRouteVirtualServiceProperty(
        virtual_service_name="virtualServiceName"
    )
)

Attributes

virtual_service

An object that represents a virtual service gateway route target.

Link

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

Return type

Union[IResolvable, GatewayRouteVirtualServiceProperty]

GatewayRouteVirtualServiceProperty

class CfnGatewayRoute.GatewayRouteVirtualServiceProperty(*, virtual_service_name)

Bases: object

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

Parameters

virtual_service_name (str) – The name of the virtual service that traffic is routed to.

Link

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.
import aws_cdk.aws_appmesh as appmesh

gateway_route_virtual_service_property = appmesh.CfnGatewayRoute.GatewayRouteVirtualServiceProperty(
    virtual_service_name="virtualServiceName"
)

Attributes

virtual_service_name

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

Link

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

Return type

str

GrpcGatewayRouteActionProperty

class CfnGatewayRoute.GrpcGatewayRouteActionProperty(*, target, rewrite=None)

Bases: object

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

Parameters
Link

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.
import aws_cdk.aws_appmesh as appmesh

grpc_gateway_route_action_property = appmesh.CfnGatewayRoute.GrpcGatewayRouteActionProperty(
    target=appmesh.CfnGatewayRoute.GatewayRouteTargetProperty(
        virtual_service=appmesh.CfnGatewayRoute.GatewayRouteVirtualServiceProperty(
            virtual_service_name="virtualServiceName"
        )
    ),

    # the properties below are optional
    rewrite=appmesh.CfnGatewayRoute.GrpcGatewayRouteRewriteProperty(
        hostname=appmesh.CfnGatewayRoute.GatewayRouteHostnameRewriteProperty(
            default_target_hostname="defaultTargetHostname"
        )
    )
)

Attributes

rewrite

The gateway route action to rewrite.

Link

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

Return type

Union[IResolvable, GrpcGatewayRouteRewriteProperty, None]

target

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

Link

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

Return type

Union[IResolvable, GatewayRouteTargetProperty]

GrpcGatewayRouteMatchProperty

class CfnGatewayRoute.GrpcGatewayRouteMatchProperty(*, hostname=None, metadata=None, service_name=None)

Bases: object

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

Parameters
Link

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.
import aws_cdk.aws_appmesh as appmesh

grpc_gateway_route_match_property = appmesh.CfnGatewayRoute.GrpcGatewayRouteMatchProperty(
    hostname=appmesh.CfnGatewayRoute.GatewayRouteHostnameMatchProperty(
        exact="exact",
        suffix="suffix"
    ),
    metadata=[appmesh.CfnGatewayRoute.GrpcGatewayRouteMetadataProperty(
        name="name",

        # the properties below are optional
        invert=False,
        match=appmesh.CfnGatewayRoute.GatewayRouteMetadataMatchProperty(
            exact="exact",
            prefix="prefix",
            range=appmesh.CfnGatewayRoute.GatewayRouteRangeMatchProperty(
                end=123,
                start=123
            ),
            regex="regex",
            suffix="suffix"
        )
    )],
    service_name="serviceName"
)

Attributes

hostname

The gateway route host name to be matched on.

Link

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

Return type

Union[IResolvable, GatewayRouteHostnameMatchProperty, None]

metadata

The gateway route metadata to be matched on.

Link

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

Return type

Union[IResolvable, List[Union[IResolvable, GrpcGatewayRouteMetadataProperty]], None]

service_name

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

Link

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

Return type

Optional[str]

GrpcGatewayRouteMetadataProperty

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

Bases: object

An object representing the metadata of the gateway route.

Parameters
  • name (str) – A name for the gateway route metadata.

  • invert (Union[bool, IResolvable, None]) – Specify True to match anything except the match criteria. The default value is False .

  • match (Union[IResolvable, GatewayRouteMetadataMatchProperty, None]) – The criteria for determining a metadata match.

Link

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.
import aws_cdk.aws_appmesh as appmesh

grpc_gateway_route_metadata_property = appmesh.CfnGatewayRoute.GrpcGatewayRouteMetadataProperty(
    name="name",

    # the properties below are optional
    invert=False,
    match=appmesh.CfnGatewayRoute.GatewayRouteMetadataMatchProperty(
        exact="exact",
        prefix="prefix",
        range=appmesh.CfnGatewayRoute.GatewayRouteRangeMatchProperty(
            end=123,
            start=123
        ),
        regex="regex",
        suffix="suffix"
    )
)

Attributes

invert

Specify True to match anything except the match criteria.

The default value is False .

Link

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

Return type

Union[bool, IResolvable, None]

match

The criteria for determining a metadata match.

Link

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

Return type

Union[IResolvable, GatewayRouteMetadataMatchProperty, None]

name

A name for the gateway route metadata.

Link

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

Return type

str

GrpcGatewayRouteProperty

class CfnGatewayRoute.GrpcGatewayRouteProperty(*, action, match)

Bases: object

An object that represents a gRPC gateway route.

Parameters
Link

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.
import aws_cdk.aws_appmesh as appmesh

grpc_gateway_route_property = appmesh.CfnGatewayRoute.GrpcGatewayRouteProperty(
    action=appmesh.CfnGatewayRoute.GrpcGatewayRouteActionProperty(
        target=appmesh.CfnGatewayRoute.GatewayRouteTargetProperty(
            virtual_service=appmesh.CfnGatewayRoute.GatewayRouteVirtualServiceProperty(
                virtual_service_name="virtualServiceName"
            )
        ),

        # the properties below are optional
        rewrite=appmesh.CfnGatewayRoute.GrpcGatewayRouteRewriteProperty(
            hostname=appmesh.CfnGatewayRoute.GatewayRouteHostnameRewriteProperty(
                default_target_hostname="defaultTargetHostname"
            )
        )
    ),
    match=appmesh.CfnGatewayRoute.GrpcGatewayRouteMatchProperty(
        hostname=appmesh.CfnGatewayRoute.GatewayRouteHostnameMatchProperty(
            exact="exact",
            suffix="suffix"
        ),
        metadata=[appmesh.CfnGatewayRoute.GrpcGatewayRouteMetadataProperty(
            name="name",

            # the properties below are optional
            invert=False,
            match=appmesh.CfnGatewayRoute.GatewayRouteMetadataMatchProperty(
                exact="exact",
                prefix="prefix",
                range=appmesh.CfnGatewayRoute.GatewayRouteRangeMatchProperty(
                    end=123,
                    start=123
                ),
                regex="regex",
                suffix="suffix"
            )
        )],
        service_name="serviceName"
    )
)

Attributes

action

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

Link

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

Return type

Union[IResolvable, GrpcGatewayRouteActionProperty]

match

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

Link

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

Return type

Union[IResolvable, GrpcGatewayRouteMatchProperty]

GrpcGatewayRouteRewriteProperty

class CfnGatewayRoute.GrpcGatewayRouteRewriteProperty(*, hostname=None)

Bases: object

An object that represents the gateway route to rewrite.

Parameters

hostname (Union[IResolvable, GatewayRouteHostnameRewriteProperty, None]) – The host name of the gateway route to rewrite.

Link

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.
import aws_cdk.aws_appmesh as appmesh

grpc_gateway_route_rewrite_property = appmesh.CfnGatewayRoute.GrpcGatewayRouteRewriteProperty(
    hostname=appmesh.CfnGatewayRoute.GatewayRouteHostnameRewriteProperty(
        default_target_hostname="defaultTargetHostname"
    )
)

Attributes

hostname

The host name of the gateway route to rewrite.

Link

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

Return type

Union[IResolvable, GatewayRouteHostnameRewriteProperty, None]

HttpGatewayRouteActionProperty

class CfnGatewayRoute.HttpGatewayRouteActionProperty(*, target, rewrite=None)

Bases: object

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

Parameters
Link

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.
import aws_cdk.aws_appmesh as appmesh

http_gateway_route_action_property = appmesh.CfnGatewayRoute.HttpGatewayRouteActionProperty(
    target=appmesh.CfnGatewayRoute.GatewayRouteTargetProperty(
        virtual_service=appmesh.CfnGatewayRoute.GatewayRouteVirtualServiceProperty(
            virtual_service_name="virtualServiceName"
        )
    ),

    # the properties below are optional
    rewrite=appmesh.CfnGatewayRoute.HttpGatewayRouteRewriteProperty(
        hostname=appmesh.CfnGatewayRoute.GatewayRouteHostnameRewriteProperty(
            default_target_hostname="defaultTargetHostname"
        ),
        path=appmesh.CfnGatewayRoute.HttpGatewayRoutePathRewriteProperty(
            exact="exact"
        ),
        prefix=appmesh.CfnGatewayRoute.HttpGatewayRoutePrefixRewriteProperty(
            default_prefix="defaultPrefix",
            value="value"
        )
    )
)

Attributes

rewrite

The gateway route action to rewrite.

Link

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

Return type

Union[IResolvable, HttpGatewayRouteRewriteProperty, None]

target

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

Link

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

Return type

Union[IResolvable, GatewayRouteTargetProperty]

HttpGatewayRouteHeaderMatchProperty

class CfnGatewayRoute.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, 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.

Link

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.
import aws_cdk.aws_appmesh as appmesh

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

Attributes

exact

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

Link

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

Return type

Optional[str]

prefix

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

Link

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

Return type

Optional[str]

range

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

Link

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

Return type

Union[IResolvable, GatewayRouteRangeMatchProperty, None]

regex

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

Link

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

Return type

Optional[str]

suffix

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

Link

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

Return type

Optional[str]

HttpGatewayRouteHeaderProperty

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

Bases: object

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

Parameters
  • name (str) – A name for the HTTP header in the gateway route that will be matched on.

  • invert (Union[bool, IResolvable, None]) – Specify True to match anything except the match criteria. The default value is False .

  • match (Union[IResolvable, HttpGatewayRouteHeaderMatchProperty, None]) – An object that represents the method and value to match with the header value sent in a request. Specify one match method.

Link

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.
import aws_cdk.aws_appmesh as appmesh

http_gateway_route_header_property = appmesh.CfnGatewayRoute.HttpGatewayRouteHeaderProperty(
    name="name",

    # the properties below are optional
    invert=False,
    match=appmesh.CfnGatewayRoute.HttpGatewayRouteHeaderMatchProperty(
        exact="exact",
        prefix="prefix",
        range=appmesh.CfnGatewayRoute.GatewayRouteRangeMatchProperty(
            end=123,
            start=123
        ),
        regex="regex",
        suffix="suffix"
    )
)

Attributes

invert

Specify True to match anything except the match criteria.

The default value is False .

Link

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

Return type

Union[bool, IResolvable, None]

match

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

Specify one match method.

Link

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

Return type

Union[IResolvable, HttpGatewayRouteHeaderMatchProperty, None]

name

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

Link

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

Return type

str

HttpGatewayRouteMatchProperty

class CfnGatewayRoute.HttpGatewayRouteMatchProperty(*, headers=None, hostname=None, method=None, path=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]], None]) – The client request headers to match on.

  • hostname (Union[IResolvable, GatewayRouteHostnameMatchProperty, None]) – The host name to match on.

  • method (Optional[str]) – The method to match on.

  • path (Union[IResolvable, HttpPathMatchProperty, None]) – The path 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]], None]) – The query parameter to match on.

Link

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.
import aws_cdk.aws_appmesh as appmesh

http_gateway_route_match_property = appmesh.CfnGatewayRoute.HttpGatewayRouteMatchProperty(
    headers=[appmesh.CfnGatewayRoute.HttpGatewayRouteHeaderProperty(
        name="name",

        # the properties below are optional
        invert=False,
        match=appmesh.CfnGatewayRoute.HttpGatewayRouteHeaderMatchProperty(
            exact="exact",
            prefix="prefix",
            range=appmesh.CfnGatewayRoute.GatewayRouteRangeMatchProperty(
                end=123,
                start=123
            ),
            regex="regex",
            suffix="suffix"
        )
    )],
    hostname=appmesh.CfnGatewayRoute.GatewayRouteHostnameMatchProperty(
        exact="exact",
        suffix="suffix"
    ),
    method="method",
    path=appmesh.CfnGatewayRoute.HttpPathMatchProperty(
        exact="exact",
        regex="regex"
    ),
    prefix="prefix",
    query_parameters=[appmesh.CfnGatewayRoute.QueryParameterProperty(
        name="name",

        # the properties below are optional
        match=appmesh.CfnGatewayRoute.HttpQueryParameterMatchProperty(
            exact="exact"
        )
    )]
)

Attributes

headers

The client request headers to match on.

Link

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

Return type

Union[IResolvable, List[Union[IResolvable, HttpGatewayRouteHeaderProperty]], None]

hostname

The host name to match on.

Link

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

Return type

Union[IResolvable, GatewayRouteHostnameMatchProperty, None]

method

The method to match on.

Link

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

Return type

Optional[str]

path

The path to match on.

Link

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

Return type

Union[IResolvable, HttpPathMatchProperty, None]

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 .

Link

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

Return type

Optional[str]

query_parameters

The query parameter to match on.

Link

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

Return type

Union[IResolvable, List[Union[IResolvable, QueryParameterProperty]], None]

HttpGatewayRoutePathRewriteProperty

class CfnGatewayRoute.HttpGatewayRoutePathRewriteProperty(*, exact=None)

Bases: object

An object that represents the path to rewrite.

Parameters

exact (Optional[str]) – The exact path to rewrite.

Link

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.
import aws_cdk.aws_appmesh as appmesh

http_gateway_route_path_rewrite_property = appmesh.CfnGatewayRoute.HttpGatewayRoutePathRewriteProperty(
    exact="exact"
)

Attributes

exact

The exact path to rewrite.

Link

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

Return type

Optional[str]

HttpGatewayRoutePrefixRewriteProperty

class CfnGatewayRoute.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.

Link

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.
import aws_cdk.aws_appmesh as appmesh

http_gateway_route_prefix_rewrite_property = appmesh.CfnGatewayRoute.HttpGatewayRoutePrefixRewriteProperty(
    default_prefix="defaultPrefix",
    value="value"
)

Attributes

default_prefix

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

Link

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

Return type

Optional[str]

value

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

Link

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

Return type

Optional[str]

HttpGatewayRouteProperty

class CfnGatewayRoute.HttpGatewayRouteProperty(*, action, match)

Bases: object

An object that represents an HTTP gateway route.

Parameters
Link

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.
import aws_cdk.aws_appmesh as appmesh

http_gateway_route_property = appmesh.CfnGatewayRoute.HttpGatewayRouteProperty(
    action=appmesh.CfnGatewayRoute.HttpGatewayRouteActionProperty(
        target=appmesh.CfnGatewayRoute.GatewayRouteTargetProperty(
            virtual_service=appmesh.CfnGatewayRoute.GatewayRouteVirtualServiceProperty(
                virtual_service_name="virtualServiceName"
            )
        ),

        # the properties below are optional
        rewrite=appmesh.CfnGatewayRoute.HttpGatewayRouteRewriteProperty(
            hostname=appmesh.CfnGatewayRoute.GatewayRouteHostnameRewriteProperty(
                default_target_hostname="defaultTargetHostname"
            ),
            path=appmesh.CfnGatewayRoute.HttpGatewayRoutePathRewriteProperty(
                exact="exact"
            ),
            prefix=appmesh.CfnGatewayRoute.HttpGatewayRoutePrefixRewriteProperty(
                default_prefix="defaultPrefix",
                value="value"
            )
        )
    ),
    match=appmesh.CfnGatewayRoute.HttpGatewayRouteMatchProperty(
        headers=[appmesh.CfnGatewayRoute.HttpGatewayRouteHeaderProperty(
            name="name",

            # the properties below are optional
            invert=False,
            match=appmesh.CfnGatewayRoute.HttpGatewayRouteHeaderMatchProperty(
                exact="exact",
                prefix="prefix",
                range=appmesh.CfnGatewayRoute.GatewayRouteRangeMatchProperty(
                    end=123,
                    start=123
                ),
                regex="regex",
                suffix="suffix"
            )
        )],
        hostname=appmesh.CfnGatewayRoute.GatewayRouteHostnameMatchProperty(
            exact="exact",
            suffix="suffix"
        ),
        method="method",
        path=appmesh.CfnGatewayRoute.HttpPathMatchProperty(
            exact="exact",
            regex="regex"
        ),
        prefix="prefix",
        query_parameters=[appmesh.CfnGatewayRoute.QueryParameterProperty(
            name="name",

            # the properties below are optional
            match=appmesh.CfnGatewayRoute.HttpQueryParameterMatchProperty(
                exact="exact"
            )
        )]
    )
)

Attributes

action

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

Link

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

Return type

Union[IResolvable, HttpGatewayRouteActionProperty]

match

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

Link

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

Return type

Union[IResolvable, HttpGatewayRouteMatchProperty]

HttpGatewayRouteRewriteProperty

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

Bases: object

An object representing the gateway route to rewrite.

Parameters
Link

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.
import aws_cdk.aws_appmesh as appmesh

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

Attributes

hostname

The host name to rewrite.

Link

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

Return type

Union[IResolvable, GatewayRouteHostnameRewriteProperty, None]

path

The path to rewrite.

Link

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

Return type

Union[IResolvable, HttpGatewayRoutePathRewriteProperty, None]

prefix

The specified beginning characters to rewrite.

Link

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

Return type

Union[IResolvable, HttpGatewayRoutePrefixRewriteProperty, None]

HttpPathMatchProperty

class CfnGatewayRoute.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.

Link

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.
import aws_cdk.aws_appmesh as appmesh

http_path_match_property = appmesh.CfnGatewayRoute.HttpPathMatchProperty(
    exact="exact",
    regex="regex"
)

Attributes

exact

The exact path to match on.

Link

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

Return type

Optional[str]

regex

The regex used to match the path.

Link

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

Return type

Optional[str]

HttpQueryParameterMatchProperty

class CfnGatewayRoute.HttpQueryParameterMatchProperty(*, exact=None)

Bases: object

An object representing the query parameter to match.

Parameters

exact (Optional[str]) – The exact query parameter to match on.

Link

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.
import aws_cdk.aws_appmesh as appmesh

http_query_parameter_match_property = appmesh.CfnGatewayRoute.HttpQueryParameterMatchProperty(
    exact="exact"
)

Attributes

exact

The exact query parameter to match on.

Link

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

Return type

Optional[str]

QueryParameterProperty

class CfnGatewayRoute.QueryParameterProperty(*, name, match=None)

Bases: object

An object that represents the query parameter in the request.

Parameters
Link

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.
import aws_cdk.aws_appmesh as appmesh

query_parameter_property = appmesh.CfnGatewayRoute.QueryParameterProperty(
    name="name",

    # the properties below are optional
    match=appmesh.CfnGatewayRoute.HttpQueryParameterMatchProperty(
        exact="exact"
    )
)

Attributes

match

The query parameter to match on.

Link

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

Return type

Union[IResolvable, HttpQueryParameterMatchProperty, None]

name

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

Link

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

Return type

str