CfnVirtualRouterProps

class aws_cdk.aws_appmesh.CfnVirtualRouterProps(*, mesh_name, spec, mesh_owner=None, tags=None, virtual_router_name=None)

Bases: object

Properties for defining a CfnVirtualRouter.

Parameters:

mesh_name (str) – The name of the service mesh to create the virtual router in.
spec (Union[IResolvable, VirtualRouterSpecProperty, Dict[str, Any]]) – The virtual router specification to apply.
mesh_owner (Optional[str]) – The AWS IAM account ID of the service mesh owner. If the account ID is not your own, then the account that you specify must share the mesh with your account before you can create the resource in the service mesh. For more information about mesh sharing, see Working with shared meshes .
tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – Optional metadata that you can apply to the virtual router 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.
virtual_router_name (Optional[str]) – The name to use for the virtual router.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appmesh-virtualrouter.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 import aws_appmesh as appmesh

cfn_virtual_router_props = appmesh.CfnVirtualRouterProps(
    mesh_name="meshName",
    spec=appmesh.CfnVirtualRouter.VirtualRouterSpecProperty(
        listeners=[appmesh.CfnVirtualRouter.VirtualRouterListenerProperty(
            port_mapping=appmesh.CfnVirtualRouter.PortMappingProperty(
                port=123,
                protocol="protocol"
            )
        )]
    ),

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

Attributes

mesh_name

The name of the service mesh to create the virtual router in.

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

mesh_owner

The AWS IAM account ID of the service mesh owner.

If the account ID is not your own, then the account that you specify must share the mesh with your account before you can create the resource in the service mesh. For more information about mesh sharing, see Working with shared meshes .

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

spec

The virtual router specification to apply.

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

tags

Optional metadata that you can apply to the virtual router 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.

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

virtual_router_name

The name to use for the virtual router.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appmesh-virtualrouter.html#cfn-appmesh-virtualrouter-virtualroutername