Class: Gateway

Defined in: packages/depot-cdk/src/stage-depot-gateway.ts:324

Wrapper for all Gateway types. Use the static classes available in Gateway to create Depot Gateways

Extends

• IGateway

Constructors

Constructor

new Gateway(scope, id, props): Gateway

Defined in: packages/depot-cdk/src/stage-depot-gateway.ts:330

Parameters

scope

Construct

id

string

props

StackProps

Returns

Gateway

Overrides

IGateway.constructor

Properties

environment

readonly environment: IStageDepotEnvironment

Defined in: packages/depot-cdk/src/stage-depot-gateway.ts:112

Inherited from

IGateway.environment

---

gatewayType

gatewayType: string

Defined in: packages/depot-cdk/src/stage-depot-gateway.ts:108

The type of Gateway

Inherited from

IGateway.gatewayType

---

id

readonly id: string

Defined in: packages/depot-cdk/src/stage-depot-gateway.ts:110

Inherited from

IGateway.id

---

log?

readonly optional log?: GatewayLogging

Defined in: packages/depot-cdk/src/stage-depot-gateway.ts:114

Inherited from

IGateway.log

---

node

readonly node: Node

Defined in: node_modules/constructs/lib/construct.d.ts:289

The tree node.

Inherited from

IGateway.node

---

API

static API: typeof API

Defined in: packages/depot-cdk/src/stage-depot-gateway.ts:325

---

IAM

static IAM: typeof IAM

Defined in: packages/depot-cdk/src/stage-depot-gateway.ts:326

---

Lambda

static Lambda: typeof Lambda

Defined in: packages/depot-cdk/src/stage-depot-gateway.ts:328

---

WebSocket

static WebSocket: typeof WebSocket

Defined in: packages/depot-cdk/src/stage-depot-gateway.ts:327

Methods

toString()

toString(): string

Defined in: node_modules/constructs/lib/construct.d.ts:314

Returns a string representation of this construct.

Returns

string

Inherited from

IGateway.toString

---

with()

with(...mixins): IConstruct

Defined in: node_modules/constructs/lib/construct.d.ts:310

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. Use multiple with() calls if subsequent mixins should apply to added constructs.

Parameters

mixins

...IMixin[]

The mixins to apply

Returns

IConstruct

This construct for chaining

Inherited from

IGateway.with

---

isConstruct()

static isConstruct(x): x is Construct

Defined in: node_modules/constructs/lib/construct.d.ts:285

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

Parameters

x

any

Any object

Returns

x is Construct

true if x is an object created from a class which extends Construct.

Inherited from

IGateway.isConstruct