Class CfnVirtualService
- All Implemented Interfaces:
IInspectable
,ITaggable
,software.amazon.jsii.JsiiSerializable
,software.constructs.IConstruct
,software.constructs.IDependable
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();
- See Also:
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic final class
A fluent builder forCfnVirtualService
.static interface
An object that represents a virtual node service provider.static interface
An object that represents a virtual node service provider.static interface
An object that represents the provider for a virtual service.static interface
An object that represents the specification of a virtual service.Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject
software.amazon.jsii.JsiiObject.InitializationMode
Nested classes/interfaces inherited from interface software.constructs.IConstruct
software.constructs.IConstruct.Jsii$Default
Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
Nested classes/interfaces inherited from interface software.amazon.awscdk.ITaggable
ITaggable.Jsii$Default, ITaggable.Jsii$Proxy
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
The CloudFormation resource type name for this resource class. -
Constructor Summary
ModifierConstructorDescriptionprotected
CfnVirtualService
(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) protected
CfnVirtualService
(software.amazon.jsii.JsiiObjectRef objRef) CfnVirtualService
(software.constructs.Construct scope, String id, CfnVirtualServiceProps props) -
Method Summary
Modifier and TypeMethodDescriptionThe full Amazon Resource Name (ARN) for the virtual service.The name of the service mesh that the virtual service resides in.The AWS IAM account ID of the service mesh owner.The AWS IAM account ID of the resource owner.The unique identifier for the virtual service.The name of the virtual service.The name of the service mesh to create the virtual service in.The AWS IAM account ID of the service mesh owner.getSpec()
The virtual service specification to apply.getTags()
Tag Manager which manages the tags for this resource.Optional metadata that you can apply to the virtual service to assist with categorization and organization.The name to use for the virtual service.void
inspect
(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.renderProperties
(Map<String, Object> props) void
setMeshName
(String value) The name of the service mesh to create the virtual service in.void
setMeshOwner
(String value) The AWS IAM account ID of the service mesh owner.void
setSpec
(IResolvable value) The virtual service specification to apply.void
The virtual service specification to apply.void
setTagsRaw
(List<CfnTag> value) Optional metadata that you can apply to the virtual service to assist with categorization and organization.void
setVirtualServiceName
(String value) The name to use for the virtual service.Methods inherited from class software.amazon.awscdk.CfnResource
addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, shouldSynthesize, toString, validateProperties
Methods inherited from class software.amazon.awscdk.CfnRefElement
getRef
Methods inherited from class software.amazon.awscdk.CfnElement
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId
Methods inherited from class software.constructs.Construct
getNode, isConstruct
Methods inherited from class software.amazon.jsii.JsiiObject
jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Field Details
-
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
-
-
Constructor Details
-
CfnVirtualService
protected CfnVirtualService(software.amazon.jsii.JsiiObjectRef objRef) -
CfnVirtualService
protected CfnVirtualService(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) -
CfnVirtualService
@Stability(Stable) public CfnVirtualService(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnVirtualServiceProps props) - Parameters:
scope
- Scope in which this resource is defined. This parameter is required.id
- Construct identifier for this resource (unique in its scope). This parameter is required.props
- Resource properties. This parameter is required.
-
-
Method Details
-
inspect
Examines the CloudFormation resource and discloses attributes.- Specified by:
inspect
in interfaceIInspectable
- Parameters:
inspector
- tree inspector to collect and process attributes. This parameter is required.
-
renderProperties
@Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String, Object> props) - Overrides:
renderProperties
in classCfnResource
- Parameters:
props
- This parameter is required.
-
getAttrArn
The full Amazon Resource Name (ARN) for the virtual service. -
getAttrId
-
getAttrMeshName
The name of the service mesh that the virtual service resides in. -
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
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
The unique identifier for the virtual service. -
getAttrVirtualServiceName
The name of the virtual service. -
getCfnProperties
- Overrides:
getCfnProperties
in classCfnResource
-
getTags
Tag Manager which manages the tags for this resource. -
getMeshName
The name of the service mesh to create the virtual service in. -
setMeshName
The name of the service mesh to create the virtual service in. -
getSpec
The virtual service specification to apply. -
setSpec
The virtual service specification to apply. -
setSpec
The virtual service specification to apply. -
getVirtualServiceName
The name to use for the virtual service. -
setVirtualServiceName
The name to use for the virtual service. -
getMeshOwner
The AWS IAM account ID of the service mesh owner. -
setMeshOwner
The AWS IAM account ID of the service mesh owner. -
getTagsRaw
Optional metadata that you can apply to the virtual service to assist with categorization and organization. -
setTagsRaw
Optional metadata that you can apply to the virtual service to assist with categorization and organization.
-