synth-utils.d.ts
 1  import * as core from '@aws-cdk/core';
 2  import * as cxapi from '@aws-cdk/cx-api';
 3  export declare class SynthUtils {
 4      /**
 5       * Returns the cloud assembly template artifact for a stack.
 6       */
 7      static synthesize(stack: core.Stack, options?: core.SynthesisOptions): cxapi.CloudFormationStackArtifact;
 8      /**
 9       * Synthesizes the stack and returns the resulting CloudFormation template.
10       */
11      static toCloudFormation(stack: core.Stack, options?: core.SynthesisOptions): any;
12      /**
13       * @returns Returns a subset of the synthesized CloudFormation template (only specific resource types).
14       */
15      static subset(stack: core.Stack, options: SubsetOptions): any;
16      /**
17       * Synthesizes the stack and returns a `CloudFormationStackArtifact` which can be inspected.
18       * Supports nested stacks as well as normal stacks.
19       *
20       * @return CloudFormationStackArtifact for normal stacks or the actual template for nested stacks
21       * @internal
22       */
23      static _synthesizeWithNested(stack: core.Stack, options?: core.SynthesisOptions): cxapi.CloudFormationStackArtifact | object;
24  }
25  export interface SubsetOptions {
26      /**
27       * Match all resources of the given type
28       */
29      resourceTypes?: string[];
30  }