Skip to main content

Class: API

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

Depot API Gateway CDK Construct. Creates a Public facing API Gateway for a Depot Environment.

Extends​

Constructors​

Constructor​

new API(scope, id, props): API

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

Create a public facing API Gateway

Parameters​

scope​

Construct

CDK Construct to add this resource to.

id​

string

unique ID for this resource.

props​

APIGatewayProps

Properties to configure the Public Gateway.

Returns​

API

Overrides​

IGateway.constructor

Properties​

environment​

readonly environment: IStageDepotEnvironment

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

Inherited from​

IGateway.environment

firewall?​

readonly optional firewall?: GatewayFirewallProps

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

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:124

Overrides​

IGateway.id

log?​

readonly optional log?: GatewayLogging

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

Overrides​

IGateway.log

node​

readonly node: Node

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

The tree node.

Inherited from​

IGateway.node

resource​

readonly resource: CustomResource

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

Methods​

toString()​

toString(): string

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

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:346

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:321

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