@aws-cdk/toolkit-lib 0.3.2 → 0.3.3

package/lib/api/cloud-assembly/stack-selector.d.ts

@@ -1,2 +1,81 @@
-export type { StackSelector } from '../shared-public';
-export { ExpandStackSelection, StackSelectionStrategy } from '../shared-public';
+/**
+ * Which stacks should be selected from a cloud assembly
+ */
+export declare enum StackSelectionStrategy {
+    /**
+     * Returns all stacks in the app regardless of patterns,
+     * including stacks inside nested assemblies.
+     */
+    ALL_STACKS = "all-stacks",
+    /**
+     * Returns all stacks in the main (top level) assembly only.
+     */
+    MAIN_ASSEMBLY = "main-assembly",
+    /**
+     * If the assembly includes a single stack, returns it.
+     * Otherwise throws an exception.
+     */
+    ONLY_SINGLE = "only-single",
+    /**
+     * Return stacks matched by patterns.
+     * If no stacks are found, execution is halted successfully.
+     * Most likely you don't want to use this but `StackSelectionStrategy.MUST_MATCH_PATTERN`
+     */
+    PATTERN_MATCH = "pattern-match",
+    /**
+     * Return stacks matched by patterns.
+     * Throws an exception if the patterns don't match at least one stack in the assembly.
+     */
+    PATTERN_MUST_MATCH = "pattern-must-match",
+    /**
+     * Returns if exactly one stack is matched by the pattern(s).
+     * Throws an exception if no stack, or more than exactly one stack are matched.
+     */
+    PATTERN_MUST_MATCH_SINGLE = "pattern-must-match-single"
+}
+/**
+ * When selecting stacks, what other stacks to include because of dependencies
+ */
+export declare enum ExpandStackSelection {
+    /**
+     * Don't select any extra stacks
+     */
+    NONE = "none",
+    /**
+     * Include stacks that this stack depends on
+     */
+    UPSTREAM = "upstream",
+    /**
+     * Include stacks that depend on this stack
+     */
+    DOWNSTREAM = "downstream"
+}
+/**
+ * A specification of which stacks should be selected
+ */
+export interface StackSelector {
+    /**
+     * The behavior if if no selectors are provided.
+     */
+    strategy: StackSelectionStrategy;
+    /**
+     * A list of patterns to match the stack hierarchical ids
+     * Only used with `PATTERN_*` selection strategies.
+     */
+    patterns?: string[];
+    /**
+     * Expand the selection to upstream/downstream stacks.
+     * @default ExpandStackSelection.None only select the specified/matched stacks
+     */
+    expand?: ExpandStackSelection;
+    /**
+     * By default, we throw an exception if the assembly contains no stacks.
+     * Set to `false`, to halt execution for empty assemblies without error.
+     *
+     * Note that actions can still throw if a stack selection result is empty,
+     * but the assembly contains stacks in principle.
+     *
+     * @default true
+     */
+    failOnEmpty?: boolean;
+}

package/lib/api/cloud-assembly/stack-selector.js

@@ -1,7 +1,64 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.StackSelectionStrategy = exports.ExpandStackSelection = void 0;
-var shared_public_1 = require("../shared-public");
-Object.defineProperty(exports, "ExpandStackSelection", { enumerable: true, get: function () { return shared_public_1.ExpandStackSelection; } });
-Object.defineProperty(exports, "StackSelectionStrategy", { enumerable: true, get: function () { return shared_public_1.StackSelectionStrategy; } });
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoic3RhY2stc2VsZWN0b3IuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyJzdGFjay1zZWxlY3Rvci50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOzs7QUFDQSxrREFBZ0Y7QUFBdkUscUhBQUEsb0JBQW9CLE9BQUE7QUFBRSx1SEFBQSxzQkFBc0IsT0FBQSIsInNvdXJjZXNDb250ZW50IjpbImV4cG9ydCB0eXBlIHsgU3RhY2tTZWxlY3RvciB9IGZyb20gJy4uL3NoYXJlZC1wdWJsaWMnO1xuZXhwb3J0IHsgRXhwYW5kU3RhY2tTZWxlY3Rpb24sIFN0YWNrU2VsZWN0aW9uU3RyYXRlZ3kgfSBmcm9tICcuLi9zaGFyZWQtcHVibGljJztcbiJdfQ==
+exports.ExpandStackSelection = exports.StackSelectionStrategy = void 0;
+/**
+ * Which stacks should be selected from a cloud assembly
+ */
+var StackSelectionStrategy;
+(function (StackSelectionStrategy) {
+    /**
+     * Returns all stacks in the app regardless of patterns,
+     * including stacks inside nested assemblies.
+     */
+    StackSelectionStrategy["ALL_STACKS"] = "all-stacks";
+    /**
+     * Returns all stacks in the main (top level) assembly only.
+     */
+    StackSelectionStrategy["MAIN_ASSEMBLY"] = "main-assembly";
+    /**
+     * If the assembly includes a single stack, returns it.
+     * Otherwise throws an exception.
+     */
+    StackSelectionStrategy["ONLY_SINGLE"] = "only-single";
+    /**
+     * Return stacks matched by patterns.
+     * If no stacks are found, execution is halted successfully.
+     * Most likely you don't want to use this but `StackSelectionStrategy.MUST_MATCH_PATTERN`
+     */
+    StackSelectionStrategy["PATTERN_MATCH"] = "pattern-match";
+    /**
+     * Return stacks matched by patterns.
+     * Throws an exception if the patterns don't match at least one stack in the assembly.
+     */
+    StackSelectionStrategy["PATTERN_MUST_MATCH"] = "pattern-must-match";
+    /**
+     * Returns if exactly one stack is matched by the pattern(s).
+     * Throws an exception if no stack, or more than exactly one stack are matched.
+     */
+    StackSelectionStrategy["PATTERN_MUST_MATCH_SINGLE"] = "pattern-must-match-single";
+})(StackSelectionStrategy || (exports.StackSelectionStrategy = StackSelectionStrategy = {}));
+/**
+ * When selecting stacks, what other stacks to include because of dependencies
+ */
+var ExpandStackSelection;
+(function (ExpandStackSelection) {
+    /**
+     * Don't select any extra stacks
+     */
+    ExpandStackSelection["NONE"] = "none";
+    /**
+     * Include stacks that this stack depends on
+     */
+    ExpandStackSelection["UPSTREAM"] = "upstream";
+    /**
+     * Include stacks that depend on this stack
+     */
+    ExpandStackSelection["DOWNSTREAM"] = "downstream";
+    /**
+     * @TODO
+     * Include both directions.
+     * I.e. stacks that this stack depends on, and stacks that depend on this stack.
+     */
+    // FULL = 'full',
+})(ExpandStackSelection || (exports.ExpandStackSelection = ExpandStackSelection = {}));
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoic3RhY2stc2VsZWN0b3IuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyJzdGFjay1zZWxlY3Rvci50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOzs7QUFBQTs7R0FFRztBQUNILElBQVksc0JBb0NYO0FBcENELFdBQVksc0JBQXNCO0lBQ2hDOzs7T0FHRztJQUNILG1EQUF5QixDQUFBO0lBRXpCOztPQUVHO0lBQ0gseURBQStCLENBQUE7SUFFL0I7OztPQUdHO0lBQ0gscURBQTJCLENBQUE7SUFFM0I7Ozs7T0FJRztJQUNILHlEQUErQixDQUFBO0lBRS9COzs7T0FHRztJQUNILG1FQUF5QyxDQUFBO0lBRXpDOzs7T0FHRztJQUNILGlGQUF1RCxDQUFBO0FBQ3pELENBQUMsRUFwQ1csc0JBQXNCLHNDQUF0QixzQkFBc0IsUUFvQ2pDO0FBRUQ7O0dBRUc7QUFDSCxJQUFZLG9CQXNCWDtBQXRCRCxXQUFZLG9CQUFvQjtJQUM5Qjs7T0FFRztJQUNILHFDQUFhLENBQUE7SUFFYjs7T0FFRztJQUNILDZDQUFxQixDQUFBO0lBRXJCOztPQUVHO0lBQ0gsaURBQXlCLENBQUE7SUFFekI7Ozs7T0FJRztJQUNILGlCQUFpQjtBQUNuQixDQUFDLEVBdEJXLG9CQUFvQixvQ0FBcEIsb0JBQW9CLFFBc0IvQiIsInNvdXJjZXNDb250ZW50IjpbIi8qKlxuICogV2hpY2ggc3RhY2tzIHNob3VsZCBiZSBzZWxlY3RlZCBmcm9tIGEgY2xvdWQgYXNzZW1ibHlcbiAqL1xuZXhwb3J0IGVudW0gU3RhY2tTZWxlY3Rpb25TdHJhdGVneSB7XG4gIC8qKlxuICAgKiBSZXR1cm5zIGFsbCBzdGFja3MgaW4gdGhlIGFwcCByZWdhcmRsZXNzIG9mIHBhdHRlcm5zLFxuICAgKiBpbmNsdWRpbmcgc3RhY2tzIGluc2lkZSBuZXN0ZWQgYXNzZW1ibGllcy5cbiAgICovXG4gIEFMTF9TVEFDS1MgPSAnYWxsLXN0YWNrcycsXG5cbiAgLyoqXG4gICAqIFJldHVybnMgYWxsIHN0YWNrcyBpbiB0aGUgbWFpbiAodG9wIGxldmVsKSBhc3NlbWJseSBvbmx5LlxuICAgKi9cbiAgTUFJTl9BU1NFTUJMWSA9ICdtYWluLWFzc2VtYmx5JyxcblxuICAvKipcbiAgICogSWYgdGhlIGFzc2VtYmx5IGluY2x1ZGVzIGEgc2luZ2xlIHN0YWNrLCByZXR1cm5zIGl0LlxuICAgKiBPdGhlcndpc2UgdGhyb3dzIGFuIGV4Y2VwdGlvbi5cbiAgICovXG4gIE9OTFlfU0lOR0xFID0gJ29ubHktc2luZ2xlJyxcblxuICAvKipcbiAgICogUmV0dXJuIHN0YWNrcyBtYXRjaGVkIGJ5IHBhdHRlcm5zLlxuICAgKiBJZiBubyBzdGFja3MgYXJlIGZvdW5kLCBleGVjdXRpb24gaXMgaGFsdGVkIHN1Y2Nlc3NmdWxseS5cbiAgICogTW9zdCBsaWtlbHkgeW91IGRvbid0IHdhbnQgdG8gdXNlIHRoaXMgYnV0IGBTdGFja1NlbGVjdGlvblN0cmF0ZWd5Lk1VU1RfTUFUQ0hfUEFUVEVSTmBcbiAgICovXG4gIFBBVFRFUk5fTUFUQ0ggPSAncGF0dGVybi1tYXRjaCcsXG5cbiAgLyoqXG4gICAqIFJldHVybiBzdGFja3MgbWF0Y2hlZCBieSBwYXR0ZXJucy5cbiAgICogVGhyb3dzIGFuIGV4Y2VwdGlvbiBpZiB0aGUgcGF0dGVybnMgZG9uJ3QgbWF0Y2ggYXQgbGVhc3Qgb25lIHN0YWNrIGluIHRoZSBhc3NlbWJseS5cbiAgICovXG4gIFBBVFRFUk5fTVVTVF9NQVRDSCA9ICdwYXR0ZXJuLW11c3QtbWF0Y2gnLFxuXG4gIC8qKlxuICAgKiBSZXR1cm5zIGlmIGV4YWN0bHkgb25lIHN0YWNrIGlzIG1hdGNoZWQgYnkgdGhlIHBhdHRlcm4ocykuXG4gICAqIFRocm93cyBhbiBleGNlcHRpb24gaWYgbm8gc3RhY2ssIG9yIG1vcmUgdGhhbiBleGFjdGx5IG9uZSBzdGFjayBhcmUgbWF0Y2hlZC5cbiAgICovXG4gIFBBVFRFUk5fTVVTVF9NQVRDSF9TSU5HTEUgPSAncGF0dGVybi1tdXN0LW1hdGNoLXNpbmdsZScsXG59XG5cbi8qKlxuICogV2hlbiBzZWxlY3Rpbmcgc3RhY2tzLCB3aGF0IG90aGVyIHN0YWNrcyB0byBpbmNsdWRlIGJlY2F1c2Ugb2YgZGVwZW5kZW5jaWVzXG4gKi9cbmV4cG9ydCBlbnVtIEV4cGFuZFN0YWNrU2VsZWN0aW9uIHtcbiAgLyoqXG4gICAqIERvbid0IHNlbGVjdCBhbnkgZXh0cmEgc3RhY2tzXG4gICAqL1xuICBOT05FID0gJ25vbmUnLFxuXG4gIC8qKlxuICAgKiBJbmNsdWRlIHN0YWNrcyB0aGF0IHRoaXMgc3RhY2sgZGVwZW5kcyBvblxuICAgKi9cbiAgVVBTVFJFQU0gPSAndXBzdHJlYW0nLFxuXG4gIC8qKlxuICAgKiBJbmNsdWRlIHN0YWNrcyB0aGF0IGRlcGVuZCBvbiB0aGlzIHN0YWNrXG4gICAqL1xuICBET1dOU1RSRUFNID0gJ2Rvd25zdHJlYW0nLFxuXG4gIC8qKlxuICAgKiBAVE9ET1xuICAgKiBJbmNsdWRlIGJvdGggZGlyZWN0aW9ucy5cbiAgICogSS5lLiBzdGFja3MgdGhhdCB0aGlzIHN0YWNrIGRlcGVuZHMgb24sIGFuZCBzdGFja3MgdGhhdCBkZXBlbmQgb24gdGhpcyBzdGFjay5cbiAgICovXG4gIC8vIEZVTEwgPSAnZnVsbCcsXG59XG5cbi8qKlxuICogQSBzcGVjaWZpY2F0aW9uIG9mIHdoaWNoIHN0YWNrcyBzaG91bGQgYmUgc2VsZWN0ZWRcbiAqL1xuZXhwb3J0IGludGVyZmFjZSBTdGFja1NlbGVjdG9yIHtcbiAgLyoqXG4gICAqIFRoZSBiZWhhdmlvciBpZiBpZiBubyBzZWxlY3RvcnMgYXJlIHByb3ZpZGVkLlxuICAgKi9cbiAgc3RyYXRlZ3k6IFN0YWNrU2VsZWN0aW9uU3RyYXRlZ3k7XG5cbiAgLyoqXG4gICAqIEEgbGlzdCBvZiBwYXR0ZXJucyB0byBtYXRjaCB0aGUgc3RhY2sgaGllcmFyY2hpY2FsIGlkc1xuICAgKiBPbmx5IHVzZWQgd2l0aCBgUEFUVEVSTl8qYCBzZWxlY3Rpb24gc3RyYXRlZ2llcy5cbiAgICovXG4gIHBhdHRlcm5zPzogc3RyaW5nW107XG5cbiAgLyoqXG4gICAqIEV4cGFuZCB0aGUgc2VsZWN0aW9uIHRvIHVwc3RyZWFtL2Rvd25zdHJlYW0gc3RhY2tzLlxuICAgKiBAZGVmYXVsdCBFeHBhbmRTdGFja1NlbGVjdGlvbi5Ob25lIG9ubHkgc2VsZWN0IHRoZSBzcGVjaWZpZWQvbWF0Y2hlZCBzdGFja3NcbiAgICovXG4gIGV4cGFuZD86IEV4cGFuZFN0YWNrU2VsZWN0aW9uO1xuXG4gIC8qKlxuICAgKiBCeSBkZWZhdWx0LCB3ZSB0aHJvdyBhbiBleGNlcHRpb24gaWYgdGhlIGFzc2VtYmx5IGNvbnRhaW5zIG5vIHN0YWNrcy5cbiAgICogU2V0IHRvIGBmYWxzZWAsIHRvIGhhbHQgZXhlY3V0aW9uIGZvciBlbXB0eSBhc3NlbWJsaWVzIHdpdGhvdXQgZXJyb3IuXG4gICAqXG4gICAqIE5vdGUgdGhhdCBhY3Rpb25zIGNhbiBzdGlsbCB0aHJvdyBpZiBhIHN0YWNrIHNlbGVjdGlvbiByZXN1bHQgaXMgZW1wdHksXG4gICAqIGJ1dCB0aGUgYXNzZW1ibHkgY29udGFpbnMgc3RhY2tzIGluIHByaW5jaXBsZS5cbiAgICpcbiAgICogQGRlZmF1bHQgdHJ1ZVxuICAgKi9cbiAgZmFpbE9uRW1wdHk/OiBib29sZWFuO1xufVxuIl19

package/lib/api/cloudformation/evaluate-cloudformation-template.d.ts

@@ -0,0 +1,85 @@
+import type { CloudFormationStackArtifact } from '@aws-cdk/cx-api';
+import type { Export, StackResourceSummary } from '@aws-sdk/client-cloudformation';
+import type { SDK } from '../aws-auth/private';
+import type { NestedStackTemplates } from './nested-stack-helpers';
+import type { Template } from './stack-helpers';
+import type { ResourceMetadata } from '../resource-metadata';
+export interface ListStackResources {
+    listStackResources(): Promise<StackResourceSummary[]>;
+}
+export declare class LazyListStackResources implements ListStackResources {
+    private readonly sdk;
+    private readonly stackName;
+    private stackResources;
+    constructor(sdk: SDK, stackName: string);
+    listStackResources(): Promise<StackResourceSummary[]>;
+}
+export interface LookupExport {
+    lookupExport(name: string): Promise<Export | undefined>;
+}
+export declare class LookupExportError extends Error {
+}
+export declare class LazyLookupExport implements LookupExport {
+    private readonly sdk;
+    private cachedExports;
+    constructor(sdk: SDK);
+    lookupExport(name: string): Promise<Export | undefined>;
+    private listExports;
+}
+export declare class CfnEvaluationException extends Error {
+}
+export interface ResourceDefinition {
+    readonly LogicalId: string;
+    readonly Type: string;
+    readonly Properties: {
+        [p: string]: any;
+    };
+}
+export interface EvaluateCloudFormationTemplateProps {
+    readonly stackArtifact: CloudFormationStackArtifact;
+    readonly stackName?: string;
+    readonly template?: Template;
+    readonly parameters: {
+        [parameterName: string]: string;
+    };
+    readonly account: string;
+    readonly region: string;
+    readonly partition: string;
+    readonly sdk: SDK;
+    readonly nestedStacks?: {
+        [nestedStackLogicalId: string]: NestedStackTemplates;
+    };
+}
+export declare class EvaluateCloudFormationTemplate {
+    readonly stackArtifact: CloudFormationStackArtifact;
+    private readonly stackName;
+    private readonly template;
+    private readonly context;
+    private readonly account;
+    private readonly region;
+    private readonly partition;
+    private readonly sdk;
+    private readonly nestedStacks;
+    private readonly stackResources;
+    private readonly lookupExport;
+    private cachedUrlSuffix;
+    constructor(props: EvaluateCloudFormationTemplateProps);
+    createNestedEvaluateCloudFormationTemplate(stackName: string, nestedTemplate: Template, nestedStackParameters: {
+        [parameterName: string]: any;
+    }): Promise<EvaluateCloudFormationTemplate>;
+    establishResourcePhysicalName(logicalId: string, physicalNameInCfnTemplate: any): Promise<string | undefined>;
+    findPhysicalNameFor(logicalId: string): Promise<string | undefined>;
+    findLogicalIdForPhysicalName(physicalName: string): Promise<string | undefined>;
+    findReferencesTo(logicalId: string): Array<ResourceDefinition>;
+    evaluateCfnExpression(cfnExpression: any): Promise<any>;
+    getResourceProperty(logicalId: string, propertyName: string): any;
+    metadataFor(logicalId: string): ResourceMetadata | undefined;
+    private references;
+    private parseIntrinsic;
+    private findRefTarget;
+    private findGetAttTarget;
+    private findNestedStack;
+    private formatResourceAttribute;
+    private getServiceOfResource;
+    private getResourceTypeArnPartOfResource;
+}