@allma/cdk-integration-utils/dist/cdk-utils.d.ts

Shared CDK constructs and utilities for integrating external modules with the Allma serverless AI orchestration platform.

import { Construct } from 'constructs';
import { StepType } from '@allma/core-types';
export interface ExternalStepRegistrationProps {
    /**
    The name of the central Allma configuration table.
    */
    configTableName: string;
    /**
    The unique identifier for the step (e.g., 'my-module/my-step').
    */
    moduleIdentifier: string;
    /**
    The user-friendly name for the step in the UI.
    */
    displayName: string;
    /**
    A short description of what the step does.
    */
    description: string;
    /**
    The step's functional type (e.g., DATA_LOAD).
    */
    stepType: StepType;
    /**
    The ARN of the Lambda function that executes the step's logic.
    */
    lambdaArn: string;
    /**
    A default configuration object for the step instance when dragged onto the canvas.
    It will be automatically merged with the moduleIdentifier.
    */
    defaultConfig: Record<string, any>;
}
/**
A reusable CDK utility to register an external step in the Allma DynamoDB registry.
Creates an AwsCustomResource that handles putting the item on deploy/update and deleting it on destroy.
@param scope The CDK Construct scope.
@param id The unique ID for this construct.
@param props The properties for the step registration.
*/
export declare function createExternalStepRegistration(scope: Construct, id: string, props: ExternalStepRegistrationProps): void;
//# sourceMappingURL=cdk-utils.d.ts.map