@amazon-codecatalyst/blueprints.sam-serverless-application
Version:
This blueprint creates a project that leverages a serverless application model (SAM) to quickly create and deploy an API. You can choose Java, TypeScript, or Python as the programming language
25 lines (24 loc) • 831 B
TypeScript
import { EnvironmentDefinition } from '@amazon-codecatalyst/blueprint-component.environments';
import { RuntimeMapping } from './models';
import { BlueprintRuntimes } from './runtimeMappings';
interface ReadmeParams {
runtime: string;
runtimeMapping: RuntimeMapping;
lambdas: {
functionName: string;
}[];
defaultReleaseBranch?: string;
environment: EnvironmentDefinition<any>;
cloudFormationStackName: string;
workflowName: string;
sourceRepositoryName: string;
}
export declare function generateReadmeContents(params: ReadmeParams): string;
interface RuntimeReadmeSectionData {
readmeTestSection: string;
}
type RuntimeReadmeSectionType = {
[key in BlueprintRuntimes]: RuntimeReadmeSectionData;
};
export declare const runtimeReadmeSection: RuntimeReadmeSectionType;
export {};