software.amazon.awscdk.services.appmesh

Class CfnVirtualService

java.lang.Object

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.CfnElement

software.amazon.awscdk.core.CfnRefElement

software.amazon.awscdk.core.CfnResource

software.amazon.awscdk.services.appmesh.CfnVirtualService

All Implemented Interfaces:

IConstruct, IDependable, IInspectable

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-22T19:35:48.546Z")
public class CfnVirtualService
extends CfnResource
implements IInspectable

A CloudFormation `AWS::AppMesh::VirtualService`.

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 .

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.appmesh.*;
 CfnVirtualService cfnVirtualService = CfnVirtualService.Builder.create(this, "MyCfnVirtualService")
         .meshName("meshName")
         .spec(VirtualServiceSpecProperty.builder()
                 .provider(VirtualServiceProviderProperty.builder()
                         .virtualNode(VirtualNodeServiceProviderProperty.builder()
                                 .virtualNodeName("virtualNodeName")
                                 .build())
                         .virtualRouter(VirtualRouterServiceProviderProperty.builder()
                                 .virtualRouterName("virtualRouterName")
                                 .build())
                         .build())
                 .build())
         .virtualServiceName("virtualServiceName")
         // the properties below are optional
         .meshOwner("meshOwner")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnVirtualService.Builder A fluent builder for CfnVirtualService.
static interface	CfnVirtualService.VirtualNodeServiceProviderProperty An object that represents a virtual node service provider.
static interface	CfnVirtualService.VirtualRouterServiceProviderProperty An object that represents a virtual node service provider.
static interface	CfnVirtualService.VirtualServiceProviderProperty An object that represents the provider for a virtual service.
static interface	CfnVirtualService.VirtualServiceSpecProperty An object that represents the specification of a virtual service.

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnVirtualService(Construct scope, java.lang.String id, CfnVirtualServiceProps props) Create a new `AWS::AppMesh::VirtualService`.
protected	CfnVirtualService(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnVirtualService(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAttrArn() The full Amazon Resource Name (ARN) for the virtual service.
java.lang.String	getAttrMeshName() The name of the service mesh that the virtual service resides in.
java.lang.String	getAttrMeshOwner() The AWS IAM account ID of the service mesh owner.
java.lang.String	getAttrResourceOwner() The AWS IAM account ID of the resource owner.
java.lang.String	getAttrUid() The unique identifier for the virtual service.
java.lang.String	getAttrVirtualServiceName() The name of the virtual service.
protected java.util.Map<java.lang.String,java.lang.Object>	getCfnProperties()
java.lang.String	getMeshName() The name of the service mesh to create the virtual service in.
java.lang.String	getMeshOwner() The AWS IAM account ID of the service mesh owner.
java.lang.Object	getSpec() The virtual service specification to apply.
TagManager	getTags() Optional metadata that you can apply to the virtual service to assist with categorization and organization.
java.lang.String	getVirtualServiceName() The name to use for the virtual service.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected java.util.Map<java.lang.String,java.lang.Object>	renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
void	setMeshName(java.lang.String value) The name of the service mesh to create the virtual service in.
void	setMeshOwner(java.lang.String value) The AWS IAM account ID of the service mesh owner.
void	setSpec(CfnVirtualService.VirtualServiceSpecProperty value) The virtual service specification to apply.
void	setSpec(IResolvable value) The virtual service specification to apply.
void	setVirtualServiceName(java.lang.String value) The name to use for the virtual service.

Methods inherited from class software.amazon.awscdk.core.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

CFN_RESOURCE_TYPE_NAME

public static final java.lang.String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnVirtualService

protected CfnVirtualService(software.amazon.jsii.JsiiObjectRef objRef)

CfnVirtualService

protected CfnVirtualService(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnVirtualService

public CfnVirtualService(Construct scope,
                         java.lang.String id,
                         CfnVirtualServiceProps props)

Create a new `AWS::AppMesh::VirtualService`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

props - - resource properties. This parameter is required.

Method Detail

inspect

public void inspect(TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrArn

public java.lang.String getAttrArn()

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

getAttrMeshName

public java.lang.String getAttrMeshName()

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

getAttrMeshOwner

public java.lang.String getAttrMeshOwner()

The AWS IAM account ID of the service mesh owner.

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 .

getAttrResourceOwner

public java.lang.String getAttrResourceOwner()

The AWS IAM account ID of the resource owner.

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 .

getAttrUid

public java.lang.String getAttrUid()

The unique identifier for the virtual service.

getAttrVirtualServiceName

public java.lang.String getAttrVirtualServiceName()

The name of the virtual service.

getCfnProperties

protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

public TagManager getTags()

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.

getMeshName

public java.lang.String getMeshName()

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

setMeshName

public void setMeshName(java.lang.String value)

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

getSpec

public java.lang.Object getSpec()

The virtual service specification to apply.

setSpec

public void setSpec(IResolvable value)

The virtual service specification to apply.

setSpec

public void setSpec(CfnVirtualService.VirtualServiceSpecProperty value)

The virtual service specification to apply.

getVirtualServiceName

public java.lang.String getVirtualServiceName()

The name to use for the virtual service.

setVirtualServiceName

public void setVirtualServiceName(java.lang.String value)

The name to use for the virtual service.

getMeshOwner

public java.lang.String getMeshOwner()

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 .

setMeshOwner

public void setMeshOwner(java.lang.String value)

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 .