Takomo v7.4.3
    Preparing search index...

    Interface StacksContext

    Provides access to the current stack context and project configuration.

    interface StacksContext {
        autoConfirmEnabled: boolean;
        cache: Cache;
        confidentialValuesLoggingEnabled: boolean;
        credentialManager: CredentialManager;
        credentials?: AwsCredentialIdentity;
        getStackByExactPath: (path: string, stackGroupPath?: string) => Stack;
        getStacksByPath: (
            path: string,
            stackGroupPath?: string,
        ) => readonly Stack[];
        iamGeneratePoliciesInstructionsEnabled: boolean;
        logLevel: LogLevel;
        outputFormat: OutputFormat;
        projectConfig: TakomoProjectConfig;
        projectDir: string;
        quiet: boolean;
        regions: readonly string[];
        resetCache: boolean;
        statisticsEnabled: boolean;
        templateEngine: TemplateEngine;
        variables: Variables;
    }

    Hierarchy (View Summary)

    Index

    Properties

    autoConfirmEnabled cache confidentialValuesLoggingEnabled credentialManager credentials? getStackByExactPath getStacksByPath iamGeneratePoliciesInstructionsEnabled logLevel outputFormat projectConfig projectDir quiet regions resetCache statisticsEnabled templateEngine variables

    Properties

    autoConfirmEnabled: boolean

    No confirmation to operations is asked if auto-confirm is enabled.

    cache: Cache

    Shared cache for values that needs to be persisted for the duration of the current operation.

    confidentialValuesLoggingEnabled: boolean

    Log confidential information during operations.

    credentialManager: CredentialManager

    Credential manager that provides access to AWS credentials used to invoke the current operation.

    credentials?: AwsCredentialIdentity

    Credentials used to invoke the current operation.

    getStackByExactPath: (path: string, stackGroupPath?: string) => Stack

    Return a stack by exact path or throw an error if no stack is found. The stack path can be relative if stackGroupPath is given.

    getStacksByPath: (path: string, stackGroupPath?: string) => readonly Stack[]

    Return 0 or more stacks by path. The stack path can be relative if stackGroupPath is given.

    iamGeneratePoliciesInstructionsEnabled: boolean

    Show command to generate IAM policies.

    logLevel: LogLevel

    Logging level.

    outputFormat: OutputFormat

    Output format.

    projectConfig: TakomoProjectConfig

    Project configuration.

    projectDir: string

    Current project directory containing configuration files.

    quiet: boolean

    Suppress all logging but the actual command results.

    regions: readonly string[]

    Supported AWS regions.

    resetCache: boolean

    Reset cache before executing operation.

    statisticsEnabled: boolean

    Show statistics collected during operations.

    templateEngine: TemplateEngine

    Template engine instance.

    variables: Variables

    Variables available in operations.

    Settings

    Member Visibility

    On This Page

    Properties