Interface StacksContext

Provides access to the current stack context and project configuration.

interface StacksContext {
    autoConfirmEnabled: boolean;
    confidentialValuesLoggingEnabled: boolean;
    credentialManager: CredentialManager;
    credentials?: AwsCredentialIdentity;
    getStackByExactPath: ((path, stackGroupPath?) => Stack);
    getStacksByPath: ((path, stackGroupPath?) => 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

Readonly autoConfirmEnabled

autoConfirmEnabled: boolean

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

Readonly confidentialValuesLoggingEnabled

confidentialValuesLoggingEnabled: boolean

Log confidential information during operations.

Readonly credentialManager

credentialManager: CredentialManager

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

Optional Readonly credentials

credentials?: AwsCredentialIdentity

Credentials used to invoke the current operation.

Readonly getStackByExactPath

getStackByExactPath: ((path, stackGroupPath?) => 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.

Type declaration

    • (path, stackGroupPath?): Stack

    • Parameters

      • path: string
      • Optional stackGroupPath: string

      Returns Stack

Readonly getStacksByPath

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

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

Type declaration

    • (path, stackGroupPath?): readonly Stack[]

    • Parameters

      • path: string
      • Optional stackGroupPath: string

      Returns readonly Stack[]

Readonly iamGeneratePoliciesInstructionsEnabled

iamGeneratePoliciesInstructionsEnabled: boolean

Show command to generate IAM policies.

Readonly logLevel

logLevel: LogLevel

Logging level.

Readonly outputFormat

outputFormat: OutputFormat

Output format.

Readonly projectConfig

projectConfig: TakomoProjectConfig

Project configuration.

Readonly projectDir

projectDir: string

Current project directory containing configuration files.

Readonly quiet

quiet: boolean

Suppress all logging but the actual command results.

Readonly regions

regions: readonly string[]

Supported AWS regions.

Readonly resetCache

resetCache: boolean

Reset cache before executing operation.

Readonly statisticsEnabled

statisticsEnabled: boolean

Show statistics collected during operations.

Readonly templateEngine

templateEngine: TemplateEngine

Template engine instance.

Readonly variables

variables: Variables

Variables available in operations.

Settings

Member Visibility

Theme

On This Page

autoConfirmEnabledconfidentialValuesLoggingEnabledcredentialManagercredentialsgetStackByExactPathgetStacksByPathiamGeneratePoliciesInstructionsEnabledlogLeveloutputFormatprojectConfigprojectDirquietregionsresetCachestatisticsEnabledtemplateEnginevariables

Generated using TypeDoc