Creating new input and output parameters
From the Parameters tab, you can create new parameters for Input parameters and Output parameters.
Procedure
-
From the drop-down menu, select Provision action, Bind action, or a custom action.
Notes:
- Based on the selection, the parameters change in the Input parameters section, Activity parameters section, and Output parameters section.
- Bind action and custom actions appear in the drop-down list only if created in the Composition tab.
-
Click Create parameter to add a new input or output parameter. See Creating parameter.
- Click Add. The parameter is added to the appropriate input or output section. You can edit and delete an existing parameter from the overflow menu. You can also verify the parameters in the Source code tab.
Creating parameter
-
In the Create parameter page, enter the Parameter key.
Note: The naming convention for a parameter key is as follows:
- Alphanumeric, underscore, and hyphen
- Starts with a letter
-
Select End-user permission.
The three different types of permissions are as follows:
-
Invisible - During parameter creation, enter a value for the Value. This parameter is not visible while creating an instance of the service.
Note: For the Invisible parameter, if you enter incorrect data in the value field, then the Service instance deployment of the content run time fails.
-
Read-only - When you create a service instance, you cannot make changes to the value that was defined during creation. Enter or select the following values:
- Parameter type - Select a type. It determines the type of parameter. The available parameter types are string, password, list, boolean, counter, map, connection, and shared parameter.
- Display name - The label or display name of the parameter.
- Description - The description appears as a tooltip when you create the service instance.
- Value - The value of the parameter. When you create the service instance, this parameter is visible to you in read-only format.
- For the list type, you can click Add new to add values to the list.
- For the map type, you can click Add new to add Key Value pairs to the map. Click the cross icon to delete a pair.
- For password types, toggle between Show and Hide to view or hide the password characters.
-
Read-write - When you create a service instance, you can make changes to the value that was defined during creation. Enter or select the following values for Read-write permission:
-
Editable - If checked, this parameter can be edited while editing a service instance.
-
Parameter type - Select a type. It determines the type of parameter. The available parameter types are string, password, list, boolean, counter, map, connection, and shared parameter.
-
Value required - Determines whether a value is required for the parameter.
-
Specify options - For the string type, you can select this option to create a drop-down list of string values. It is not available for other data types.
-
Display name - The label or display name of the parameter.
-
Description - The description appears as a tooltip when you create the service instance.
-
Dynamic - Enables an input parameter to fetch possible values dynamically in real time depending on the selected values of the dependent parameters.
-
Pass by name - Check this if the name should be used instead of the value. If not checked, parameter value is used.
Note: Parameters of asset type
regions
should not be defined as pass by name. A region should always be passed by a value as per provider implementation. -
Source - A collection of dynamic input parameter implementations. Each source is associated with a cloud provider type.
For more information about supported providers, see Dynamic parameters supported providers
-
Asset type - Select the required asset type from this drop-down list. The asset type list is based on the selection of the Source.
-
Depends on - These input fields change based on the Asset type selection and should be linked to the appropriate input parameters.
Notes:
- Two plans with dynamic parameters are not supported yet. They are only supported with the one, standard plan only.
- Dynamic input parameters must be created sequentially as connection, region, vpc and a subnet.
-
Validation rule - The validation rule is an optional field that is available only if you select string or password in Parameter type drop-down list. A validation rule (regex) provides an ability to the service composer to restrict the values of an input parameter. If regex is provided during service composition, then the value of the string input parameter must satisfy the regex criteria during service deployment. For example, (\w+?@\w+?\x2E.+). This is not applicable if Dynamic is selected.
-
Validation rule description - A description that provides information about the validation rule. For example, "Enter a valid email address". Here, (\w+?@\w+?\x2E.+) is the regular expression for an email address. If you enter “abc.xyz.com” as the value for string input parameters, then service deployment fails due to an invalid email address. This is not applicable if Dynamic is selected.
Note: For more information about regex, see regexlib.com
.
-
Default value - Enter a default value. If you select, Specify options, then enter values for Label and Value pair fields. Select a record to mark it as default value. You can click the cross mark icon to delete a value record. This is not applicable if Dynamic is selected.
-
-