CloudFormation

CloudFormation (CFN) components in Microtica provide a robust framework for managing and deploying AWS infrastructure. These components are tightly integrated into the Microtica platform, allowing for seamless automation of infrastructure deployment. Below, you'll find a detailed explanation of each key file involved in a typical CFN component setup.

The index.json file is the core of your CloudFormation component. It defines the AWS resources that will be created or managed using CloudFormation.

The microtica.yaml file outlines the CI/CD pipeline steps that Microtica will execute during the deployment process.

The index.js file is the entry point for managing the lifecycle of the component within Microtica. It uses the Microtica SDK to interact with CloudFormation.

The schema.json file defines the schema for the component, specifying input parameters and ensuring that they conform to the expected structure and types. The input parameters defined in the schema will be visible in the Microtica Console, allowing users to easily configure the component during deployment.

The component.yaml file is a specification file for a Microtica CloudFormation component. It provides metadata and configuration details about the component, including its name, description, and paths to the necessary CloudFormation and schema files.

For a full example, checkout our complete template.

This setup ensures that your CloudFormation component is well-organized, easy to manage, and ready for deployment through Microtica, providing a streamlined way to automate infrastructure management on AWS.

When working with CloudFormation components in Microtica, you may find the need to add custom input parameters to your templates. These parameters can help make your components more flexible and configurable.

First, you need to define the new AccessControl parameter in the schema.json file. This will ensure that the parameter is visible and configurable in the Microtica Console.

Here is how you can update the schema.json file:

In this update:

Next, you need to update the index.json file to include the new AccessControl parameter in the CloudFormation template. This parameter will be used to set the appropriate access control policy on the S3 bucket.

Here’s the updated index.json file:

In this update: