deploy-bootstrap.d.ts
1 import * as cxapi from '@aws-cdk/cx-api'; 2 import { SdkProvider, ISDK } from '../aws-auth'; 3 import { DeployStackResult } from '../deploy-stack'; 4 import { ToolkitInfo } from '../toolkit-info'; 5 import { BootstrapEnvironmentOptions } from './bootstrap-props'; 6 /** 7 * A class to hold state around stack bootstrapping 8 * 9 * This class exists so we can break bootstrapping into 2 phases: 10 * 11 * ```ts 12 * const current = BootstrapStack.lookup(...); 13 * // ... 14 * current.update(newTemplate, ...); 15 * ``` 16 * 17 * And do something in between the two phases (such as look at the 18 * current bootstrap stack and doing something intelligent). 19 */ 20 export declare class BootstrapStack { 21 private readonly sdkProvider; 22 private readonly sdk; 23 private readonly resolvedEnvironment; 24 private readonly toolkitStackName; 25 private readonly currentToolkitInfo; 26 static lookup(sdkProvider: SdkProvider, environment: cxapi.Environment, toolkitStackName?: string): Promise<BootstrapStack>; 27 protected constructor(sdkProvider: SdkProvider, sdk: ISDK, resolvedEnvironment: cxapi.Environment, toolkitStackName: string, currentToolkitInfo: ToolkitInfo); 28 get parameters(): Record<string, string>; 29 get terminationProtection(): boolean | undefined; 30 partition(): Promise<string>; 31 /** 32 * Perform the actual deployment of a bootstrap stack, given a template and some parameters 33 */ 34 update(template: any, parameters: Record<string, string | undefined>, options: Omit<BootstrapEnvironmentOptions, 'parameters'>): Promise<DeployStackResult>; 35 } 36 export declare function bootstrapVersionFromTemplate(template: any): number;