GetTenantOptions.md

@letsgo/tenant / GetTenantOptions

Interface: GetTenantOptions

Options for getting an existing tenant.

Hierarchy

• DeploymentOptions

  ↳ GetTenantOptions

Table of contents

Properties

• deployment
• includeDeleted
• region
• tenantId

Properties

deployment

• Optional deployment: string

LetsGo deployment name.

Inherited from

DeploymentOptions.deployment

Defined in

db/dist/index.d.ts:18

---

includeDeleted

• Optional includeDeleted: boolean

If true, the tenant is returned even if it is deleted (i.e. it's deletedAt property is set)

Defined in

tenant/src/index.ts:508

---

region

• Optional region: string

AWS region.

Inherited from

DeploymentOptions.region

Defined in

db/dist/index.d.ts:14

---

tenantId

• tenantId: string

The ID of the tenant to get.

Defined in

tenant/src/index.ts:504