Skip to content

ControlParameter

Source code in docs_src/capo_controlcatalog/types/control_parameter.py 
13
14
15
16
17
18
19
class ControlParameter(TypedDict, closed=True):
    name: "str"
    """<p>The parameter name. This name is the parameter <code>key</code> when you call <a href="https://docs.aws.amazon.com/controltower/latest/APIReference/API_EnableControl.html"> <code>EnableControl</code> </a> or <a href="https://docs.aws.amazon.com/controltower/latest/APIReference/API_UpdateEnabledControl.html"> <code>UpdateEnabledControl</code> </a>.</p>"""
    requirement: NotRequired[
        "capo_controlcatalog.types.control_parameter_requirement.ControlParameterRequirement"
    ]
    """<p>Indicates whether the parameter is required or optional when you enable the control.</p>"""

name instance-attribute 

name: str

The parameter name. This name is the parameter key when you call EnableControl or UpdateEnabledControl .

requirement instance-attribute 

requirement: NotRequired[ControlParameterRequirement]

Indicates whether the parameter is required or optional when you enable the control.