software.amazon.awscdk.services.appmesh

Interface IVirtualGateway

All Superinterfaces:

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

All Known Subinterfaces:

IVirtualGateway.Jsii$Default

All Known Implementing Classes:

IVirtualGateway.Jsii$Proxy, VirtualGateway

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:36.563Z")
 @Stability(value=Stable)
public interface IVirtualGateway
extends software.amazon.jsii.JsiiSerializable, IResource

Interface which all Virtual Gateway based classes must implement.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	IVirtualGateway.Jsii$Default Internal default implementation for IVirtualGateway.
static class	IVirtualGateway.Jsii$Proxy A proxy class which represents a concrete javascript instance of this type.

Method Summary

Modifier and Type	Method and Description
GatewayRoute	addGatewayRoute(String id, GatewayRouteBaseProps route) Utility method to add a new GatewayRoute to the VirtualGateway.
IMesh	getMesh() The Mesh which the VirtualGateway belongs to.
String	getVirtualGatewayArn() The Amazon Resource Name (ARN) for the VirtualGateway.
String	getVirtualGatewayName() Name of the VirtualGateway.
Grant	grantStreamAggregatedResources(IGrantable identity) Grants the given entity `appmesh:StreamAggregatedResources`.

Methods inherited from interface software.amazon.awscdk.IResource

applyRemovalPolicy, getEnv, getStack

Methods inherited from interface software.constructs.IConstruct

getNode

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getMesh

@Stability(value=Stable)
 @NotNull
IMesh getMesh()

The Mesh which the VirtualGateway belongs to.

getVirtualGatewayArn

@Stability(value=Stable)
 @NotNull
String getVirtualGatewayArn()

The Amazon Resource Name (ARN) for the VirtualGateway.

getVirtualGatewayName

@Stability(value=Stable)
 @NotNull
String getVirtualGatewayName()

Name of the VirtualGateway.

addGatewayRoute

@Stability(value=Stable)
 @NotNull
GatewayRoute addGatewayRoute(@NotNull
                                                                String id,
                                                                @NotNull
                                                                GatewayRouteBaseProps route)

Utility method to add a new GatewayRoute to the VirtualGateway.

Parameters:

id - This parameter is required.

route - This parameter is required.

grantStreamAggregatedResources

@Stability(value=Stable)
 @NotNull
Grant grantStreamAggregatedResources(@NotNull
                                                                        IGrantable identity)

Grants the given entity `appmesh:StreamAggregatedResources`.

Parameters:

identity - This parameter is required.