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(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnVirtualService(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
CfnVirtualService(Construct, String, ICfnVirtualServiceProps) |
Properties
AttrArn | The full Amazon Resource Name (ARN) for the virtual service. |
AttrId | |
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 | |
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>) |
Constructors
CfnVirtualService(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnVirtualService(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnVirtualService(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnVirtualService(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
CfnVirtualService(Construct, String, ICfnVirtualServiceProps)
public CfnVirtualService(Construct scope, string id, ICfnVirtualServiceProps props)
Parameters
- scope Constructs.Construct
Scope in which this resource is defined.
- id System.String
Construct identifier for this resource (unique in its scope).
- props ICfnVirtualServiceProps
Resource properties.
Properties
AttrArn
The full Amazon Resource Name (ARN) for the virtual service.
public virtual string AttrArn { get; }
Property Value
System.String
Remarks
CloudformationAttribute: Arn
AttrId
public virtual string AttrId { get; }
Property Value
System.String
Remarks
CloudformationAttribute: Id
AttrMeshName
The name of the service mesh that the virtual service resides in.
public virtual string AttrMeshName { get; }
Property Value
System.String
Remarks
CloudformationAttribute: MeshName
AttrMeshOwner
The AWS IAM account ID of the service mesh owner.
public virtual string AttrMeshOwner { get; }
Property Value
System.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
System.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 service.
public virtual string AttrUid { get; }
Property Value
System.String
Remarks
CloudformationAttribute: Uid
AttrVirtualServiceName
The name of the virtual service.
public virtual string AttrVirtualServiceName { get; }
Property Value
System.String
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
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
MeshName
The name of the service mesh to create the virtual service in.
public virtual string MeshName { get; set; }
Property Value
System.String
MeshOwner
The AWS IAM account ID of the service mesh owner.
public virtual string MeshOwner { get; set; }
Property Value
System.String
Spec
The virtual service specification to apply.
public virtual object Spec { get; set; }
Property Value
System.Object
Tags
Tag Manager which manages the tags for this resource.
public virtual TagManager Tags { get; }
Property Value
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[]
VirtualServiceName
The name to use for the virtual service.
public virtual string VirtualServiceName { get; set; }
Property Value
System.String
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.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>