| 1 | import * as sns from '@aws-cdk/aws-sns';
|
| 2 | import * as core from '@aws-cdk/core';
|
| 3 | import { Construct } from '@aws-cdk/core';
|
| 4 | /**
|
| 5 | * Initialization props for the `NestedStack` construct.
|
| 6 | *
|
| 7 | * @deprecated use core.NestedStackProps instead
|
| 8 | */
|
| 9 | export interface NestedStackProps {
|
| 10 | /**
|
| 11 | * The set value pairs that represent the parameters passed to CloudFormation
|
| 12 | * when this nested stack is created. Each parameter has a name corresponding
|
| 13 | * to a parameter defined in the embedded template and a value representing
|
| 14 | * the value that you want to set for the parameter.
|
| 15 | *
|
| 16 | * The nested stack construct will automatically synthesize parameters in order
|
| 17 | * to bind references from the parent stack(s) into the nested stack.
|
| 18 | *
|
| 19 | * @default - no user-defined parameters are passed to the nested stack
|
| 20 | */
|
| 21 | readonly parameters?: {
|
| 22 | [key: string]: string;
|
| 23 | };
|
| 24 | /**
|
| 25 | * The length of time that CloudFormation waits for the nested stack to reach
|
| 26 | * the CREATE_COMPLETE state.
|
| 27 | *
|
| 28 | * When CloudFormation detects that the nested stack has reached the
|
| 29 | * CREATE_COMPLETE state, it marks the nested stack resource as
|
| 30 | * CREATE_COMPLETE in the parent stack and resumes creating the parent stack.
|
| 31 | * If the timeout period expires before the nested stack reaches
|
| 32 | * CREATE_COMPLETE, CloudFormation marks the nested stack as failed and rolls
|
| 33 | * back both the nested stack and parent stack.
|
| 34 | *
|
| 35 | * @default - no timeout
|
| 36 | */
|
| 37 | readonly timeout?: core.Duration;
|
| 38 | /**
|
| 39 | * The Simple Notification Service (SNS) topics to publish stack related
|
| 40 | * events.
|
| 41 | *
|
| 42 | * @default - notifications are not sent for this stack.
|
| 43 | */
|
| 44 | readonly notifications?: sns.ITopic[];
|
| 45 | }
|
| 46 | /**
|
| 47 | * A CloudFormation nested stack.
|
| 48 | *
|
| 49 | * When you apply template changes to update a top-level stack, CloudFormation
|
| 50 | * updates the top-level stack and initiates an update to its nested stacks.
|
| 51 | * CloudFormation updates the resources of modified nested stacks, but does not
|
| 52 | * update the resources of unmodified nested stacks.
|
| 53 | *
|
| 54 | * Furthermore, this stack will not be treated as an independent deployment
|
| 55 | * artifact (won't be listed in "cdk list" or deployable through "cdk deploy"),
|
| 56 | * but rather only synthesized as a template and uploaded as an asset to S3.
|
| 57 | *
|
| 58 | * Cross references of resource attributes between the parent stack and the
|
| 59 | * nested stack will automatically be translated to stack parameters and
|
| 60 | * outputs.
|
| 61 | *
|
| 62 | * @deprecated use core.NestedStack instead
|
| 63 | */
|
| 64 | export declare class NestedStack extends core.NestedStack {
|
| 65 | constructor(scope: Construct, id: string, props?: NestedStackProps);
|
| 66 | }
|