aws-cdk-lib.aws_appmesh.GatewayRoute

class GatewayRoute (construct)

LanguageType name
.NETAmazon.CDK.AWS.AppMesh.GatewayRoute
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsappmesh#GatewayRoute
Javasoftware.amazon.awscdk.services.appmesh.GatewayRoute
Pythonaws_cdk.aws_appmesh.GatewayRoute
TypeScript (source)aws-cdk-lib » aws_appmesh » GatewayRoute

Implements IConstruct, IDependable, IResource, IGatewayRoute

GatewayRoute represents a new or existing gateway route attached to a VirtualGateway and Mesh.

See also: https://docs.aws.amazon.com/app-mesh/latest/userguide/gateway-routes.html

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_appmesh as appmesh } from 'aws-cdk-lib';

declare const gatewayRouteSpec: appmesh.GatewayRouteSpec;
declare const virtualGateway: appmesh.VirtualGateway;
const gatewayRoute = new appmesh.GatewayRoute(this, 'MyGatewayRoute', {
  routeSpec: gatewayRouteSpec,
  virtualGateway: virtualGateway,

  // the properties below are optional
  gatewayRouteName: 'gatewayRouteName',
});

Initializer

new GatewayRoute(scope: Construct, id: string, props: GatewayRouteProps)

Parameters

  • scope Construct
  • id string
  • props GatewayRouteProps

Construct Props

NameTypeDescription
routeSpecGatewayRouteSpecWhat protocol the route uses.
virtualGatewayIVirtualGatewayThe VirtualGateway this GatewayRoute is associated with.
gatewayRouteName?stringThe name of the GatewayRoute.

routeSpec

Type: GatewayRouteSpec

What protocol the route uses.


virtualGateway

Type: IVirtualGateway

The VirtualGateway this GatewayRoute is associated with.


gatewayRouteName?

Type: string (optional, default: an automatically generated name)

The name of the GatewayRoute.

Properties

NameTypeDescription
envResourceEnvironmentThe environment this resource belongs to.
gatewayRouteArnstringThe Amazon Resource Name (ARN) for the GatewayRoute.
gatewayRouteNamestringThe name of the GatewayRoute.
nodeNodeThe tree node.
stackStackThe stack in which this resource is defined.
virtualGatewayIVirtualGatewayThe VirtualGateway this GatewayRoute is a part of.

env

Type: ResourceEnvironment

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.


gatewayRouteArn

Type: string

The Amazon Resource Name (ARN) for the GatewayRoute.


gatewayRouteName

Type: string

The name of the GatewayRoute.


node

Type: Node

The tree node.


stack

Type: Stack

The stack in which this resource is defined.


virtualGateway

Type: IVirtualGateway

The VirtualGateway this GatewayRoute is a part of.

Methods

NameDescription
applyRemovalPolicy(policy)Apply the given removal policy to this resource.
toString()Returns a string representation of this construct.
static fromGatewayRouteArn(scope, id, gatewayRouteArn)Import an existing GatewayRoute given an ARN.
static fromGatewayRouteAttributes(scope, id, attrs)Import an existing GatewayRoute given attributes.

applyRemovalPolicy(policy)

public applyRemovalPolicy(policy: RemovalPolicy): void

Parameters

  • policy RemovalPolicy

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).


toString()

public toString(): string

Returns

  • string

Returns a string representation of this construct.


static fromGatewayRouteArn(scope, id, gatewayRouteArn)

public static fromGatewayRouteArn(scope: Construct, id: string, gatewayRouteArn: string): IGatewayRoute

Parameters

  • scope Construct
  • id string
  • gatewayRouteArn string

Returns

  • IGatewayRoute

Import an existing GatewayRoute given an ARN.


static fromGatewayRouteAttributes(scope, id, attrs)

public static fromGatewayRouteAttributes(scope: Construct, id: string, attrs: GatewayRouteAttributes): IGatewayRoute

Parameters

  • scope Construct
  • id string
  • attrs GatewayRouteAttributes

Returns

  • IGatewayRoute

Import an existing GatewayRoute given attributes.