Pulumi API

Generated public TypeScript reference for @relkit/pulumi.

For configuration and examples, read deployment, deployment, aws.

Public imports

• @relkit/pulumi — 0 exports
• @relkit/pulumi/engine — 48 exports

All exported APIs

Names link to their complete contracts. Re-exports share their original contract; legacy exports keep their separate identity. Examples link to the API’s inline sample, a maintained repository usage, or the shared module walkthrough.

index.ts

Declares selected Pulumi engine metadata and exposes its owning deployment implementation.

“@relkit/deploy-pulumi” (namespace export)

Re-exports all named exports from the “@relkit/deploy-pulumi” module.

Signature

export * from "@relkit/deploy-pulumi";

Source

deploymentIntegration

Signature

declare const deploymentIntegration: Readonly<{
  kind: "deployment-integration";
  protocolVersion: 1;
  integrationId: "pulumi";
  role: "engine";
}>;

Source

pulumiEngine

Signature

declare const pulumiEngine: Readonly<{
  kind: "deployment-integration";
  protocolVersion: 1;
  integrationId: "pulumi";
  role: "engine";
}>;

Source

index.ts

events-report.ts

createOutputReport

Signature

declare const createOutputReport: (
  outputs: OutputMap,
  options: PulumiEventOptions,
) => PulumiOutputReport;

Source

createPreviewReport

Signature

declare const createPreviewReport: (
  result: Pick<PreviewResult, "changeSummary">,
  events: readonly EngineEvent[],
  toLog: (event: EngineEvent) => PulumiEventLog | undefined,
) => PulumiPreviewReport;

Source

createUpdateReport

Signature

declare const createUpdateReport: (
  result: Pick<UpResult, "summary" | "outputs">,
  events: readonly EngineEvent[],
  toLog: (event: EngineEvent) => PulumiEventLog | undefined,
  options: PulumiEventOptions,
) => PulumiUpdateReport;

Source

formatPulumiSummary

Signature

declare const formatPulumiSummary: (
  summary: PulumiPreviewReport["summary"],
  operation?: string,
) => string;

Source

serializePulumiReport

Signature

declare const serializePulumiReport: (report: PulumiReport, options?: PulumiEventOptions) => string;

Source

events-support.ts

OP_TYPES

Signature

declare const OP_TYPES: ReadonlyArray<OpType>;

Source

changes

Signature

declare const changes: (value: OpMap | undefined) => OpMap;

Source

eventLogs

Signature

declare const eventLogs: (
  events: readonly EngineEvent[],
  toLog: (event: EngineEvent) => PulumiEventLog | undefined,
) => readonly PulumiEventLog[];

Source

finiteNumber

Signature

declare const finiteNumber: (value: unknown) => number;

Source

nonNegativeInteger

Signature

declare const nonNegativeInteger: (value: unknown) => number;

Source

redactPulumiOutputs

Signature

declare const redactPulumiOutputs: (
  outputs: OutputMap | PulumiOutputs,
  options: PulumiEventOptions,
) => PulumiOutputs;

Source

resourceLog

Signature

declare const resourceLog: (
  base: (kind: string, level: "info" | "error", message: string, fields?: object) => PulumiEventLog,
  kind: string,
  message: string,
  event: {
    readonly metadata: {
      readonly op: OpType;
      readonly urn: string;
      readonly type: string;
      readonly logical?: boolean;
    };
  },
  extra?: object,
) => PulumiEventLog;

Source

safeFields

Signature

declare const safeFields: (
  value: object,
  options: PulumiEventOptions,
) => Readonly<Record<string, JsonValue>>;

Source

safeText

Signature

declare const safeText: (value: unknown, options: PulumiEventOptions) => string;

Source

safeValue

Signature

declare const safeValue: (value: unknown, options: PulumiEventOptions) => JsonValue;

Source

summarizePulumiEvents

Signature

declare const summarizePulumiEvents: (events: readonly EngineEvent[]) => PulumiEventSummary;

Source

events-types.ts

PULUMI_REPORT_VERSION

Signature

declare const PULUMI_REPORT_VERSION: 1;

Source

PulumiEventLog (interface)

Signature

export interface PulumiEventLog {
  readonly sequence: number;
  readonly timestamp: number;
  readonly kind: string;
  readonly level: PulumiLogLevel;
  readonly message: string;
  readonly fields: Readonly<Record<string, JsonValue>>;
}

Source

PulumiEventOptions (interface)

Signature

export interface PulumiEventOptions {
  readonly redaction?: import("@relkit/observability").RedactionPolicy;
  readonly redact?: (value: unknown) => JsonValue;
}

Source

PulumiEventSummary (interface)

Signature

export interface PulumiEventSummary {
  readonly resourceChanges: OpMap;
  readonly diagnostics: Readonly<{
    readonly info: number;
    readonly warning: number;
    readonly error: number;
  }>;
  readonly maybeCorrupt: boolean;
  readonly durationSeconds?: number;
  readonly result?: UpdateResult;
}

Source

PulumiLogLevel (type alias)

Signature

type PulumiLogLevel = "info" | "warn" | "error";

Source

PulumiOutput (interface)

Signature

export interface PulumiOutput {
  readonly secret: false;
  readonly value: JsonValue;
}

Source

PulumiOutputReport (interface)

Signature

export interface PulumiOutputReport {
  readonly version: typeof PULUMI_REPORT_VERSION;
  readonly kind: "outputs";
  readonly outputs: PulumiOutputs;
}

Source

PulumiOutputValue (type alias)

Signature

type PulumiOutputValue = PulumiOutput | PulumiSecretOutput;

Source

PulumiOutputs (type alias)

Signature

type PulumiOutputs = Readonly<Record<string, PulumiOutputValue>>;

Source

PulumiPreviewReport (interface)

Signature

export interface PulumiPreviewReport {
  readonly version: typeof PULUMI_REPORT_VERSION;
  readonly kind: "preview";
  readonly summary: PulumiEventSummary;
  readonly logs: readonly PulumiEventLog[];
}

Source

PulumiReport (type alias)

Signature

type PulumiReport = PulumiPreviewReport | PulumiUpdateReport | PulumiOutputReport;

Source

PulumiSecretOutput (interface)

Signature

export interface PulumiSecretOutput {
  readonly secret: true;
}

Source

PulumiUpdateReport (interface)

Signature

export interface PulumiUpdateReport {
  readonly version: typeof PULUMI_REPORT_VERSION;
  readonly kind: "update";
  readonly summary: PulumiEventSummary;
  readonly outputs: PulumiOutputs;
  readonly logs: readonly PulumiEventLog[];
}

Source

events.ts

PULUMI_REPORT_VERSION

Signature

declare const PULUMI_REPORT_VERSION: 1;

Source

PulumiEventLog

Signature

declare const PulumiEventLog: any;

Source

PulumiEventOptions

Signature

declare const PulumiEventOptions: any;

Source

PulumiEventSummary

Signature

declare const PulumiEventSummary: any;

Source

PulumiLogLevel

Signature

declare const PulumiLogLevel: any;

Source

PulumiOutput

Signature

declare const PulumiOutput: any;

Source

PulumiOutputReport

Signature

declare const PulumiOutputReport: any;

Source

PulumiOutputValue

Signature

declare const PulumiOutputValue: any;

Source

PulumiOutputs

Signature

declare const PulumiOutputs: any;

Source

PulumiPreviewReport

Signature

declare const PulumiPreviewReport: any;

Source

PulumiReport

Signature

declare const PulumiReport: any;

Source

PulumiSecretOutput

Signature

declare const PulumiSecretOutput: any;

Source

PulumiUpdateReport

Signature

declare const PulumiUpdateReport: any;

Source

createOutputReport

Signature

declare const createOutputReport: (
  outputs: OutputMap,
  options?: PulumiEventOptions,
) => PulumiOutputReport;

Source

createPreviewReport

Signature

declare const createPreviewReport: (
  result: Pick<PreviewResult, "changeSummary">,
  events?: readonly EngineEvent[],
  options?: PulumiEventOptions,
) => PulumiPreviewReport;

Source

createPulumiEventLogger

Adapts the synchronous Automation API callback to an existing Effect runtime/logger.

Signature

declare const createPulumiEventLogger: (
  emit: (effect: Effect.Effect<void>) => void,
  options?: PulumiEventOptions,
) => (event: EngineEvent) => void;

Source

createUpdateReport

Signature

declare const createUpdateReport: (
  result: Pick<UpResult, "summary" | "outputs">,
  events?: readonly EngineEvent[],
  options?: PulumiEventOptions,
) => PulumiUpdateReport;

Source

formatPulumiSummary

Signature

declare const formatPulumiSummary: (
  summary: PulumiPreviewReport["summary"],
  operation?: string,
) => string;

Source

redactPulumiOutputs

Signature

declare const redactPulumiOutputs: (
  outputs: OutputMap | PulumiOutputs,
  options: PulumiEventOptions,
) => PulumiOutputs;

Source

serializePulumiReport

Signature

declare const serializePulumiReport: (report: PulumiReport, options?: PulumiEventOptions) => string;

Source

summarizePulumiEvents

Produces a stable summary from event order-independent engine data.

Signature

declare const summarizePulumiEvents: (events: readonly EngineEvent[]) => PulumiEventSummary;

Source

toPulumiEffectLog

Builds an Effect log with only the already-redacted event message and fields.

Signature

declare const toPulumiEffectLog: (
  event: EngineEvent,
  options?: PulumiEventOptions,
) => Effect.Effect<void>;

Source

toPulumiLog

Converts one Automation API event into safe data suitable for Effect logs.

Signature

declare const toPulumiLog: (
  event: EngineEvent,
  options?: PulumiEventOptions,
) => PulumiEventLog | undefined;

Source

materialization.ts

MaterializeDeploymentOptions (interface)

Signature

export interface MaterializeDeploymentOptions {
  readonly stackName: string;
  readonly integrations: readonly unknown[];
}

Source

materializeDeploymentOperations

Signature

declare const materializeDeploymentOperations: (
  plan: DeploymentPlan,
  options: MaterializeDeploymentOptions,
) => DeploymentProgramMaterialization;

Source

operation-executor.ts

ExecutedDeploymentOperations (interface)

Signature

export interface ExecutedDeploymentOperations {
  readonly outputs: Readonly<Record<string, pulumi.Input<unknown>>>;
  readonly resourceCount: number;
}

Source

executeDeploymentOperations

Signature

declare const executeDeploymentOperations: (
  program: DeploymentProgramMaterialization,
) => ExecutedDeploymentOperations;

Source

program.ts

PULUMI_PROGRAM_VERSION

Signature

declare const PULUMI_PROGRAM_VERSION: 1;

Source

PulumiIntegrationImport (interface)

Signature

export interface PulumiIntegrationImport {
  readonly integrationId: string;
  readonly role: "engine" | "host" | "infrastructure" | "access";
  readonly packageName: string;
  readonly packageVersion: string;
  readonly exportName: string;
}

Source

PulumiProgramFiles (interface)

Signature

export interface PulumiProgramFiles {
  readonly directory: string;
  readonly projectName: string;
  readonly stackName: string;
  readonly pulumiYaml: string;
  readonly indexTs: string;
  readonly planJson: string;
}

Source

PulumiProgramOptions (interface)

Signature

export interface PulumiProgramOptions {
  readonly stackName?: string;
  readonly projectName?: string;
  readonly projectRoot?: string;
  readonly directory?: string;
  readonly integrations?: readonly unknown[];
  readonly integrationImports?: readonly PulumiIntegrationImport[];
}

Source

createInlinePulumiProgram

Signature

declare const createInlinePulumiProgram: (
  plan: DeploymentPlan,
  options?: PulumiProgramOptions,
) => PulumiFn;

Source

createPulumiProgram

Creates the same plan-only resource tree for Pulumi Automation API inline use.

Signature

declare const createPulumiProgram: (
  plan: DeploymentPlan,
  options?: PulumiProgramOptions,
) => PulumiFn;

Source

materializePulumiDeployment

Signature

declare const materializePulumiDeployment: (
  plan: DeploymentPlan,
  options: { readonly stackName: string; readonly integrations: readonly unknown[] },
) => ExecutedDeploymentOperations;

Source

renderPulumiProgram

Renders a path-independent Pulumi project from a provider-neutral plan.

Signature

declare const renderPulumiProgram: (
  plan: DeploymentPlan,
  options?: PulumiProgramOptions,
) => PulumiProgramFiles;

Source

writePulumiProgram

Writes only the deterministic Pulumi project files and returns their contents.

Signature

declare const writePulumiProgram: (
  plan: DeploymentPlan,
  options?: PulumiProgramOptions,
) => Promise<PulumiProgramFiles>;

Source

workspace.ts

Acquires an explicitly selected native Pulumi workspace without changing backend or stack ownership.

PULUMI_CLOUD_BACKEND_URL

Signature

declare const PULUMI_CLOUD_BACKEND_URL: "https://api.pulumi.com";

Source

PulumiBackend (interface)

Signature

export interface PulumiBackend {
  readonly kind: PulumiBackendKind;
  readonly url?: string;
  readonly directory?: string;
}

Source

PulumiBackendKind (type alias)

Signature

type PulumiBackendKind = "cloud" | "object-storage" | "local";

Source

PulumiStackMode (type alias)

Signature

type PulumiStackMode = "create" | "select" | "create-or-select";

Source

PulumiWorkspaceConfigurationError (class)

Signature

declare class PulumiWorkspaceConfigurationError {
  constructor(message: string);
}

Source

code (property)

Signature

readonly code: "RELKIT_PULUMI_WORKSPACE_INVALID"

Source

PulumiWorkspaceHandle (interface)

Signature

export interface PulumiWorkspaceHandle {
  readonly workspace: LocalWorkspace;
  readonly stack: Stack;
  readonly projectName: string;
  readonly stackName: string;
  readonly workDir: string;
  readonly backend: ResolvedPulumiBackend;
}

Source

PulumiWorkspaceOptions (interface)

Signature

export interface PulumiWorkspaceOptions {
  readonly projectName: string;
  readonly stackName: string;
  readonly workDir?: string;
  readonly backend?: PulumiBackend;
  readonly mode?: PulumiStackMode;
  readonly config?: ConfigMap;
  readonly envVars?: Readonly<Record<string, string>>;
  readonly pulumiHome?: string;
  readonly pulumiCommand?: PulumiCommand;
  readonly program?: PulumiFn;
  readonly secretsProvider?: string;
}

Source

ResolvedPulumiBackend (type alias)

Signature

type ResolvedPulumiBackend = { readonly kind: PulumiBackendKind; readonly url: string };

Source

createPulumiWorkspace

Creates/selects one explicit Pulumi stack and delegates persistence to Pulumi.

Signature

declare const createPulumiWorkspace: (
  options: PulumiWorkspaceOptions,
) => Promise<PulumiWorkspaceHandle>;

Source

resolvePulumiBackend

Resolves a supported Pulumi backend without creating a second state store.

Signature

declare const resolvePulumiBackend: (
  backend?: PulumiBackend,
  workDir?: string,
) => ResolvedPulumiBackend;

Source