CfnVirtualRouterPropsMixin

class aws_cdk.cfn_property_mixins.aws_appmesh.CfnVirtualRouterPropsMixin(props, *, strategy=None)

Bases: Mixin

Creates a virtual router within a service mesh.

Specify a listener for any inbound traffic that your virtual router receives. Create a virtual router for each protocol and port that you need to route. Virtual routers handle traffic for one or more virtual services within your mesh. After you create your virtual router, create and associate routes for your virtual router that direct incoming requests to different virtual nodes.

For more information about virtual routers, see Virtual routers .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appmesh-virtualrouter.html
CloudformationResource:: AWS::AppMesh::VirtualRouter
Mixin:: true
ExampleMetadata:: fixture=_generated

Example:

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

# merge_strategy: cdk.IMergeStrategy

cfn_virtual_router_props_mixin = appmesh.CfnVirtualRouterPropsMixin(appmesh.CfnVirtualRouterMixinProps(
    mesh_name="meshName",
    mesh_owner="meshOwner",
    spec=appmesh.CfnVirtualRouterPropsMixin.VirtualRouterSpecProperty(
        listeners=[appmesh.CfnVirtualRouterPropsMixin.VirtualRouterListenerProperty(
            port_mapping=appmesh.CfnVirtualRouterPropsMixin.PortMappingProperty(
                port=123,
                protocol="protocol"
            )
        )]
    ),
    tags=[cdk.CfnTag(
        key="key",
        value="value"
    )],
    virtual_router_name="virtualRouterName"
),
    strategy=merge_strategy
)

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

Parameters:

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

Methods

apply_to(construct)

Apply the mixin properties to the construct.

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

supports(construct)

Check if this mixin supports the given construct.

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

Attributes

CFN_PROPERTY_KEYS = ['meshName', 'meshOwner', 'spec', 'tags', 'virtualRouterName']

Static Methods

classmethod is_mixin(x)

Checks if x is a Mixin.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Mixin.

PortMappingProperty

class CfnVirtualRouterPropsMixin.PortMappingProperty(*, port=None, protocol=None)

Bases: object

An object representing a virtual router listener port mapping.

Parameters:

port (Union[int, float, None]) – The port used for the port mapping.
protocol (Optional[str]) – The protocol used for the port mapping. Specify one protocol.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualrouter-portmapping.html

ExampleMetadata:

fixture=_generated

Example:

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

port_mapping_property = appmesh.CfnVirtualRouterPropsMixin.PortMappingProperty(
    port=123,
    protocol="protocol"
)

Attributes

port

The port used for the port mapping.

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

protocol

The protocol used for the port mapping.

Specify one protocol.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualrouter-portmapping.html#cfn-appmesh-virtualrouter-portmapping-protocol

VirtualRouterListenerProperty

class CfnVirtualRouterPropsMixin.VirtualRouterListenerProperty(*, port_mapping=None)

Bases: object

An object that represents a virtual router listener.

Parameters:: port_mapping (Union[IResolvable, PortMappingProperty, Dict[str, Any], None]) – The port mapping information for the listener.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualrouter-virtualrouterlistener.html
ExampleMetadata:: fixture=_generated

Example:

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

virtual_router_listener_property = appmesh.CfnVirtualRouterPropsMixin.VirtualRouterListenerProperty(
    port_mapping=appmesh.CfnVirtualRouterPropsMixin.PortMappingProperty(
        port=123,
        protocol="protocol"
    )
)

Attributes

port_mapping

The port mapping information for the listener.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualrouter-virtualrouterlistener.html#cfn-appmesh-virtualrouter-virtualrouterlistener-portmapping

VirtualRouterSpecProperty

class CfnVirtualRouterPropsMixin.VirtualRouterSpecProperty(*, listeners=None)

Bases: object

An object that represents the specification of a virtual router.

Parameters:: listeners (Union[IResolvable, Sequence[Union[IResolvable, VirtualRouterListenerProperty, Dict[str, Any]]], None]) – The listeners that the virtual router is expected to receive inbound traffic from.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualrouter-virtualrouterspec.html
ExampleMetadata:: fixture=_generated

Example:

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

virtual_router_spec_property = appmesh.CfnVirtualRouterPropsMixin.VirtualRouterSpecProperty(
    listeners=[appmesh.CfnVirtualRouterPropsMixin.VirtualRouterListenerProperty(
        port_mapping=appmesh.CfnVirtualRouterPropsMixin.PortMappingProperty(
            port=123,
            protocol="protocol"
        )
    )]
)

Attributes

listeners

The listeners that the virtual router is expected to receive inbound traffic from.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualrouter-virtualrouterspec.html#cfn-appmesh-virtualrouter-virtualrouterspec-listeners