modal
    Preparing search index...

    Class ImageService

    Service for managing Images.

    Normally only ever accessed via the client as:

    const modal = new ModalClient();
    const image = await modal.images.fromRegistry("alpine");
    Index

    Constructors

    constructor

    Methods

    delete fromAwsEcr fromGcpArtifactRegistry fromId fromName fromRegistry

    Constructors

    Methods

    • Delete an Image by ID.

      Deletion is irreversible and will prevent Functions/Sandboxes from using the Image.

      Note: When building an Image, each chained method call will create an intermediate Image layer, each with its own ID. Deleting an Image will not delete any of its intermediate layers, only the image identified by the provided ID.

      Parameters

      Returns Promise<void>

    • 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

    • 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

    • Creates an Image from an Image ID

      Parameters

      • imageId: string

        Image ID.

      Returns Promise<Image>

    • Reference a named Image that was previously published.

      Parameters

      • name: string

        Name of the published Image, optionally including a tag as name:tag. If no tag is included, :latest is used.

      • params: ImageFromNameParams = {}

        Optional environment.

      Returns Promise<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

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods