Custom Input Params

3min
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.
Step 1: Update the JSON Schema (schema.json)
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:
JSON
{
    "$schema": "http://json-schema.org/draft-07/schema#",
    "$id": "schema://microtica/component-aws-s3.json",
    "title": "Component Schema",
    "type": "object",
    "properties": {
        "inputs": {
            "type": "object",
            "properties": {
                "BucketName": {
                    "type": "string",
                    "description": "The name of the bucket."
                },
                "AccessControl": {
                    "type": "string",
                    "description": "The access control setting for the S3 bucket.",
                    "enum": ["Private", "PublicRead"]
                }
            },
            "required": [
                "BucketName",
                "AccessControl"
            ],
            "additionalProperties": false
        }
    },
    "additionalProperties": false
}
{
    "$schema": "http://json-schema.org/draft-07/schema#",
    "$id": "schema://microtica/component-aws-s3.json",
    "title": "Component Schema",
    "type": "object",
    "properties": {
        "inputs": {
            "type": "object",
            "properties": {
                "BucketName": {
                    "type": "string",
                    "description": "The name of the bucket."
                },
                "AccessControl": {
                    "type": "string",
                    "description": "The access control setting for the S3 bucket.",
                    "enum": ["Private", "PublicRead"]
                }
            },
            "required": [
                "BucketName",
                "AccessControl"
            ],
            "additionalProperties": false
        }
    },
    "additionalProperties": false
}
﻿
In this update:
The AccessControl parameter is added under properties with the description and two allowed values (enum): "Private" and "PublicRead".
The parameter is also included in the required array to ensure it must be provided during deployment.
Step 2: Update the CloudFormation Template (index.json)
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:
JSON
{
    "AWSTemplateFormatVersion": "2010-09-09",
    "Description": "AWS S3 Bucket custom component",
    "Parameters": {
        "BucketName": {
            "Type": "String",
            "Default": "",
            "Description": "The name of the S3 bucket"
        },
        "AccessControl": {
            "Type": "String",
            "Description": "The access control setting for the S3 bucket.",
            "AllowedValues": ["Private", "PublicRead"],
            "Default": "Private"
        }
    },
    "Resources": {
        "S3Bucket": {
            "Type": "AWS::S3::Bucket",
            "Properties": {
                "BucketName": {
                    "Ref": "BucketName"
                },
                "AccessControl": {
                    "Ref": "AccessControl"
                }
            }
        }
    },
    "Outputs": {
        "BucketName": {
            "Value": {
                "Ref": "S3Bucket"
            },
            "Description": "Name of the S3 bucket"
        }
    }
}
{
    "AWSTemplateFormatVersion": "2010-09-09",
    "Description": "AWS S3 Bucket custom component",
    "Parameters": {
        "BucketName": {
            "Type": "String",
            "Default": "",
            "Description": "The name of the S3 bucket"
        },
        "AccessControl": {
            "Type": "String",
            "Description": "The access control setting for the S3 bucket.",
            "AllowedValues": ["Private", "PublicRead"],
            "Default": "Private"
        }
    },
    "Resources": {
        "S3Bucket": {
            "Type": "AWS::S3::Bucket",
            "Properties": {
                "BucketName": {
                    "Ref": "BucketName"
                },
                "AccessControl": {
                    "Ref": "AccessControl"
                }
            }
        }
    },
    "Outputs": {
        "BucketName": {
            "Value": {
                "Ref": "S3Bucket"
            },
            "Description": "Name of the S3 bucket"
        }
    }
}
﻿
In this update:
The AccessControl parameter is added under Parameters, with allowed values "Private" and "PublicRead". The default value is set to "Private".
The AccessControl property is referenced in the S3Bucket resource definition, linking it to the corresponding parameter value provided during deployment.
﻿
Updated 14 Aug 2024
Did this page help you?
CloudFormation
Terraform