aws-cdk
Version:
CDK Toolkit, the command line tool for CDK apps
38 lines (37 loc) • 1.7 kB
TypeScript
import * as cxapi from '@aws-cdk/cx-api';
import { BootstrapEnvironmentOptions } from './bootstrap-props';
import { SdkProvider, ISDK } from '../aws-auth';
import { DeployStackResult } from '../deploy-stack';
import { ToolkitInfo } from '../toolkit-info';
/**
* A class to hold state around stack bootstrapping
*
* This class exists so we can break bootstrapping into 2 phases:
*
* ```ts
* const current = BootstrapStack.lookup(...);
* // ...
* current.update(newTemplate, ...);
* ```
*
* And do something in between the two phases (such as look at the
* current bootstrap stack and doing something intelligent).
*/
export declare class BootstrapStack {
private readonly sdkProvider;
private readonly sdk;
private readonly resolvedEnvironment;
private readonly toolkitStackName;
private readonly currentToolkitInfo;
static lookup(sdkProvider: SdkProvider, environment: cxapi.Environment, toolkitStackName?: string): Promise<BootstrapStack>;
protected constructor(sdkProvider: SdkProvider, sdk: ISDK, resolvedEnvironment: cxapi.Environment, toolkitStackName: string, currentToolkitInfo: ToolkitInfo);
get parameters(): Record<string, string>;
get terminationProtection(): boolean | undefined;
partition(): Promise<string>;
/**
* Perform the actual deployment of a bootstrap stack, given a template and some parameters
*/
update(template: any, parameters: Record<string, string | undefined>, options: Omit<BootstrapEnvironmentOptions, 'parameters'>): Promise<DeployStackResult>;
}
export declare function bootstrapVersionFromTemplate(template: any): number;
export declare function bootstrapVariantFromTemplate(template: any): string;