Class CfnVirtualRouter
- All Implemented Interfaces:
IInspectable
,ITaggable
,software.amazon.jsii.JsiiSerializable
,software.constructs.IConstruct
,software.constructs.IDependable
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 .
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.*; CfnVirtualRouter cfnVirtualRouter = CfnVirtualRouter.Builder.create(this, "MyCfnVirtualRouter") .meshName("meshName") .spec(VirtualRouterSpecProperty.builder() .listeners(List.of(VirtualRouterListenerProperty.builder() .portMapping(PortMappingProperty.builder() .port(123) .protocol("protocol") .build()) .build())) .build()) // the properties below are optional .meshOwner("meshOwner") .tags(List.of(CfnTag.builder() .key("key") .value("value") .build())) .virtualRouterName("virtualRouterName") .build();
- See Also:
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic final class
A fluent builder forCfnVirtualRouter
.static interface
An object representing a virtual router listener port mapping.static interface
An object that represents a virtual router listener.static interface
An object that represents the specification of a virtual router.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
CfnVirtualRouter
(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) protected
CfnVirtualRouter
(software.amazon.jsii.JsiiObjectRef objRef) CfnVirtualRouter
(software.constructs.Construct scope, String id, CfnVirtualRouterProps props) -
Method Summary
Modifier and TypeMethodDescriptionThe full Amazon Resource Name (ARN) for the virtual router.The name of the service mesh that the virtual router 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 router.The name of the virtual router.The name of the service mesh to create the virtual router in.The AWS IAM account ID of the service mesh owner.getSpec()
The virtual router specification to apply.getTags()
Tag Manager which manages the tags for this resource.Optional metadata that you can apply to the virtual router to assist with categorization and organization.The name to use for the virtual router.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 router in.void
setMeshOwner
(String value) The AWS IAM account ID of the service mesh owner.void
setSpec
(IResolvable value) The virtual router specification to apply.void
The virtual router specification to apply.void
setTagsRaw
(List<CfnTag> value) Optional metadata that you can apply to the virtual router to assist with categorization and organization.void
setVirtualRouterName
(String value) The name to use for the virtual router.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
-
CfnVirtualRouter
protected CfnVirtualRouter(software.amazon.jsii.JsiiObjectRef objRef) -
CfnVirtualRouter
protected CfnVirtualRouter(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) -
CfnVirtualRouter
@Stability(Stable) public CfnVirtualRouter(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnVirtualRouterProps 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 router. -
getAttrId
-
getAttrMeshName
The name of the service mesh that the virtual router 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 router. -
getAttrVirtualRouterName
The name of the virtual router. -
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 router in. -
setMeshName
The name of the service mesh to create the virtual router in. -
getSpec
The virtual router specification to apply. -
setSpec
The virtual router specification to apply. -
setSpec
The virtual router specification to apply. -
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 router to assist with categorization and organization. -
setTagsRaw
Optional metadata that you can apply to the virtual router to assist with categorization and organization. -
getVirtualRouterName
The name to use for the virtual router. -
setVirtualRouterName
The name to use for the virtual router.
-