software.amazon.awscdk.services.appmesh

Class CfnVirtualRouter

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.appmesh.CfnVirtualRouter

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:36.524Z")
 @Stability(value=Stable)
public class CfnVirtualRouter
extends CfnResource
implements IInspectable

A CloudFormation `AWS::AppMesh::VirtualRouter`.

Creates a virtual router within a service mesh.

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();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnVirtualRouter.Builder A fluent builder for CfnVirtualRouter.
static interface	CfnVirtualRouter.PortMappingProperty An object representing a virtual router listener port mapping.
static interface	CfnVirtualRouter.VirtualRouterListenerProperty An object that represents a virtual router listener.
static interface	CfnVirtualRouter.VirtualRouterSpecProperty 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.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnVirtualRouter(software.constructs.Construct scope, String id, CfnVirtualRouterProps props) Create a new `AWS::AppMesh::VirtualRouter`.
protected	CfnVirtualRouter(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnVirtualRouter(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
String	getAttrArn() The full Amazon Resource Name (ARN) for the virtual router.
String	getAttrMeshName() The name of the service mesh that the virtual router resides in.
String	getAttrMeshOwner() The AWS IAM account ID of the service mesh owner.
String	getAttrResourceOwner() The AWS IAM account ID of the resource owner.
String	getAttrUid() The unique identifier for the virtual router.
String	getAttrVirtualRouterName() The name of the virtual router.
protected Map<String,Object>	getCfnProperties()
String	getMeshName() The name of the service mesh to create the virtual router in.
String	getMeshOwner() The AWS IAM account ID of the service mesh owner.
Object	getSpec() The virtual router specification to apply.
TagManager	getTags() Optional metadata that you can apply to the virtual router to assist with categorization and organization.
String	getVirtualRouterName() The name to use for the virtual router.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	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(CfnVirtualRouter.VirtualRouterSpecProperty value) The virtual router specification to apply.
void	setSpec(IResolvable value) The virtual router specification to apply.
void	setVirtualRouterName(String value) The name to use for the virtual router.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, 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 Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnVirtualRouter

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

CfnVirtualRouter

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

CfnVirtualRouter

@Stability(value=Stable)
public CfnVirtualRouter(@NotNull
                                                 software.constructs.Construct scope,
                                                 @NotNull
                                                 String id,
                                                 @NotNull
                                                 CfnVirtualRouterProps props)

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

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

@Stability(value=Stable)
public void inspect(@NotNull
                                             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

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrArn

@Stability(value=Stable)
 @NotNull
public String getAttrArn()

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

getAttrMeshName

@Stability(value=Stable)
 @NotNull
public String getAttrMeshName()

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

getAttrMeshOwner

@Stability(value=Stable)
 @NotNull
public 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

@Stability(value=Stable)
 @NotNull
public 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

@Stability(value=Stable)
 @NotNull
public String getAttrUid()

The unique identifier for the virtual router.

getAttrVirtualRouterName

@Stability(value=Stable)
 @NotNull
public String getAttrVirtualRouterName()

The name of the virtual router.

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

@Stability(value=Stable)
 @NotNull
public TagManager getTags()

Optional metadata that you can apply to the virtual router 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

@Stability(value=Stable)
 @NotNull
public String getMeshName()

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

setMeshName

@Stability(value=Stable)
public void setMeshName(@NotNull
                                                 String value)

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

getSpec

@Stability(value=Stable)
 @NotNull
public Object getSpec()

The virtual router specification to apply.

setSpec

@Stability(value=Stable)
public void setSpec(@NotNull
                                             CfnVirtualRouter.VirtualRouterSpecProperty value)

The virtual router specification to apply.

setSpec

@Stability(value=Stable)
public void setSpec(@NotNull
                                             IResolvable value)

The virtual router specification to apply.

getMeshOwner

@Stability(value=Stable)
 @Nullable
public 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

@Stability(value=Stable)
public void setMeshOwner(@Nullable
                                                  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 .

getVirtualRouterName

@Stability(value=Stable)
 @Nullable
public String getVirtualRouterName()

The name to use for the virtual router.

setVirtualRouterName

@Stability(value=Stable)
public void setVirtualRouterName(@Nullable
                                                          String value)

The name to use for the virtual router.