Skip to main content
info
This documentation is for version v2.4 of the product.
For the latest version(v2.7) documentation click here
Version: v2.4 print this page

Parameter Store

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

How to create parameter?

Parameter

  1. Click on + Create Parameter
  2. Fill in the required inputs (Details shown in the table below)
AttributeDescription
Parameter KeyName of the parameter
DescriptionDescription of the parameter
Parameter TypeThere are three types of parameter
  • String
  • String list
  • Secure String
Parameter ValueValues for the parameter. In this case, values should be separated by comma (,) For example, abc, string, list, values
Parameter ScopeScope 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.

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 you 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:
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. You can then use "param_value" in your ETL job as needed.

String

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

String Parameter

String List

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

String List Parameter

Secure String

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

Secure String Parameter

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.

System Parameter

Multi-Tenancy Operations:

You can create a parameter within a tenant that you can access. Also, when multi tenancy is enabled, you 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

You must select the tenant under which you want to create the parameter. You will see the list of tenants you can access. 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.

Create Parameter in Tenant

View Parameter in Tenant

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

View Parameter in Tenant