Skip to content

ComponentParameterDetail

Source code in docs_src/capo_imagebuilder/types/component_parameter_detail.py
class ComponentParameterDetail(TypedDict, closed=True):
    name: "capo_imagebuilder.types.component_parameter_name.ComponentParameterName"
    """<p>The name of this input parameter.</p>"""
    type: "capo_imagebuilder.types.component_parameter_type.ComponentParameterType"
    """<p>The type of input this parameter provides. The currently supported value is "string".</p>"""
    default_value: NotRequired[
        "capo_imagebuilder.types.component_parameter_value_list.ComponentParameterValueList"
    ]
    """<p>The default value of this parameter if no input is provided.</p>"""
    description: NotRequired[
        "capo_imagebuilder.types.component_parameter_description.ComponentParameterDescription"
    ]
    """<p>Describes this parameter.</p>"""

default_value instance-attribute

default_value: NotRequired[ComponentParameterValueList]

The default value of this parameter if no input is provided.

description instance-attribute

description: NotRequired[ComponentParameterDescription]

Describes this parameter.

name instance-attribute

The name of this input parameter.

type instance-attribute

The type of input this parameter provides. The currently supported value is "string".