Skip to content

SdkConfigurationProperty

Source code in docs_src/capo_api_gateway/types/sdk_configuration_property.py
class SdkConfigurationProperty(TypedDict, closed=True):
    name: NotRequired["capo_api_gateway.types.string.String"]
    """<p>The name of a an SdkType configuration property.</p>"""
    friendly_name: NotRequired["capo_api_gateway.types.string.String"]
    """<p>The user-friendly name of an SdkType configuration property.</p>"""
    description: NotRequired["capo_api_gateway.types.string.String"]
    """<p>The description of an SdkType configuration property.</p>"""
    required: "capo_api_gateway.types.boolean.Boolean"
    """<p>A boolean flag of an SdkType configuration property to indicate if the associated SDK configuration property is required (<code>true</code>) or not (<code>false</code>).</p>"""
    default_value: NotRequired["capo_api_gateway.types.string.String"]
    """<p>The default value of an SdkType configuration property.</p>"""

default_value instance-attribute

default_value: NotRequired[String]

The default value of an SdkType configuration property.

description instance-attribute

description: NotRequired[String]

The description of an SdkType configuration property.

friendly_name instance-attribute

friendly_name: NotRequired[String]

The user-friendly name of an SdkType configuration property.

name instance-attribute

name: NotRequired[String]

The name of a an SdkType configuration property.

required instance-attribute

required: Boolean

A boolean flag of an SdkType configuration property to indicate if the associated SDK configuration property is required (true) or not (false).