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

Readonly credentialManager

credentialManager: CredentialManager

Credential manager holding credentials associated with the stack

Readonly data

data: Record<string, unknown>

Data associated with the stack

Readonly dependencies

dependencies: readonly string[]

Other stacks that the stack depends on

Readonly dependents

dependents: readonly string[]

Other stacks that depend on the stack

Readonly getClient

getClient: (() => Promise<CloudFormation>)

Get CloudFormation client

Type declaration

    • (): Promise<CloudFormation>

    • Returns Promise<CloudFormation>

Readonly getCredentials

getCredentials: (() => Promise<AwsCredentialIdentity>)

Credentials associated with the stack

Type declaration

    • (): Promise<AwsCredentialIdentity>

    • Returns Promise<AwsCredentialIdentity>

Readonly getCurrentCloudFormationStack

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

Get current CloudFormation stack

Type declaration

Readonly logger

logger: TkmLogger

Logger instance associated with the stack

Readonly name

name: string

Name of the stack

Readonly path

path: string

Path of the stack

Optional Readonly project

project?: string

Project of the stack

Readonly region

region: string

Region where the stack is deployed

Readonly stackGroupPath

stackGroupPath: string

Path of the stack group where the stack belongs to

Settings

Member Visibility

Theme

On This Page

credentialManagerdatadependenciesdependentsgetClientgetCredentialsgetCurrentCloudFormationStackloggernamepathprojectregionstackGroupPath

Generated using TypeDoc