aws-cdk
Version:
AWS CDK CLI, the command line tool for CDK apps
23 lines (22 loc) • 1.13 kB
TypeScript
import { type CloudFormationStackArtifact, type Environment } from '@aws-cdk/cx-api';
import { type IoHelper } from '../../../../@aws-cdk/tmp-toolkit-helpers/src/api/io/private';
import type { AssetManifestBuilder } from '../deployments';
import type { EnvironmentResources } from '../environment';
export type TemplateBodyParameter = {
TemplateBody?: string;
TemplateURL?: string;
};
/**
* Prepares the body parameter for +CreateChangeSet+.
*
* If the template is small enough to be inlined into the API call, just return
* it immediately.
*
* Otherwise, add it to the asset manifest to get uploaded to the staging
* bucket and return its coordinates. If there is no staging bucket, an error
* is thrown.
*
* @param stack the synthesized stack that provides the CloudFormation template
* @param toolkitInfo information about the toolkit stack
*/
export declare function makeBodyParameter(ioHelper: IoHelper, stack: CloudFormationStackArtifact, resolvedEnvironment: Environment, assetManifest: AssetManifestBuilder, resources: EnvironmentResources, overrideTemplate?: any): Promise<TemplateBodyParameter>;