Skip to content

ParameterDefinition

Source code in docs_src/capo_iam/types/parameter_definition.py
class ParameterDefinition(TypedDict, closed=True):
    name: "capo_iam.types.parameter_name_type.parameterNameType"
    """<p>The name of the parameter.</p>"""
    type: "capo_iam.types.parameter_type_type.parameterTypeType"
    """<p>The data type of the parameter. Valid values are <code>String</code>, <code>StringList</code>, <code>Number</code>, <code>NumberList</code>, <code>Arn</code>, and <code>ArnList</code>.</p>"""
    sub_type: NotRequired["capo_iam.types.parameter_sub_type_type.parameterSubTypeType"]
    """<p>An optional subtype that further constrains the values that are allowed for the parameter.</p>"""
    description: NotRequired[
        "capo_iam.types.parameter_description_type.parameterDescriptionType"
    ]
    """<p>A description of the parameter.</p>"""
    is_required: "capo_iam.types.boolean_type.booleanType"
    """<p>Specifies whether you must supply a value for the parameter when you create a role from the template.</p>"""
    default_value: NotRequired[
        "capo_iam.types.parameter_default_value_type.parameterDefaultValueType"
    ]
    """<p>The value that the service uses for the parameter when you do not supply one.</p>"""
    immutable: "capo_iam.types.boolean_type.booleanType"
    """<p>Specifies whether you can change the parameter value after you create the role.</p>"""

default_value instance-attribute

default_value: NotRequired[parameterDefaultValueType]

The value that the service uses for the parameter when you do not supply one.

description instance-attribute

description: NotRequired[parameterDescriptionType]

A description of the parameter.

immutable instance-attribute

immutable: booleanType

Specifies whether you can change the parameter value after you create the role.

is_required instance-attribute

is_required: booleanType

Specifies whether you must supply a value for the parameter when you create a role from the template.

name instance-attribute

The name of the parameter.

sub_type instance-attribute

sub_type: NotRequired[parameterSubTypeType]

An optional subtype that further constrains the values that are allowed for the parameter.

type instance-attribute

The data type of the parameter. Valid values are String, StringList, Number, NumberList, Arn, and ArnList.