CreateTenantOptions.md

@letsgo/tenant / CreateTenantOptions

Interface: CreateTenantOptions

Options for creating a new tenants.

Hierarchy

• DeploymentOptions

  ↳ CreateTenantOptions

Table of contents

Properties

• createdBy
• deployment
• displayName
• region

Properties

createdBy

• createdBy: Identity

The identity of the user who is creating the tenant.

Defined in

tenant/src/index.ts:447

---

deployment

• Optional deployment: string

LetsGo deployment name.

Inherited from

DeploymentOptions.deployment

Defined in

db/dist/index.d.ts:18

---

displayName

• Optional displayName: string

The tenant's display name. If not specified, a random display name is generated.

Defined in

tenant/src/index.ts:451

---

region

• Optional region: string

AWS region.

Inherited from

DeploymentOptions.region

Defined in

db/dist/index.d.ts:14