aws-cdk 0.0.0

package/lib/api/deployments/deployment-result.d.ts

@@ -0,0 +1,21 @@
+export type DeployStackResult = SuccessfulDeployStackResult | NeedRollbackFirstDeployStackResult | ReplacementRequiresRollbackStackResult;
+/** Successfully deployed a stack */
+export interface SuccessfulDeployStackResult {
+    readonly type: 'did-deploy-stack';
+    readonly noOp: boolean;
+    readonly outputs: {
+        [name: string]: string;
+    };
+    readonly stackArn: string;
+}
+/** The stack is currently in a failpaused state, and needs to be rolled back before the deployment */
+export interface NeedRollbackFirstDeployStackResult {
+    readonly type: 'failpaused-need-rollback-first';
+    readonly reason: 'not-norollback' | 'replacement';
+    readonly status: string;
+}
+/** The upcoming change has a replacement, which requires deploying with --rollback */
+export interface ReplacementRequiresRollbackStackResult {
+    readonly type: 'replacement-requires-rollback';
+}
+export declare function assertIsSuccessfulDeployStackResult(x: DeployStackResult): asserts x is SuccessfulDeployStackResult;

package/lib/api/deployments/deployment-result.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.assertIsSuccessfulDeployStackResult = assertIsSuccessfulDeployStackResult;
+const error_1 = require("../../toolkit/error");
+function assertIsSuccessfulDeployStackResult(x) {
+    if (x.type !== 'did-deploy-stack') {
+        throw new error_1.ToolkitError(`Unexpected deployStack result. This should not happen: ${JSON.stringify(x)}. If you are seeing this error, please report it at https://github.com/aws/aws-cdk/issues/new/choose.`);
+    }
+}
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiZGVwbG95bWVudC1yZXN1bHQuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyJkZXBsb3ltZW50LXJlc3VsdC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOztBQTRCQSxrRkFJQztBQWhDRCwrQ0FBbUQ7QUE0Qm5ELFNBQWdCLG1DQUFtQyxDQUFDLENBQW9CO0lBQ3RFLElBQUksQ0FBQyxDQUFDLElBQUksS0FBSyxrQkFBa0IsRUFBRSxDQUFDO1FBQ2xDLE1BQU0sSUFBSSxvQkFBWSxDQUFDLDBEQUEwRCxJQUFJLENBQUMsU0FBUyxDQUFDLENBQUMsQ0FBQyx1R0FBdUcsQ0FBQyxDQUFDO0lBQzdNLENBQUM7QUFDSCxDQUFDIiwic291cmNlc0NvbnRlbnQiOlsiaW1wb3J0IHsgVG9vbGtpdEVycm9yIH0gZnJvbSAnLi4vLi4vdG9vbGtpdC9lcnJvcic7XG5cbmV4cG9ydCB0eXBlIERlcGxveVN0YWNrUmVzdWx0ID1cbiAgfCBTdWNjZXNzZnVsRGVwbG95U3RhY2tSZXN1bHRcbiAgfCBOZWVkUm9sbGJhY2tGaXJzdERlcGxveVN0YWNrUmVzdWx0XG4gIHwgUmVwbGFjZW1lbnRSZXF1aXJlc1JvbGxiYWNrU3RhY2tSZXN1bHRcbiAgO1xuXG4vKiogU3VjY2Vzc2Z1bGx5IGRlcGxveWVkIGEgc3RhY2sgKi9cbmV4cG9ydCBpbnRlcmZhY2UgU3VjY2Vzc2Z1bERlcGxveVN0YWNrUmVzdWx0IHtcbiAgcmVhZG9ubHkgdHlwZTogJ2RpZC1kZXBsb3ktc3RhY2snO1xuICByZWFkb25seSBub09wOiBib29sZWFuO1xuICByZWFkb25seSBvdXRwdXRzOiB7IFtuYW1lOiBzdHJpbmddOiBzdHJpbmcgfTtcbiAgcmVhZG9ubHkgc3RhY2tBcm46IHN0cmluZztcbn1cblxuLyoqIFRoZSBzdGFjayBpcyBjdXJyZW50bHkgaW4gYSBmYWlscGF1c2VkIHN0YXRlLCBhbmQgbmVlZHMgdG8gYmUgcm9sbGVkIGJhY2sgYmVmb3JlIHRoZSBkZXBsb3ltZW50ICovXG5leHBvcnQgaW50ZXJmYWNlIE5lZWRSb2xsYmFja0ZpcnN0RGVwbG95U3RhY2tSZXN1bHQge1xuICByZWFkb25seSB0eXBlOiAnZmFpbHBhdXNlZC1uZWVkLXJvbGxiYWNrLWZpcnN0JztcbiAgcmVhZG9ubHkgcmVhc29uOiAnbm90LW5vcm9sbGJhY2snIHwgJ3JlcGxhY2VtZW50JztcbiAgcmVhZG9ubHkgc3RhdHVzOiBzdHJpbmc7XG59XG5cbi8qKiBUaGUgdXBjb21pbmcgY2hhbmdlIGhhcyBhIHJlcGxhY2VtZW50LCB3aGljaCByZXF1aXJlcyBkZXBsb3lpbmcgd2l0aCAtLXJvbGxiYWNrICovXG5leHBvcnQgaW50ZXJmYWNlIFJlcGxhY2VtZW50UmVxdWlyZXNSb2xsYmFja1N0YWNrUmVzdWx0IHtcbiAgcmVhZG9ubHkgdHlwZTogJ3JlcGxhY2VtZW50LXJlcXVpcmVzLXJvbGxiYWNrJztcbn1cblxuZXhwb3J0IGZ1bmN0aW9uIGFzc2VydElzU3VjY2Vzc2Z1bERlcGxveVN0YWNrUmVzdWx0KHg6IERlcGxveVN0YWNrUmVzdWx0KTogYXNzZXJ0cyB4IGlzIFN1Y2Nlc3NmdWxEZXBsb3lTdGFja1Jlc3VsdCB7XG4gIGlmICh4LnR5cGUgIT09ICdkaWQtZGVwbG95LXN0YWNrJykge1xuICAgIHRocm93IG5ldyBUb29sa2l0RXJyb3IoYFVuZXhwZWN0ZWQgZGVwbG95U3RhY2sgcmVzdWx0LiBUaGlzIHNob3VsZCBub3QgaGFwcGVuOiAke0pTT04uc3RyaW5naWZ5KHgpfS4gSWYgeW91IGFyZSBzZWVpbmcgdGhpcyBlcnJvciwgcGxlYXNlIHJlcG9ydCBpdCBhdCBodHRwczovL2dpdGh1Yi5jb20vYXdzL2F3cy1jZGsvaXNzdWVzL25ldy9jaG9vc2UuYCk7XG4gIH1cbn1cbiJdfQ==

package/lib/api/deployments/deployments.d.ts

@@ -0,0 +1,340 @@
+import * as cxapi from '@aws-cdk/cx-api';
+import * as cdk_assets from 'cdk-assets';
+import { type BuildAssetsOptions, type PublishAssetsOptions } from './asset-publishing';
+import { type ResourceIdentifierSummaries, ResourcesToImport, Template } from './cloudformation';
+import { DeploymentMethod } from './deployment-method';
+import { DeployStackResult } from './deployment-result';
+import { type RootTemplateWithNestedStacks } from './nested-stack-helpers';
+import type { SdkProvider } from '../aws-auth/sdk-provider';
+import { EnvironmentAccess } from '../environment-access';
+import { HotswapMode, HotswapPropertyOverrides } from '../hotswap/common';
+import type { Tag } from '../tags';
+import { StackActivityProgress } from '../util/cloudformation/stack-activity-monitor';
+export interface DeployStackOptions {
+    /**
+     * Stack to deploy
+     */
+    readonly stack: cxapi.CloudFormationStackArtifact;
+    /**
+     * Execution role for the deployment (pass through to CloudFormation)
+     *
+     * @default - Current role
+     */
+    readonly roleArn?: string;
+    /**
+     * Topic ARNs to send a message when deployment finishes (pass through to CloudFormation)
+     *
+     * @default - No notifications
+     */
+    readonly notificationArns?: string[];
+    /**
+     * Override name under which stack will be deployed
+     *
+     * @default - Use artifact default
+     */
+    readonly deployName?: string;
+    /**
+     * Don't show stack deployment events, just wait
+     *
+     * @default false
+     */
+    readonly quiet?: boolean;
+    /**
+     * Name of the toolkit stack, if not the default name
+     *
+     * @default 'CDKToolkit'
+     */
+    readonly toolkitStackName?: string;
+    /**
+     * List of asset IDs which should NOT be built or uploaded
+     *
+     * @default - Build all assets
+     */
+    readonly reuseAssets?: string[];
+    /**
+     * Stack tags (pass through to CloudFormation)
+     */
+    readonly tags?: Tag[];
+    /**
+     * Stage the change set but don't execute it
+     *
+     * @default - true
+     * @deprecated Use 'deploymentMethod' instead
+     */
+    readonly execute?: boolean;
+    /**
+     * Optional name to use for the CloudFormation change set.
+     * If not provided, a name will be generated automatically.
+     *
+     * @deprecated Use 'deploymentMethod' instead
+     */
+    readonly changeSetName?: string;
+    /**
+     * Select the deployment method (direct or using a change set)
+     *
+     * @default - Change set with default options
+     */
+    readonly deploymentMethod?: DeploymentMethod;
+    /**
+     * Force deployment, even if the deployed template is identical to the one we are about to deploy.
+     * @default false deployment will be skipped if the template is identical
+     */
+    readonly force?: boolean;
+    /**
+     * Extra parameters for CloudFormation
+     * @default - no additional parameters will be passed to the template
+     */
+    readonly parameters?: {
+        [name: string]: string | undefined;
+    };
+    /**
+     * Use previous values for unspecified parameters
+     *
+     * If not set, all parameters must be specified for every deployment.
+     *
+     * @default true
+     */
+    readonly usePreviousParameters?: boolean;
+    /**
+     * Display mode for stack deployment progress.
+     *
+     * @default - StackActivityProgress.Bar - stack events will be displayed for
+     *   the resource currently being deployed.
+     */
+    readonly progress?: StackActivityProgress;
+    /**
+     * Whether we are on a CI system
+     *
+     * @default false
+     */
+    readonly ci?: boolean;
+    /**
+     * Rollback failed deployments
+     *
+     * @default true
+     */
+    readonly rollback?: boolean;
+    readonly hotswap?: HotswapMode;
+    /**
+    * Properties that configure hotswap behavior
+    */
+    readonly hotswapPropertyOverrides?: HotswapPropertyOverrides;
+    /**
+     * The extra string to append to the User-Agent header when performing AWS SDK calls.
+     *
+     * @default - nothing extra is appended to the User-Agent header
+     */
+    readonly extraUserAgent?: string;
+    /**
+     * List of existing resources to be IMPORTED into the stack, instead of being CREATED
+     */
+    readonly resourcesToImport?: ResourcesToImport;
+    /**
+     * If present, use this given template instead of the stored one
+     *
+     * @default - Use the stored template
+     */
+    readonly overrideTemplate?: any;
+    /**
+     * Whether to build/publish assets in parallel
+     *
+     * @default true To remain backward compatible.
+     */
+    readonly assetParallelism?: boolean;
+    /**
+     * Whether to deploy if the app contains no stacks.
+     *
+     * @default false
+     */
+    ignoreNoStacks?: boolean;
+}
+export interface RollbackStackOptions {
+    /**
+     * Stack to roll back
+     */
+    readonly stack: cxapi.CloudFormationStackArtifact;
+    /**
+     * Execution role for the deployment (pass through to CloudFormation)
+     *
+     * @default - Current role
+     */
+    readonly roleArn?: string;
+    /**
+     * Don't show stack deployment events, just wait
+     *
+     * @default false
+     */
+    readonly quiet?: boolean;
+    /**
+     * Whether we are on a CI system
+     *
+     * @default false
+     */
+    readonly ci?: boolean;
+    /**
+     * Name of the toolkit stack, if not the default name
+     *
+     * @default 'CDKToolkit'
+     */
+    readonly toolkitStackName?: string;
+    /**
+     * Whether to force a rollback or not
+     *
+     * Forcing a rollback will orphan all undeletable resources.
+     *
+     * @default false
+     */
+    readonly force?: boolean;
+    /**
+     * Orphan the resources with the given logical IDs
+     *
+     * @default - No orphaning
+     */
+    readonly orphanLogicalIds?: string[];
+    /**
+     * Display mode for stack deployment progress.
+     *
+     * @default - StackActivityProgress.Bar - stack events will be displayed for
+     *   the resource currently being deployed.
+     */
+    readonly progress?: StackActivityProgress;
+    /**
+     * Whether to validate the version of the bootstrap stack permissions
+     *
+     * @default true
+     */
+    readonly validateBootstrapStackVersion?: boolean;
+}
+export interface RollbackStackResult {
+    readonly notInRollbackableState?: boolean;
+    readonly success?: boolean;
+}
+interface AssetOptions {
+    /**
+     * Stack with assets to build.
+     */
+    readonly stack: cxapi.CloudFormationStackArtifact;
+    /**
+     * Execution role for the building.
+     *
+     * @default - Current role
+     */
+    readonly roleArn?: string;
+}
+export interface BuildStackAssetsOptions extends AssetOptions {
+    /**
+     * Options to pass on to `buildAssets()` function
+     */
+    readonly buildOptions?: BuildAssetsOptions;
+    /**
+     * Stack name this asset is for
+     */
+    readonly stackName?: string;
+}
+interface PublishStackAssetsOptions extends AssetOptions {
+    /**
+     * Options to pass on to `publishAsests()` function
+     */
+    readonly publishOptions?: Omit<PublishAssetsOptions, 'buildAssets'>;
+    /**
+     * Stack name this asset is for
+     */
+    readonly stackName?: string;
+}
+export interface DestroyStackOptions {
+    stack: cxapi.CloudFormationStackArtifact;
+    deployName?: string;
+    roleArn?: string;
+    quiet?: boolean;
+    force?: boolean;
+    ci?: boolean;
+}
+export interface StackExistsOptions {
+    stack: cxapi.CloudFormationStackArtifact;
+    deployName?: string;
+    tryLookupRole?: boolean;
+}
+export interface DeploymentsProps {
+    sdkProvider: SdkProvider;
+    readonly toolkitStackName?: string;
+    readonly quiet?: boolean;
+}
+/**
+ * Scope for a single set of deployments from a set of Cloud Assembly Artifacts
+ *
+ * Manages lookup of SDKs, Bootstrap stacks, etc.
+ */
+export declare class Deployments {
+    private readonly props;
+    readonly envs: EnvironmentAccess;
+    /**
+     * SDK provider for asset publishing (do not use for anything else).
+     *
+     * This SDK provider is only allowed to be used for that purpose, nothing else.
+     *
+     * It's not a different object, but the field name should imply that this
+     * object should not be used directly, except to pass to asset handling routines.
+     */
+    private readonly assetSdkProvider;
+    /**
+     * SDK provider for passing to deployStack
+     *
+     * This SDK provider is only allowed to be used for that purpose, nothing else.
+     *
+     * It's not a different object, but the field name should imply that this
+     * object should not be used directly, except to pass to `deployStack`.
+     */
+    private readonly deployStackSdkProvider;
+    private readonly publisherCache;
+    private _allowCrossAccountAssetPublishing;
+    constructor(props: DeploymentsProps);
+    /**
+     * Resolves the environment for a stack.
+     */
+    resolveEnvironment(stack: cxapi.CloudFormationStackArtifact): Promise<cxapi.Environment>;
+    readCurrentTemplateWithNestedStacks(rootStackArtifact: cxapi.CloudFormationStackArtifact, retrieveProcessedTemplate?: boolean): Promise<RootTemplateWithNestedStacks>;
+    readCurrentTemplate(stackArtifact: cxapi.CloudFormationStackArtifact): Promise<Template>;
+    resourceIdentifierSummaries(stackArtifact: cxapi.CloudFormationStackArtifact): Promise<ResourceIdentifierSummaries>;
+    deployStack(options: DeployStackOptions): Promise<DeployStackResult>;
+    rollbackStack(options: RollbackStackOptions): Promise<RollbackStackResult>;
+    destroyStack(options: DestroyStackOptions): Promise<void>;
+    stackExists(options: StackExistsOptions): Promise<boolean>;
+    private prepareAndValidateAssets;
+    /**
+     * Build all assets in a manifest
+     *
+     * @deprecated Use `buildSingleAsset` instead
+     */
+    buildAssets(asset: cxapi.AssetManifestArtifact, options: BuildStackAssetsOptions): Promise<void>;
+    /**
+     * Publish all assets in a manifest
+     *
+     * @deprecated Use `publishSingleAsset` instead
+     */
+    publishAssets(asset: cxapi.AssetManifestArtifact, options: PublishStackAssetsOptions): Promise<void>;
+    /**
+     * Build a single asset from an asset manifest
+     *
+     * If an assert manifest artifact is given, the bootstrap stack version
+     * will be validated according to the constraints in that manifest artifact.
+     * If that is not necessary, `'no-version-validation'` can be passed.
+     */
+    buildSingleAsset(assetArtifact: cxapi.AssetManifestArtifact | 'no-version-validation', assetManifest: cdk_assets.AssetManifest, asset: cdk_assets.IManifestEntry, options: BuildStackAssetsOptions): Promise<void>;
+    /**
+     * Publish a single asset from an asset manifest
+     */
+    publishSingleAsset(assetManifest: cdk_assets.AssetManifest, asset: cdk_assets.IManifestEntry, options: PublishStackAssetsOptions): Promise<void>;
+    private allowCrossAccountAssetPublishingForEnv;
+    /**
+     * Return whether a single asset has been published already
+     */
+    isSingleAssetPublished(assetManifest: cdk_assets.AssetManifest, asset: cdk_assets.IManifestEntry, options: PublishStackAssetsOptions): Promise<boolean>;
+    /**
+     * Validate that the bootstrap stack has the right version for this stack
+     *
+     * Call into envResources.validateVersion, but prepend the stack name in case of failure.
+     */
+    private validateBootstrapStackVersion;
+    private cachedPublisher;
+}
+export {};