CfnVirtualServicePropsMixin

class aws_cdk.mixins_preview.aws_appmesh.mixins.CfnVirtualServicePropsMixin(props, *, strategy=None)

Bases: Mixin

Creates a virtual service within a service mesh.

A virtual service is an abstraction of a real service that is provided by a virtual node directly or indirectly by means of a virtual router. Dependent services call your virtual service by its virtualServiceName , and those requests are routed to the virtual node or virtual router that is specified as the provider for the virtual service.

For more information about virtual services, see Virtual services .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appmesh-virtualservice.html
CloudformationResource:: AWS::AppMesh::VirtualService
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.mixins_preview import mixins
from aws_cdk.mixins_preview.aws_appmesh import mixins as appmesh_mixins

cfn_virtual_service_props_mixin = appmesh_mixins.CfnVirtualServicePropsMixin(appmesh_mixins.CfnVirtualServiceMixinProps(
    mesh_name="meshName",
    mesh_owner="meshOwner",
    spec=appmesh_mixins.CfnVirtualServicePropsMixin.VirtualServiceSpecProperty(
        provider=appmesh_mixins.CfnVirtualServicePropsMixin.VirtualServiceProviderProperty(
            virtual_node=appmesh_mixins.CfnVirtualServicePropsMixin.VirtualNodeServiceProviderProperty(
                virtual_node_name="virtualNodeName"
            ),
            virtual_router=appmesh_mixins.CfnVirtualServicePropsMixin.VirtualRouterServiceProviderProperty(
                virtual_router_name="virtualRouterName"
            )
        )
    ),
    tags=[CfnTag(
        key="key",
        value="value"
    )],
    virtual_service_name="virtualServiceName"
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

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

Parameters:

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

Methods

apply_to(construct)

Apply the mixin properties to the construct.

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

supports(construct)

Check if this mixin supports the given construct.

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

Attributes

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

Static Methods

classmethod is_mixin(x)

(experimental) 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.
Stability:: experimental

VirtualNodeServiceProviderProperty

class CfnVirtualServicePropsMixin.VirtualNodeServiceProviderProperty(*, virtual_node_name=None)

Bases: object

An object that represents a virtual node service provider.

Parameters:: virtual_node_name (Optional[str]) – The name of the virtual node that is acting as a service provider.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualservice-virtualnodeserviceprovider.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.mixins_preview.aws_appmesh import mixins as appmesh_mixins

virtual_node_service_provider_property = appmesh_mixins.CfnVirtualServicePropsMixin.VirtualNodeServiceProviderProperty(
    virtual_node_name="virtualNodeName"
)

Attributes

virtual_node_name

The name of the virtual node that is acting as a service provider.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualservice-virtualnodeserviceprovider.html#cfn-appmesh-virtualservice-virtualnodeserviceprovider-virtualnodename

VirtualRouterServiceProviderProperty

class CfnVirtualServicePropsMixin.VirtualRouterServiceProviderProperty(*, virtual_router_name=None)

Bases: object

An object that represents a virtual node service provider.

Parameters:: virtual_router_name (Optional[str]) – The name of the virtual router that is acting as a service provider.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualservice-virtualrouterserviceprovider.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.mixins_preview.aws_appmesh import mixins as appmesh_mixins

virtual_router_service_provider_property = appmesh_mixins.CfnVirtualServicePropsMixin.VirtualRouterServiceProviderProperty(
    virtual_router_name="virtualRouterName"
)

Attributes

virtual_router_name

The name of the virtual router that is acting as a service provider.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualservice-virtualrouterserviceprovider.html#cfn-appmesh-virtualservice-virtualrouterserviceprovider-virtualroutername

VirtualServiceProviderProperty

class CfnVirtualServicePropsMixin.VirtualServiceProviderProperty(*, virtual_node=None, virtual_router=None)

Bases: object

An object that represents the provider for a virtual service.

Parameters:

virtual_node (Union[IResolvable, VirtualNodeServiceProviderProperty, Dict[str, Any], None]) – The virtual node associated with a virtual service.
virtual_router (Union[IResolvable, VirtualRouterServiceProviderProperty, Dict[str, Any], None]) – The virtual router associated with a virtual service.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualservice-virtualserviceprovider.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.mixins_preview.aws_appmesh import mixins as appmesh_mixins

virtual_service_provider_property = appmesh_mixins.CfnVirtualServicePropsMixin.VirtualServiceProviderProperty(
    virtual_node=appmesh_mixins.CfnVirtualServicePropsMixin.VirtualNodeServiceProviderProperty(
        virtual_node_name="virtualNodeName"
    ),
    virtual_router=appmesh_mixins.CfnVirtualServicePropsMixin.VirtualRouterServiceProviderProperty(
        virtual_router_name="virtualRouterName"
    )
)

Attributes

virtual_node

The virtual node associated with a virtual service.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualservice-virtualserviceprovider.html#cfn-appmesh-virtualservice-virtualserviceprovider-virtualnode

virtual_router

The virtual router associated with a virtual service.

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

VirtualServiceSpecProperty

class CfnVirtualServicePropsMixin.VirtualServiceSpecProperty(*, provider=None)

Bases: object

An object that represents the specification of a virtual service.

Parameters:: provider (Union[IResolvable, VirtualServiceProviderProperty, Dict[str, Any], None]) – The App Mesh object that is acting as the provider for a virtual service. You can specify a single virtual node or virtual router.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualservice-virtualservicespec.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.mixins_preview.aws_appmesh import mixins as appmesh_mixins

virtual_service_spec_property = appmesh_mixins.CfnVirtualServicePropsMixin.VirtualServiceSpecProperty(
    provider=appmesh_mixins.CfnVirtualServicePropsMixin.VirtualServiceProviderProperty(
        virtual_node=appmesh_mixins.CfnVirtualServicePropsMixin.VirtualNodeServiceProviderProperty(
            virtual_node_name="virtualNodeName"
        ),
        virtual_router=appmesh_mixins.CfnVirtualServicePropsMixin.VirtualRouterServiceProviderProperty(
            virtual_router_name="virtualRouterName"
        )
    )
)

Attributes

provider

The App Mesh object that is acting as the provider for a virtual service.

You can specify a single virtual node or virtual router.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualservice-virtualservicespec.html#cfn-appmesh-virtualservice-virtualservicespec-provider