Class Image

A container image, used for starting Sandboxes.

Index

Accessors

Methods

build delete fromAwsEcr fromGcpArtifactRegistry fromId fromRegistry

Accessors

imageId

get imageId(): string
Returns string
- Defined in src/image.ts:35

Methods

build

build(app: App): Promise<Image>
Eagerly builds an Image on Modal.
Parameters
- app: App
  App to use to build the Image.
Returns Promise<Image>
- Defined in src/image.ts:132

`Static`delete

delete(imageId: string, _?: ImageDeleteOptions): Promise<void>
Delete an Image by ID. Warning: This removes an entire Image, and cannot be undone.
Parameters
- imageId: string
- _: ImageDeleteOptions = {}
Returns Promise<void>
- Defined in src/image.ts:206

`Static`fromAwsEcr

fromAwsEcr(tag: string, secret: Secret): Image
Creates an Image from a raw registry tag, optionally using a Secret for authentication.
Parameters
- tag: string
  The registry tag for the Image.
- secret: Secret
  A Secret containing credentials for registry authentication.
Returns Image
- Defined in src/image.ts:89

`Static`fromGcpArtifactRegistry

fromGcpArtifactRegistry(tag: string, secret: Secret): Image
Creates an Image from a raw registry tag, optionally using a Secret for authentication.
Parameters
- tag: string
  The registry tag for the Image.
- secret: Secret
  A Secret containing credentials for registry authentication.
Returns Image
- Defined in src/image.ts:111

`Static`fromId

fromId(imageId: string): Promise<Image>
Creates an Image from an Image ID
Parameters
- imageId: string
  Image ID.
Returns Promise<Image>
- Defined in src/image.ts:44

`Static`fromRegistry

fromRegistry(tag: string, secret?: Secret): Image
Creates an Image from a raw registry tag, optionally using a Secret for authentication.
Parameters
- tag: string
  The registry tag for the Image.
- Optionalsecret: Secret
  Optional. A Secret containing credentials for registry authentication.
Returns Image
- Defined in src/image.ts:67