VirtualRouter¶
-
class
aws_cdk.aws_appmesh.
VirtualRouter
(scope, id, *, mesh, listeners=None, virtual_router_name=None)¶ Bases:
aws_cdk.core.Resource
- ExampleMetadata
infused
Example:
# mesh: appmesh.Mesh router = mesh.add_virtual_router("router", listeners=[appmesh.VirtualRouterListener.http(8080)] )
- Parameters
scope (
Construct
) –id (
str
) –mesh (
IMesh
) – The Mesh which the VirtualRouter belongs to.listeners (
Optional
[Sequence
[VirtualRouterListener
]]) – Listener specification for the VirtualRouter. Default: - A listener on HTTP port 8080virtual_router_name (
Optional
[str
]) – The name of the VirtualRouter. Default: - A name is automatically determined
Methods
-
add_route
(id, *, route_spec, route_name=None)¶ Add a single route to the router.
-
apply_removal_policy
(policy)¶ Apply the given removal policy to this resource.
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
).- Parameters
policy (
RemovalPolicy
) –- Return type
None
-
to_string
()¶ Returns a string representation of this construct.
- Return type
str
Attributes
-
env
¶ The environment this resource belongs to.
For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.
- Return type
-
node
¶ The construct tree node associated with this construct.
- Return type
-
virtual_router_arn
¶ The Amazon Resource Name (ARN) for the VirtualRouter.
- Return type
str
-
virtual_router_name
¶ The name of the VirtualRouter.
- Return type
str
Static Methods
-
classmethod
from_virtual_router_arn
(scope, id, virtual_router_arn)¶ Import an existing VirtualRouter given an ARN.
- Parameters
scope (
Construct
) –id (
str
) –virtual_router_arn (
str
) –
- Return type
-
classmethod
from_virtual_router_attributes
(scope, id, *, mesh, virtual_router_name)¶ Import an existing VirtualRouter given attributes.
- Parameters
- Return type
-
classmethod
is_construct
(x)¶ Return whether the given object is a Construct.
- Parameters
x (
Any
) –- Return type
bool
-
classmethod
is_resource
(construct)¶ Check whether the given construct is a Resource.
- Parameters
construct (
IConstruct
) –- Return type
bool