Parameter Store Connection Parameters
To connect to the AWS Systems Manager Parameter Store, provide the configuration below at runtime.
| Property Name | Required | Data Type | Description |
|---|---|---|---|
| access_key_id | Yes | String | Access ID for your AWS account. To protect the access key, an encrypted value can be provided in this configuration. See
Encrypting Password Values section for information on how to encrypt a string.
Note: The encrypted value must be prefixed with SECRET: For example, This configuration is optional if
SECRET:b0UaK3bTyD9wN+ZJkmlKRmojhAv+use_iam_role is set to
true.
|
| secret_access_key | Yes | String | Secret access key for your AWS account. This account must have access to the Parameter Store. To protect the secret access key, an encrypted value can be provided in this configuration. See the
Encrypting Password Values section for information on how to encrypt a string.
Note: The encrypted value must be prefixed with SECRET: For example,
This configuration is optional if
SECRET:b0UaK3bTyD9wN+ZJkmlKRmojhAv+
use_iam_role is set to
true.
|
| region | Yes | String | Select a geographic area where your Parameter Store is located. This configuration is optional if
use_iam_role is set to
true and your Parameter Store is configured in the same region as the running service. When running in AWS services (for example, EC2, ECS, EKS), this configuration is optional if the Parameter Store is in the same region as these services.
|
| param_prefix | No | String | This is essentially the hierarchy that your app follows to get to the app property location in the Parameter Store. It is the prefix to be prepended to the lookup parameter. This is helpful in case the parameter hierarchy is not fixed and may change based on the environment during runtime.
This is also helpful in case you want to switch to a different configuration service such as the Consul KV store. As an example of aparam_prefix, if you have an app property (for example,
Message) that has two different values depending on the environment from which it is being accessed (for example, dev or test environment), your
param_prefix for the two values can be
/dev/<APPNAME/ and
/test/<APPNAME/. At run time, the right value for
Message are picked up depending on which param_prefix you specify in the
FLOGO_APP_PROPS_AWS environment variable. Hence, setting a param_prefix allows you to change the values of the app properties at runtime without modifying your app.
|
| use_iam_role | No | Boolean | Set to
true if the Flogo app is running in the AWS services (such as EC2, ECS, EKS) and you want to leverage IAM role (such as instance role or task role) to fetch parameters from the Parameter Store. In that case,
access_key_id and
secret_access_key are not required.
|