CfnVirtualServiceProps

class aws_cdk.aws_appmesh.CfnVirtualServiceProps(*, mesh_name, spec, virtual_service_name, mesh_owner=None, tags=None)

Bases: object

Properties for defining a CfnVirtualService.

Parameters
  • mesh_name (str) – The name of the service mesh to create the virtual service in.

  • spec (Union[IResolvable, VirtualServiceSpecProperty, Dict[str, Any]]) – The virtual service specification to apply.

  • virtual_service_name (str) – The name to use for the virtual service.

  • 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 service 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-virtualservice.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_virtual_service_props = appmesh.CfnVirtualServiceProps(
    mesh_name="meshName",
    spec=appmesh.CfnVirtualService.VirtualServiceSpecProperty(
        provider=appmesh.CfnVirtualService.VirtualServiceProviderProperty(
            virtual_node=appmesh.CfnVirtualService.VirtualNodeServiceProviderProperty(
                virtual_node_name="virtualNodeName"
            ),
            virtual_router=appmesh.CfnVirtualService.VirtualRouterServiceProviderProperty(
                virtual_router_name="virtualRouterName"
            )
        )
    ),
    virtual_service_name="virtualServiceName",

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

Attributes

mesh_name

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

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appmesh-virtualservice.html#cfn-appmesh-virtualservice-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 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 .

Link

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

Return type

Optional[str]

spec

The virtual service specification to apply.

Link

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

Return type

Union[IResolvable, VirtualServiceSpecProperty]

tags

Optional metadata that you can apply to the virtual service 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-virtualservice.html#cfn-appmesh-virtualservice-tags

Return type

Optional[List[CfnTag]]

virtual_service_name

The name to use for the virtual service.

Link

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

Return type

str