/** * Properties that describe a physically deployed stack */ export interface PhysicalStack { /** * The name of the stack * * A stack name is unique inside its environment, but not unique globally. */ readonly stackName: string; /** * The environment of the stack * * This environment is always concrete, because even though the CDK app's * stack may be region-agnostic, in order to be deployed it will have to have * been specialized. */ readonly environment: Environment; /** * The ARN of the stack */ readonly stackArn: Arn extends 'arnOptional' ? string | undefined : string; } /** * Result interface for toolkit.deploy operation */ export interface DeployResult { /** * List of stacks deployed by this operation */ readonly stacks: DeployedStack[]; } /** * Information about a deployed stack */ export interface DeployedStack extends PhysicalStack { /** * Hierarchical identifier * * This uniquely identifies the stack inside the CDK app. * * In practice this will be the stack's construct path, but unfortunately the * Cloud Assembly contract doesn't require or guarantee that. */ readonly hierarchicalId: string; /** * The outputs of the deployed CloudFormation stack */ readonly outputs: { [key: string]: string; }; /** * Resources that CloudFormation failed to delete during the stack update * * When a resource replacement or removal triggers a delete that fails, * CloudFormation skips the deletion and completes the update anyway. These * resources are no longer managed by CloudFormation but still exist and may * incur charges. */ readonly deleteFailures: ResourceDeleteFailure[]; } /** * A resource that completed deployment but is still stabilizing * * When deploying with Express Mode, CloudFormation may report a resource as * `*_COMPLETE` while it is still stabilizing asynchronously. CloudFormation * surfaces this via a `ResourceStatusReason` on the completion event. These * resources are deployed, but may not be fully ready to use immediately. */ export interface StabilizingResource { /** * The logical ID of the resource in the CloudFormation template */ readonly logicalResourceId: string; /** * The CloudFormation resource type (e.g. AWS::S3::Bucket) */ readonly resourceType: string; /** * The reason CloudFormation gave for the resource still stabilizing */ readonly reason: string; } /** * A resource that CloudFormation failed to delete during a stack update */ export interface ResourceDeleteFailure { /** * The logical ID of the resource in the CloudFormation template */ readonly logicalResourceId: string; /** * The physical ID of the resource (e.g. an ARN or name) */ readonly physicalResourceId?: string; /** * The CloudFormation resource type (e.g. AWS::S3::Bucket) */ readonly resourceType: string; /** * The reason CloudFormation gave for the deletion failure */ readonly reason: string; } /** * An environment, which is an (account, region) pair */ export interface Environment { /** * The account number */ readonly account: string; /** * The region number */ readonly region: string; } /** * Result interface for toolkit.destroy operation */ export interface DestroyResult { /** * List of stacks destroyed by this operation */ readonly stacks: DestroyedStack[]; } /** * A stack targeted by a destroy operation */ export interface DestroyedStack extends PhysicalStack<'arnOptional'> { /** * Whether the stack existed to begin with * * If `!stackExisted`, the stack didn't exist, wasn't deleted, and `stackArn` * will be `undefined`. */ readonly stackExisted: boolean; } /** * Result interface for toolkit.rollback operation */ export interface RollbackResult { /** * List of stacks rolled back by this operation */ readonly stacks: RolledBackStack[]; } /** * A stack targeted by a rollback operation */ export interface RolledBackStack extends PhysicalStack { /** * What operation we did for this stack * * Either: we did roll it back, or we didn't need to roll it back because * it was already stable. */ readonly result: StackRollbackResult; } export type StackRollbackResult = 'rolled-back' | 'already-stable'; export interface FeatureFlag { readonly module: string; readonly name: string; readonly recommendedValue: unknown; readonly userValue?: unknown; readonly explanation?: string; readonly unconfiguredBehavesLike?: { v2?: any; }; } export type MinimumSeverity = 'error' | 'warn' | 'none'; //# sourceMappingURL=types.d.ts.map