Parameter Store

Parameters Store is used to create parameters that user can utilize in Amorphic Jobs, just like environment variables. They can store data such as database strings, passwords, & more. To learn more, refer to AWS System manager parameter store

Parameter

A Parameter is a key-value pair that can be used in Amorphic ETL jobs or Data Labs. It can be used to store sensitive information like passwords, API keys, etc. To access these parameters in aforementioned resources, user needs to update the resource access for these resources and add the parameter key in the resource.

Parameter Store Operations

The following operations are available in the Parameter Store:

• Create parameter: Create a new parameter in the Parameter Store
• Edit/Delete parameter: Edit or delete an existing parameter

Create parameter

1. Click on + Create Parameter
2. Fill in the required inputs (Details shown in the table below)

Attribute	Description
Parameter Key	Name of the parameter
Description	Description of the parameter
Parameter Type	There are three types of parameter String String list Secure String
Parameter Value	Values for the parameter. In this case, values should be separated by comma (,) For example, abc, string, list, values
Parameter Scope	Scope of the parameter like Global or Private Global: Visible to all users and can be used by any user. Private: Visible to only created user and can be used only by the created user.

Use Case: Creating a parameter

The below is an example of how to create a parameter.

1. Create a parameter in Parameter Store. There are three types of parameters: String, String List, and Secure String.
2. Set the parameter scope to either Global or Private.
3. View, update, or delete the parameter as needed. Updating allows user to change the value and description, while deleting removes the parameter completely.
4. Create the parameter with either the default tenant or user-created tenants.
5. In an ETL job, use the following code to retrieve the parameter's value:

Python

from amorphicutils.common import read_param_store
param_value = read_param_store("adp-string_param", secure=False)

This code retrieves the value of the parameter with the key name "adp-string_param" and stores it in the variable "param_value". The "secure" argument is set to "False" because the parameter is not a Secure String. These can then be utilized "param_value" by user in their ETL job as needed.

Currently, the parameter store supports the following three types of parameters:

String

String type parameter is a parameter with key value pair like a general variable.

String List

String List type parameter is a parameter with key values pair where one key contains list of values separated by commas.

Secure String

A SecureString parameter is any sensitive data that needs to be stored and referenced in a secure manner. If user have data that they don't want other users to alter or reference in plaintext, such as passwords or license keys, create those parameters using the SecureString data type.

Editing/Deleting a parameter

To edit or delete a parameter, open the parameter information and click on the respective buttons in the top right corner.

While deleting a parameter, a point to be noted is that once the parameter is deleted, then all the resources which are using this parameter will be affected. If user wishes to continue, they need to make sure to remove this parameter from all resources.

Default System Parameters

Amorphic default system parameters are used for system level configurations in jobs. For example below image shows Datalake Zone (DLZ) bucket name, ETL bucket name etc. which can be used in glue jobs.

Multi-Tenancy Operations:

Users can even create a parameter within a tenant that they can access. Also, when multi tenancy is enabled, they can only perform tenant-level operations. For more details on Tenants, read�How are tenants associated to an user

Note

System parameters are tenant independent, so they can be accessed by anyone within the Amorphic application.

Create Parameter in Tenant

User must select the tenant under which they want to create the parameter. They will see the list of tenants which can accessed by them. When user selects Default Tenant then they prefix the parameter with project shortname of the environment. If the parameter is created on any other tenant then they prefix with the tenant name.

View Parameter in Tenant

Users can view the details of the parameter along with the tenant name under which the parameter was created.