AtfRestApi

Defined in: packages/constructs/src/api/rest-api.ts:59

Extends

• Construct

Constructors

Constructor

new AtfRestApi(scope, id, props): AtfRestApi

Defined in: packages/constructs/src/api/rest-api.ts:69

Parameters

scope

Construct

id

string

props

AtfRestApiProps

Returns

AtfRestApi

Overrides

Construct.constructor

Properties

api

readonly api: RestApi

Defined in: packages/constructs/src/api/rest-api.ts:60

---

apiKey?

readonly optional apiKey?: ApiKey

Defined in: packages/constructs/src/api/rest-api.ts:65

API key — created only when ≥1 route sets apiKey:true.

---

apiKeyId?

readonly optional apiKeyId?: string

Defined in: packages/constructs/src/api/rest-api.ts:67

API key’s logical ID (NOT the secret value). Fetch via aws apigateway get-api-key.

---

authorizer?

readonly optional authorizer?: CognitoUserPoolsAuthorizer

Defined in: packages/constructs/src/api/rest-api.ts:61

---

node

readonly node: Node

Defined in: node_modules/.pnpm/constructs@10.7.0/node_modules/constructs/lib/construct.d.ts:311

The tree node.

Inherited from

Construct.node

---

requestAuthorizer?

readonly optional requestAuthorizer?: RequestAuthorizer

Defined in: packages/constructs/src/api/rest-api.ts:63

Lambda (REQUEST) authorizer — created only when lambdaAuthorizer is supplied.

Methods

toString()

toString(): string

Defined in: node_modules/.pnpm/constructs@10.7.0/node_modules/constructs/lib/construct.d.ts:336

Returns a string representation of this construct.

Returns

string

Inherited from

Construct.toString

---

with()

with(…mixins): IConstruct

Defined in: node_modules/.pnpm/constructs@10.7.0/node_modules/constructs/lib/construct.d.ts:332

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

Construct.with

---

isConstruct()

static isConstruct(x): x is Construct

Defined in: node_modules/.pnpm/constructs@10.7.0/node_modules/constructs/lib/construct.d.ts:307

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

Construct.isConstruct