Skip to content
v2.273.0

IVirtualRouter Interface ​

Interface which all VirtualRouter based classes MUST implement.

Properties ​

The environment this resource belongs to.
notes

For resources that are created and managed in a Stack (those created by creating new class instances like new Role(), new Bucket(), etc.), this is always the same as the environment of the stack they belong to.

For referenced resources (those obtained from referencing methods like Role.fromRoleArn(), Bucket.fromBucketName(), etc.), they might be different than the stack they were imported into.

meshIMeshmeshIMeshmeshIMeshMeshIMeshMeshIMeshrequired#
The Mesh which the VirtualRouter belongs to.
nodeNodenodeNodenodeNodeNodeNodeNodeNoderequired#
The tree node.
stackStackstackStackstackStackStackStackStackStackrequired#
The stack in which this resource is defined.
virtualRouterArnstringvirtual_router_arnstrvirtualRouterArnStringVirtualRouterArnstringVirtualRouterArn*stringrequired#
The Amazon Resource Name (ARN) for the VirtualRouter.
virtualRouterNamestringvirtual_router_namestrvirtualRouterNameStringVirtualRouterNamestringVirtualRouterName*stringrequired#
The name of the VirtualRouter.
virtualRouterRefVirtualRouterReferencevirtual_router_refVirtualRouterReferencevirtualRouterRefVirtualRouterReferenceVirtualRouterRefVirtualRouterReferenceVirtualRouterRefVirtualRouterReferencerequired#
A reference to a VirtualRouter resource.

Methods ​

addRoute(id: string, props: RouteBaseProps): Routedef add_route(self, id: str, props: RouteBaseProps) -> Routepublic Route addRoute(String id, RouteBaseProps props)public Route AddRoute(string id, RouteBaseProps props)func AddRoute(Id *string, Props RouteBaseProps) Route#
Add a single route to the router.
applyRemovalPolicy(policy: RemovalPolicy): voiddef apply_removal_policy(self, policy: RemovalPolicy) -> Nonepublic void applyRemovalPolicy(RemovalPolicy policy)public void ApplyRemovalPolicy(RemovalPolicy policy)func ApplyRemovalPolicy(Policy RemovalPolicy)#
Apply the given removal policy to this resource.
notes

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

with(...mixins: IMixin[]): IConstructdef with(self, mixins: IMixin) -> IConstructpublic IConstruct with(IMixin mixins)public IConstruct With(IMixin mixins)func With(Mixins IMixin) IConstruct#
Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited.

1 parameter · returns

Parameters

  • mixinsmixinsmixinsmixinsMixins — The mixins to apply.

Returns: This construct for chaining