Interface Stack

An interface representing a CloudFormation stack configuration.

interface Stack {
    credentialManager: CredentialManager;
    data: Record<string, unknown>;
    dependencies: readonly string[];
    dependents: readonly string[];
    getClient: () => Promise<CloudFormation>;
    getCredentials: () => Promise<AwsCredentialIdentity>;
    getCurrentCloudFormationStack: () => Promise<
        undefined
        | CloudFormationStack,
    >;
    logger: TkmLogger;
    name: string;
    path: string;
    project?: string;
    region: string;
    stackGroupPath: string;
}

Properties

credentialManager data dependencies dependents getClient getCredentials getCurrentCloudFormationStack logger name path project? region stackGroupPath

Properties

ReadonlycredentialManager

credentialManager: CredentialManager

Credential manager holding credentials associated with the stack

Readonlydata

data: Record<string, unknown>

Data associated with the stack

Readonlydependencies

dependencies: readonly string[]

Other stacks that the stack depends on

Readonlydependents

dependents: readonly string[]

Other stacks that depend on the stack

ReadonlygetClient

getClient: () => Promise<CloudFormation>

Get CloudFormation client

ReadonlygetCredentials

getCredentials: () => Promise<AwsCredentialIdentity>

Credentials associated with the stack

ReadonlygetCurrentCloudFormationStack

getCurrentCloudFormationStack: () => Promise<undefined | CloudFormationStack>

Get current CloudFormation stack

Readonlylogger

logger: TkmLogger

Logger instance associated with the stack

Readonlyname

name: string

Name of the stack

Readonlypath

path: string

Path of the stack

Optional Readonlyproject

project?: string

Project of the stack

Readonlyregion

region: string

Region where the stack is deployed

ReadonlystackGroupPath

stackGroupPath: string

Path of the stack group where the stack belongs to

Settings

Member Visibility

On This Page

Properties