Interface StacksContext

Provides access to the current stack context and project configuration.

interface StacksContext {
    autoConfirmEnabled: boolean;
    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 full)

Properties

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

Properties

ReadonlyautoConfirmEnabled

autoConfirmEnabled: boolean

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

ReadonlyconfidentialValuesLoggingEnabled

confidentialValuesLoggingEnabled: boolean

Log confidential information during operations.

ReadonlycredentialManager

credentialManager: CredentialManager

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

Optional Readonlycredentials

credentials?: AwsCredentialIdentity

Credentials used to invoke the current operation.

ReadonlygetStackByExactPath

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.

ReadonlygetStacksByPath

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

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

ReadonlyiamGeneratePoliciesInstructionsEnabled

iamGeneratePoliciesInstructionsEnabled: boolean

Show command to generate IAM policies.

ReadonlylogLevel

logLevel: LogLevel

Logging level.

ReadonlyoutputFormat

outputFormat: OutputFormat

Output format.

ReadonlyprojectConfig

projectConfig: TakomoProjectConfig

Project configuration.

ReadonlyprojectDir

projectDir: string

Current project directory containing configuration files.

Readonlyquiet

quiet: boolean

Suppress all logging but the actual command results.

Readonlyregions

regions: readonly string[]

Supported AWS regions.

ReadonlyresetCache

resetCache: boolean

Reset cache before executing operation.

ReadonlystatisticsEnabled

statisticsEnabled: boolean

Show statistics collected during operations.

ReadonlytemplateEngine

templateEngine: TemplateEngine

Template engine instance.

Readonlyvariables

variables: Variables

Variables available in operations.

Settings

Member Visibility

On This Page

Properties