Interface StacksContext

Provides access to the current stack context and project configuration.

Hierarchy

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?: Credentials

Credentials used to invoke the current operation.

Readonly getStackByExactPath

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

Type declaration

    • (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.

      Parameters

      • path: string
      • Optional stackGroupPath: string

      Returns Stack

Readonly getStacksByPath

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

Type declaration

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

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

      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

Generated using TypeDoc