Takomo API Documentation
website·Indexed 31 days ago
https://takomo.ioAPI reference for Takomo version 4.6.1, featuring interfaces for AWS CloudFormation stack management, project configuration, and core utilities including template engines, logging, and schema providers.
What's inside Takomo
- Takomo is a wrapper tool for AWS CloudFormation that enables the organization, parameterization, and deployment of stacks across multiple AWS regions and accounts. Unlike some infrastructure-as-code tools, Takomo does not store a local state file; it relies on configuration files to match locally defined stacks with those existing in the target AWS accounts. It is designed to handle complex environments with inter-stack dependencies, providing a planning phase where users can review changes before execution.
Overview of Takomo for CloudFormation management
Takomo is a wrapper for AWS CloudFormation designed to manage complex infrastructure spanning multiple regions and accounts. Unlike some tools, Takomo is stateless; it does not store infrastructure state locally or remotely, instead relying on configuration files to match locally defined stacks with those in target AWS accounts.
Key capabilities include:
- Organizing and parameterizing stacks across multiple accounts/regions.
- Managing inter-stack dependencies to ensure correct deployment order.
- Providing a deployment plan for review before execution.
- Supporting large-scale deployments via deployment target features.
Overview of Takomo for AWS CloudFormation orchestration
Takomo is an infrastructure-as-code tool used to organize, parameterize, and deploy AWS CloudFormation stacks across multiple AWS accounts and regions. Unlike some tools, Takomo does not store its own state; it determines required actions by comparing declarative configuration files against the current state of stacks in AWS.
Key capabilities include:
- Declarative Configuration: Define stack names, regions, template paths, parameters, and tags in config files.
- Dependency Management: Automatically resolves inter-stack dependencies and determines the correct deployment order, executing in parallel where possible.
- Dynamic Parameter Resolution: Supports runtime resolution of parameters via stack outputs, file contents, shell commands, SSM parameters, and Secrets Manager.
- Template Rendering: Uses Handlebars templating to reduce boilerplate in CloudFormation templates.
- Safety Features: Provides plan previews before application, stack termination protection, and account restrictions.
Overview of Takomo CloudFormation deployment capabilities
Takomo provides a framework to organize, parameterize, and deploy CloudFormation stacks across multiple AWS regions and accounts. It supports extending core functionality using JavaScript/TypeScript and utilizes dynamic Handlebars templating to reduce repetition and copy-pasting within CloudFormation templates. The system includes safety features to review changes before deployment to prevent configuration errors.Overview of Takomo for CloudFormation management
Takomo is a wrapper for AWS CloudFormation designed to manage complex infrastructure spanning multiple regions and accounts. Unlike some tools, Takomo does not store the state of the infrastructure; it relies entirely on local configuration files to match defined stacks with those in target AWS accounts. It allows developers to define stacks, parameters, tags, and regions in configuration files, then generates a deployment plan for review before executing changes.Overview of Takomo for CloudFormation management
Takomo is a wrapper for AWS CloudFormation designed to manage complex infrastructure spanning multiple regions and accounts. It allows developers to define stacks in configuration files (including names, regions, parameters, tags, and template paths) and manages the deployment process by building an execution plan based on these files. Unlike some other tools, Takomo does not store infrastructure state; it relies on configuration files to match local definitions with stacks in target AWS accounts.Overview of Takomo for CloudFormation management
Takomo is a wrapper for AWS CloudFormation designed to manage complex infrastructure spanning multiple regions and accounts. It allows developers to define stacks in configuration files, specifying stack names, regions, parameters, tags, and template files. Unlike some other tools, Takomo does not store infrastructure state; it relies on configuration files to match local definitions with stacks in target AWS accounts.Overview of Takomo Custom Stacks
Custom stacks in Takomo allow the management of resources that cannot be defined using standard CloudFormation stacks. They are primarily used to integrate external deployment tools, such as the Serverless Framework or AWS CDK, into Takomo configurations. Custom stacks support most standard stack properties and are identified by thecustomTypeproperty. Specific configuration for a custom stack type is defined using thecustomConfigproperty.Overview of the TemplateEngine utility
TheTemplateEngineis a utility used to process Handlebars templates. It allows developers to define custom helpers and partials to extend template logic and reuse template fragments before rendering them with a set of variables.Overview of Command Custom Stack
The Command custom stack is a built-in implementation in Takomo that enables the execution of shell commands during the lifecycle phases of a custom stack: create, update, and delete. Note that all commands must output a valid JSON string.Overview of Takomo Infrastructure-as-Code tool
Takomo is an infrastructure-as-code tool designed to organize, parameterize, and deploy AWS CloudFormation stacks across multiple AWS regions and accounts. It acts as a wrapper for CloudFormation, enabling the management of complex, multi-account enterprise environments by using declarative configuration files to define stack names, deployment regions, template paths, input parameters, and tags.Overview of Takomo for CloudFormation management
Takomo is a wrapper for AWS CloudFormation designed to manage complex infrastructure spanning multiple regions and accounts. Unlike some tools, Takomo does not store the state of the infrastructure; it relies entirely on local configuration files to match defined stacks with those existing in target AWS accounts. It allows developers to define stacks, parameters, tags, and dependencies in configuration files, generates an execution plan for review, and then deploys the stacks in the correct order (parallelizing where possible).