Parameter ¶

class Parameter(TypedDict, closed=True):
    parameter_name: NotRequired["capo_dax.types.string.String"]
    """<p>The name of the parameter.</p>"""
    parameter_type: NotRequired["capo_dax.types.parameter_type.ParameterType"]
    """<p>Determines whether the parameter can be applied to any nodes, or only nodes of a particular type.</p>"""
    parameter_value: NotRequired["capo_dax.types.string.String"]
    """<p>The value for the parameter.</p>"""
    node_type_specific_values: NotRequired[
        "capo_dax.types.node_type_specific_value_list.NodeTypeSpecificValueList"
    ]
    """<p>A list of node types, and specific parameter values for each node.</p>"""
    description: NotRequired["capo_dax.types.string.String"]
    """<p>A description of the parameter</p>"""
    source: NotRequired["capo_dax.types.string.String"]
    """<p>How the parameter is defined. For example, <code>system</code> denotes a system-defined parameter.</p>"""
    data_type: NotRequired["capo_dax.types.string.String"]
    """<p>The data type of the parameter. For example, <code>integer</code>:</p>"""
    allowed_values: NotRequired["capo_dax.types.string.String"]
    """<p>A range of values within which the parameter can be set.</p>"""
    is_modifiable: NotRequired["capo_dax.types.is_modifiable.IsModifiable"]
    """<p>Whether the customer is allowed to modify the parameter.</p>"""
    change_type: NotRequired["capo_dax.types.change_type.ChangeType"]
    """<p>The conditions under which changes to this parameter can be applied. For example, <code>requires-reboot</code> indicates that a new value for this parameter will only take effect if a node is rebooted.</p>"""