Class CfnVirtualService
Creates a virtual service within a service mesh.
Inherited Members
Namespace: Amazon.CDK.AWS.AppMesh
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnVirtualService : CfnResource, IInspectable, ITaggable
Syntax (vb)
Public Class CfnVirtualService Inherits CfnResource Implements IInspectable, ITaggable
Remarks
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 .
CloudformationResource: AWS::AppMesh::VirtualService
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 cfnVirtualService = new CfnVirtualService(this, "MyCfnVirtualService", new CfnVirtualServiceProps {
MeshName = "meshName",
Spec = new VirtualServiceSpecProperty {
Provider = new VirtualServiceProviderProperty {
VirtualNode = new VirtualNodeServiceProviderProperty {
VirtualNodeName = "virtualNodeName"
},
VirtualRouter = new VirtualRouterServiceProviderProperty {
VirtualRouterName = "virtualRouterName"
}
}
},
VirtualServiceName = "virtualServiceName",
// the properties below are optional
MeshOwner = "meshOwner",
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} }
});
Synopsis
Constructors
CfnVirtualService(Construct, string, ICfnVirtualServiceProps) | Creates a virtual service within a service mesh. |
Properties
AttrArn | The full Amazon Resource Name (ARN) for the virtual service. |
AttrId | Creates a virtual service within a service mesh. |
AttrMeshName | The name of the service mesh that the virtual service 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 service. |
AttrVirtualServiceName | The name of the virtual service. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | Creates a virtual service within a service mesh. |
MeshName | The name of the service mesh to create the virtual service in. |
MeshOwner | The AWS IAM account ID of the service mesh owner. |
Spec | The virtual service specification to apply. |
Tags | Tag Manager which manages the tags for this resource. |
TagsRaw | Optional metadata that you can apply to the virtual service to assist with categorization and organization. |
VirtualServiceName | The name to use for the virtual service. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<string, object>) | Creates a virtual service within a service mesh. |
Constructors
CfnVirtualService(Construct, string, ICfnVirtualServiceProps)
Creates a virtual service within a service mesh.
public CfnVirtualService(Construct scope, string id, ICfnVirtualServiceProps props)
Parameters
- scope Construct
Scope in which this resource is defined.
- id string
Construct identifier for this resource (unique in its scope).
- props ICfnVirtualServiceProps
Resource properties.
Remarks
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 .
CloudformationResource: AWS::AppMesh::VirtualService
ExampleMetadata: fixture=_generated
Properties
AttrArn
The full Amazon Resource Name (ARN) for the virtual service.
public virtual string AttrArn { get; }
Property Value
Remarks
CloudformationAttribute: Arn
AttrId
Creates a virtual service within a service mesh.
public virtual string AttrId { get; }
Property Value
Remarks
CloudformationAttribute: Id
AttrMeshName
The name of the service mesh that the virtual service resides in.
public virtual string AttrMeshName { get; }
Property Value
Remarks
CloudformationAttribute: MeshName
AttrMeshOwner
The AWS IAM account ID of the service mesh owner.
public virtual string AttrMeshOwner { get; }
Property Value
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
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 service.
public virtual string AttrUid { get; }
Property Value
Remarks
CloudformationAttribute: Uid
AttrVirtualServiceName
The name of the virtual service.
public virtual string AttrVirtualServiceName { get; }
Property Value
Remarks
CloudformationAttribute: VirtualServiceName
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
Remarks
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 .
CloudformationResource: AWS::AppMesh::VirtualService
ExampleMetadata: fixture=_generated
CfnProperties
Creates a virtual service within a service mesh.
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
Overrides
Remarks
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 .
CloudformationResource: AWS::AppMesh::VirtualService
ExampleMetadata: fixture=_generated
MeshName
The name of the service mesh to create the virtual service in.
public virtual string MeshName { get; set; }
Property Value
Remarks
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 .
CloudformationResource: AWS::AppMesh::VirtualService
ExampleMetadata: fixture=_generated
MeshOwner
The AWS IAM account ID of the service mesh owner.
public virtual string? MeshOwner { get; set; }
Property Value
Remarks
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 .
CloudformationResource: AWS::AppMesh::VirtualService
ExampleMetadata: fixture=_generated
Spec
The virtual service specification to apply.
public virtual object Spec { get; set; }
Property Value
Remarks
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 .
CloudformationResource: AWS::AppMesh::VirtualService
ExampleMetadata: fixture=_generated
Tags
Tag Manager which manages the tags for this resource.
public virtual TagManager Tags { get; }
Property Value
Remarks
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 .
CloudformationResource: AWS::AppMesh::VirtualService
ExampleMetadata: fixture=_generated
TagsRaw
Optional metadata that you can apply to the virtual service to assist with categorization and organization.
public virtual ICfnTag[]? TagsRaw { get; set; }
Property Value
ICfnTag[]
Remarks
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 .
CloudformationResource: AWS::AppMesh::VirtualService
ExampleMetadata: fixture=_generated
VirtualServiceName
The name to use for the virtual service.
public virtual string VirtualServiceName { get; set; }
Property Value
Remarks
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 .
CloudformationResource: AWS::AppMesh::VirtualService
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
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 .
CloudformationResource: AWS::AppMesh::VirtualService
ExampleMetadata: fixture=_generated
RenderProperties(IDictionary<string, object>)
Creates a virtual service within a service mesh.
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props IDictionary<string, object>
Returns
Overrides
Remarks
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 .
CloudformationResource: AWS::AppMesh::VirtualService
ExampleMetadata: fixture=_generated