VirtualGateway¶
-
class
aws_cdk.aws_appmesh.
VirtualGateway
(scope, id, *, mesh, access_log=None, backends_default_client_policy=None, listeners=None, virtual_gateway_name=None)¶ Bases:
aws_cdk.core.Resource
(experimental) VirtualGateway represents a newly defined App Mesh Virtual Gateway.
A virtual gateway allows resources that are outside of your mesh to communicate to resources that are inside of your mesh.
- See
https://docs.aws.amazon.com/app-mesh/latest/userguide/virtual_gateways.html
- Stability
experimental
- Parameters
scope (
Construct
) –id (
str
) –mesh (
IMesh
) – (experimental) The Mesh which the VirtualGateway belongs to.access_log (
Optional
[AccessLog
]) – (experimental) Access Logging Configuration for the VirtualGateway. Default: - no access loggingbackends_default_client_policy (
Optional
[ClientPolicy
]) – (experimental) Default Configuration Virtual Node uses to communicate with Virtual Service. Default: - No Configlisteners (
Optional
[List
[VirtualGatewayListener
]]) – (experimental) Listeners for the VirtualGateway. Only one is supported. Default: - Single HTTP listener on port 8080virtual_gateway_name (
Optional
[str
]) – (experimental) Name of the VirtualGateway. Default: - A name is automatically determined
- Stability
experimental
Methods
-
add_gateway_route
(id, *, route_spec, gateway_route_name=None)¶ (experimental) Utility method to add a new GatewayRoute to the VirtualGateway.
- Parameters
id (
str
) –route_spec (
GatewayRouteSpec
) – (experimental) What protocol the route uses.gateway_route_name (
Optional
[str
]) – (experimental) The name of the GatewayRoute. Default: - an automatically generated name
- Stability
experimental
- Return type
-
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.DELETE
), 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
-
mesh
¶ (experimental) The Mesh that the VirtualGateway belongs to.
- Stability
experimental
- Return type
-
node
¶ The construct tree node associated with this construct.
- Return type
-
virtual_gateway_arn
¶ (experimental) The Amazon Resource Name (ARN) for the VirtualGateway.
- Stability
experimental
- Return type
str
-
virtual_gateway_name
¶ (experimental) The name of the VirtualGateway.
- Stability
experimental
- Return type
str
Static Methods
-
classmethod
from_virtual_gateway_arn
(scope, id, virtual_gateway_arn)¶ (experimental) Import an existing VirtualGateway given an ARN.
- Parameters
scope (
Construct
) –id (
str
) –virtual_gateway_arn (
str
) –
- Stability
experimental
- Return type
-
classmethod
from_virtual_gateway_attributes
(scope, id, *, mesh, virtual_gateway_name)¶ (experimental) Import an existing VirtualGateway given its attributes.
- Parameters
- Stability
experimental
- 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