TcpRouteSpecOptions

class aws_cdk.aws_appmesh.TcpRouteSpecOptions(*, priority=None, weighted_targets, timeout=None)

Bases: aws_cdk.aws_appmesh.RouteSpecOptionsBase

Properties specific for a TCP Based Routes.

Parameters
  • priority (Union[int, float, None]) – The priority for the route. When a Virtual Router has multiple routes, route match is performed in the order of specified value, where 0 is the highest priority, and first matched route is selected. Default: - no particular priority

  • weighted_targets (Sequence[Union[WeightedTarget, Dict[str, Any]]]) – List of targets that traffic is routed to when a request matches the route.

  • timeout (Union[TcpTimeout, Dict[str, Any], None]) – An object that represents a tcp timeout. Default: - None

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
import aws_cdk.core as cdk

# virtual_node: appmesh.VirtualNode

tcp_route_spec_options = appmesh.TcpRouteSpecOptions(
    weighted_targets=[appmesh.WeightedTarget(
        virtual_node=virtual_node,

        # the properties below are optional
        weight=123
    )],

    # the properties below are optional
    priority=123,
    timeout=appmesh.TcpTimeout(
        idle=cdk.Duration.minutes(30)
    )
)

Attributes

priority

The priority for the route.

When a Virtual Router has multiple routes, route match is performed in the order of specified value, where 0 is the highest priority, and first matched route is selected.

Default
  • no particular priority

Return type

Union[int, float, None]

timeout

An object that represents a tcp timeout.

Default
  • None

Return type

Optional[TcpTimeout]

weighted_targets

List of targets that traffic is routed to when a request matches the route.

Return type

List[WeightedTarget]