The parameters and outputs of an infrastructure template correspond to those in the underlying ROS and Terraform templates. ROS Infrastructure Composer provides a form-based interface to view, add, edit, and delete them.
Prerequisites
Ensure that you have created an infrastructure template. For more information, see Create an infrastructure template.
Manage architecture template parameters
Go to the ROS Infrastructure Composer module in the ROS console.
In the left-side navigation pane, click Infrastructure Templates.
On the Infrastructure Templates page, find the desired infrastructure template and click the card.
-
In the upper-right corner, click Templates and then click the Parameter tab. On this tab, you can:
-
View parameters: The current page lists all defined template parameters.
-
Add Parameter: Click Add Parameter. The Parameter Configurations pane slides out from the right. You can define a parameter by using the form, or with JSON or YAML.
-
Delete a parameter: Move the pointer over the parameter and click the
icon.
Parameter
Description
Parameter Name
The name of the parameter. The name can contain letters, digits, hyphens (-), and underscores (_). It cannot contain spaces and must be unique within the template.
Parameter Type
The data type of the parameter. Valid values:
-
String: corresponds toStringin the template syntax. -
Number: corresponds toNumberin the template syntax. -
Boolean: corresponds toBooleanin the template syntax. -
Object: corresponds toJsonin the template syntax. -
Array: corresponds toCommaDelimitedListin the template syntax.
For more information, see
Typein Overview.Business Components
A business component used to dynamically select parameter configurations in the console. This configuration corresponds to
AssociationPropertyandAssociationPropertyMetadatain the template syntax.For more information, see AssociationProperty and AssociationPropertyMetadata.
Default value
When creating a stack, if you omit a parameter value, ROS uses the default value from the template. If no default value is defined, ROS returns an error. This configuration corresponds to
Defaultin the template syntax.For more information, see
Defaultin Overview.Parameter Label
An alias for the parameter. This configuration corresponds to
Labelin the template syntax.For more information, see
Labelin Overview.Parameter Description
The description of the parameter. This configuration corresponds to
Descriptionin the template syntax.For more information, see
Descriptionin Overview.Optional Parameters
A list of allowed values for the parameter. This configuration corresponds to
AllowedValuesin the template syntax.For more information, see
AllowedValuesin Overview.Maximum Length
An integer that specifies the maximum length for a
Stringparameter value. This configuration corresponds toMaxLengthin the template syntax.For more information, see
MaxLengthin Overview.Minimum Length
An integer that specifies the minimum length for a
Stringparameter value. This configuration corresponds toMinLengthin the template syntax.For more information, see
MinLengthin Overview.Whether to Use as Password Component
If you select this option, the parameter value is treated as sensitive information, and the console masks the value with asterisks (*). This configuration corresponds to
NoEchoin the template syntax.For more information, see
NoEchoin Overview.Whether to Enable Duplicate Verification
If you select this option, the console requires you to enter the parameter value a second time for confirmation. This option is disabled by default. This configuration corresponds to
Confirmin the template syntax.For more information, see
Confirmin Overview.NoteThis configuration appears only when you select the Whether to Use as Password Component option.
Whether to Support Line Breaks
If you select this option, the console displays the parameter in a multi-line text box. This configuration corresponds to
TextAreain the template syntax.For more information, see
TextAreain Overview.Regular Expression for Text Verification
A regular expression used to validate the parameter value. The value must be a String that matches the pattern, or ROS returns an error. This configuration corresponds to
AllowedPatternin the template syntax.If you use the following special characters, you must escape each character by prefixing it with two backslashes (\\):
*.?+-$^[ ]( ){ }|\/NoteA hyphen (-) does not need to be escaped if it is at the beginning or end of a character set, such as
[a-z-].For more information, see
AllowedPatternin Overview.Prompt After Text Verification Failure
The message displayed if the parameter value fails to match the regular expression. This configuration corresponds to
ConstraintDescriptionin the template syntax.For more information, see
ConstraintDescriptionin Overview. -
Manage architecture template outputs
Go to the ROS Infrastructure Composer module in the ROS console.
In the left-side navigation pane, click Infrastructure Templates.
On the Infrastructure Templates page, find the desired infrastructure template and click the card.
-
In the upper-right corner, click Templates and then click the Output tab. On this tab, you can:
-
View outputs: The current page lists all defined template outputs.
-
Add Output: Click Add Output. The Output Settings pane slides out from the right. You can define an output by using the form or by using JSON or YAML.
Parameter
Description
Name
The name of the output. The name can contain letters, digits, hyphens (-), and underscores (_). It cannot contain spaces and must be unique within the template.
Output Values
The resource attribute from which to retrieve the output value.
-
The first drop-down list specifies the resource in the template.
-
The second drop-down list specifies an output attribute of the resource.
Condition
A condition that controls whether this output is created. ROS creates the output only if the condition evaluates to true. Without a condition, the output is always created. This configuration corresponds to
Conditionin the template syntax.For more information, see
Conditionin Outputs.Label
An alias for the output. This configuration corresponds to
Labelin the template syntax.For more information, see
Labelin Outputs.Description
The description of the output. This configuration corresponds to
Descriptionin the template syntax.For more information, see
Descriptionin Outputs. -