Class CfnVirtualRouter

Creates a virtual router within a service mesh.

Inheritance

object

CfnElement

CfnRefElement

CfnResource

CfnVirtualRouter

Implements

IInspectable

ITaggable

Inherited Members

CfnResource.IsCfnResource(object)

CfnResource.AddDeletionOverride(string)

CfnResource.AddDependency(CfnResource)

CfnResource.AddDependsOn(CfnResource)

CfnResource.AddMetadata(string, object)

CfnResource.AddOverride(string, object)

CfnResource.AddPropertyDeletionOverride(string)

CfnResource.AddPropertyOverride(string, object)

CfnResource.ApplyRemovalPolicy(RemovalPolicy?, IRemovalPolicyOptions)

CfnResource.GetAtt(string, ResolutionTypeHint?)

CfnResource.GetMetadata(string)

CfnResource.ObtainDependencies()

CfnResource.ObtainResourceDependencies()

CfnResource.RemoveDependency(CfnResource)

CfnResource.ReplaceDependency(CfnResource, CfnResource)

CfnResource.ShouldSynthesize()

CfnResource.ToString()

CfnResource.ValidateProperties(object)

CfnResource.CfnOptions

CfnResource.CfnResourceType

CfnResource.UpdatedProperites

CfnResource.UpdatedProperties

CfnRefElement.Ref

CfnElement.IsCfnElement(object)

CfnElement.OverrideLogicalId(string)

CfnElement.CreationStack

CfnElement.LogicalId

CfnElement.Stack

Namespace: Amazon.CDK.AWS.AppMesh

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnVirtualRouter : CfnResource, IInspectable, ITaggable

Syntax (vb)

Public Class CfnVirtualRouter Inherits CfnResource Implements IInspectable, ITaggable

Remarks

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

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.AppMesh;

             var cfnVirtualRouter = new CfnVirtualRouter(this, "MyCfnVirtualRouter", new CfnVirtualRouterProps {
                 MeshName = "meshName",
                 Spec = new VirtualRouterSpecProperty {
                     Listeners = new [] { new VirtualRouterListenerProperty {
                         PortMapping = new PortMappingProperty {
                             Port = 123,
                             Protocol = "protocol"
                         }
                     } }
                 },

                 // the properties below are optional
                 MeshOwner = "meshOwner",
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } },
                 VirtualRouterName = "virtualRouterName"
             });

Synopsis

Constructors

CfnVirtualRouter(Construct, string, ICfnVirtualRouterProps)

Creates a virtual router within a service mesh.

Properties

AttrArn	The full Amazon Resource Name (ARN) for the virtual router.
AttrId	Creates a virtual router within a service mesh.
AttrMeshName	The name of the service mesh that the virtual router resides in.
AttrMeshOwner	The AWS IAM account ID of the service mesh owner.
AttrResourceOwner	The AWS IAM account ID of the resource owner.
AttrUid	The unique identifier for the virtual router.
AttrVirtualRouterName	The name of the virtual router.
CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.
CfnProperties	Creates a virtual router within a service mesh.
MeshName	The name of the service mesh to create the virtual router in.
MeshOwner	The AWS IAM account ID of the service mesh owner.
Spec	The virtual router specification to apply.
Tags	Tag Manager which manages the tags for this resource.
TagsRaw	Optional metadata that you can apply to the virtual router to assist with categorization and organization.
VirtualRouterName	The name to use for the virtual router.

Methods

Inspect(TreeInspector)	Examines the CloudFormation resource and discloses attributes.
RenderProperties(IDictionary<string, object>)	Creates a virtual router within a service mesh.

Constructors

CfnVirtualRouter(Construct, string, ICfnVirtualRouterProps)

Creates a virtual router within a service mesh.

public CfnVirtualRouter(Construct scope, string id, ICfnVirtualRouterProps props)

Parameters

scope Construct

Scope in which this resource is defined.

id string

Construct identifier for this resource (unique in its scope).

props ICfnVirtualRouterProps

Resource properties.

Remarks

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

ExampleMetadata: fixture=_generated

Properties

AttrArn

The full Amazon Resource Name (ARN) for the virtual router.

public virtual string AttrArn { get; }

Property Value

string

Remarks

CloudformationAttribute: Arn

AttrId

Creates a virtual router within a service mesh.

public virtual string AttrId { get; }

Property Value

string

Remarks

CloudformationAttribute: Id

AttrMeshName

The name of the service mesh that the virtual router resides in.

public virtual string AttrMeshName { get; }

Property Value

string

Remarks

CloudformationAttribute: MeshName

AttrMeshOwner

The AWS IAM account ID of the service mesh owner.

public virtual string AttrMeshOwner { get; }

Property Value

string

Remarks

If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with Shared Meshes .

CloudformationAttribute: MeshOwner

AttrResourceOwner

The AWS IAM account ID of the resource owner.

public virtual string AttrResourceOwner { get; }

Property Value

string

Remarks

If the account ID is not your own, then it's the ID of the mesh owner or of another account that the mesh is shared with. For more information about mesh sharing, see Working with Shared Meshes .

CloudformationAttribute: ResourceOwner

AttrUid

The unique identifier for the virtual router.

public virtual string AttrUid { get; }

Property Value

string

Remarks

CloudformationAttribute: Uid

AttrVirtualRouterName

The name of the virtual router.

public virtual string AttrVirtualRouterName { get; }

Property Value

string

Remarks

CloudformationAttribute: VirtualRouterName

CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

public static string CFN_RESOURCE_TYPE_NAME { get; }

Property Value

string

Remarks

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

ExampleMetadata: fixture=_generated

CfnProperties

Creates a virtual router within a service mesh.

protected override IDictionary<string, object> CfnProperties { get; }

Property Value

IDictionary<string, object>

Overrides

CfnResource.CfnProperties

Remarks

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

ExampleMetadata: fixture=_generated

MeshName

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

public virtual string MeshName { get; set; }

Property Value

string

Remarks

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

ExampleMetadata: fixture=_generated

MeshOwner

The AWS IAM account ID of the service mesh owner.

public virtual string? MeshOwner { get; set; }

Property Value

string

Remarks

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

ExampleMetadata: fixture=_generated

Spec

The virtual router specification to apply.

public virtual object Spec { get; set; }

Property Value

object

Remarks

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

ExampleMetadata: fixture=_generated

Tags

Tag Manager which manages the tags for this resource.

public virtual TagManager Tags { get; }

Property Value

TagManager

Remarks

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

ExampleMetadata: fixture=_generated

TagsRaw

Optional metadata that you can apply to the virtual router to assist with categorization and organization.

public virtual ICfnTag[]? TagsRaw { get; set; }

Property Value

ICfnTag[]

Remarks

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

ExampleMetadata: fixture=_generated

VirtualRouterName

The name to use for the virtual router.

public virtual string? VirtualRouterName { get; set; }

Property Value

string

Remarks

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

ExampleMetadata: fixture=_generated

Methods

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.

public virtual void Inspect(TreeInspector inspector)

Parameters

inspector TreeInspector

tree inspector to collect and process attributes.

Remarks

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

ExampleMetadata: fixture=_generated

RenderProperties(IDictionary<string, object>)

Creates a virtual router within a service mesh.

protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)

Parameters

props IDictionary<string, object>

Returns

IDictionary<string, object>

Overrides

CfnResource.RenderProperties(IDictionary<string, object>)

Remarks

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

ExampleMetadata: fixture=_generated

Implements

IInspectable

ITaggable