Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

  • MiraBootstrap

Index

Constructors

constructor

Properties

app

app: MiraApp

args

args: ParsedArgs

cdkCommand

cdkCommand: string

docsifyCommand

docsifyCommand: string

env

env: string

errorLogger

errorLogger: ErrorLogger

profile

profile: string

spawn

spawn: typeof spawn

stackFile

stackFile: string

Methods

areStackFilesValid

  • areStackFilesValid(): Promise<boolean>

deploy

  • deploy(undeploy?: boolean): Promise<void>
  • Orchestration used for deployment of the given application. This is used whenever developer or CI will try to deploy application. It is important to keep this function as a single place for application deployment so, development environment will have the same deployment process as CI owned environments.

    Parameters

    • Default value undeploy: boolean = false

    Returns Promise<void>

deployCi

  • deployCi(): Promise<void>
  • Orchestration for npx mira cicd command. As an effect, CodePipeline and related services will be deployed together with permission stacks deployed to the target accounts.

    Returns Promise<void>

deployDomain

  • deployDomain(): Promise<void>
  • TODO: check this functionality together with sample app that supports custom domain.

    Returns Promise<void>

extractNestedStackError

  • extractNestedStackError(): Promise<StackEvent[]>

filterStackErrorMessages

  • filterStackErrorMessages(errors: StackEvent[]): StackEvent[]

formatNestedStackError

  • formatNestedStackError(item: StackEvent): string

getArgs

  • getArgs(): string[]
  • Gets the arguments for this stack. It has built-in support for osx/win support.

    Returns string[]

getAwsSdkConstruct

getCDKArgs

  • getCDKArgs(filename: string, isCi?: boolean, env?: undefined | string): string
  • Gets the arguments parsed by the app file provided for the CDK CLI.

    Parameters

    • filename: string

      main application file.

    • Default value isCi: boolean = false

      when "npx mira cicd" command is executed permissions file path is taken from the config.file, NOT from the CLI param.

    • Optional env: undefined | string

      name of current target environment where the stack with role is going to be deployed.

    Returns string

getFirstFailedNestedStackName

  • getFirstFailedNestedStackName(account: Account, stackName: string): Promise<string | undefined>

getProfile

  • getProfile(environment: string): string | void
  • Gets the profile given the env.

    Parameters

    • environment: string

    Returns string | void

getServiceStackName

  • getServiceStackName(account: Account): string

initialize

  • initialize(): Promise<void>

printExtractedNestedStackErrors

  • printExtractedNestedStackErrors(): Promise<void>

runDocs

  • runDocs(): Promise<void>

showHelp

  • showHelp(): ParsedArgs

transpile

  • transpile(): Promise<string | undefined>

undeploy

  • undeploy(): Promise<void>
  • Undeploys a stack. This calls deploy with the undeploy parameter. The only reason to do this is that both calls share almost identical code.

    Returns Promise<void>

useDevConfig

  • useDevConfig<R, Z>(fn: (args: R) => Z, params: [R]): Z
  • Changes context to use dev config if available, and runs passed function. Typical usecase for this function is to set Dev environment in the context of Mira executable. In case of CDK executions 'dev' is set as NODE_ENV during spawn.

    Type parameters

    • R

    • Z

    Parameters

    • fn: (args: R) => Z
        • (args: R): Z
        • Parameters

          • args: R

          Returns Z

    • params: [R]

    Returns Z

Static getServiceStackName

  • getServiceStackName(account: Account): string

Legend

  • Constructor
  • Property
  • Method
  • Constructor
  • Property
  • Method
  • Inherited property
  • Inherited method
  • Private property
  • Private method
  • Static property
  • Static method

Generated using TypeDoc