Skip to content

DatabaseConnectionStringProfile

Source code in docs_src/capo_odb/types/database_connection_string_profile.py
class DatabaseConnectionStringProfile(TypedDict, closed=True):
    consumer_group: NotRequired["str"]
    """<p>The consumer group associated with the connection string profile.</p>"""
    display_name: NotRequired["str"]
    """<p>The user-friendly name of the connection string profile.</p>"""
    host_format: NotRequired["str"]
    """<p>The host name format used in the connection string.</p>"""
    is_regional: NotRequired["bool"]
    """<p>Indicates whether the connection string profile is regional.</p>"""
    protocol: NotRequired["str"]
    """<p>The protocol used by the connection string profile.</p>"""
    session_mode: NotRequired["str"]
    """<p>The session mode of the connection string profile.</p>"""
    syntax_format: NotRequired["str"]
    """<p>The syntax format of the connection string profile.</p>"""
    tls_authentication: NotRequired["str"]
    """<p>The TLS authentication method used by the connection string profile.</p>"""
    value: NotRequired["str"]
    """<p>The connection string value of the profile.</p>"""

consumer_group instance-attribute

consumer_group: NotRequired[str]

The consumer group associated with the connection string profile.

display_name instance-attribute

display_name: NotRequired[str]

The user-friendly name of the connection string profile.

host_format instance-attribute

host_format: NotRequired[str]

The host name format used in the connection string.

is_regional instance-attribute

is_regional: NotRequired[bool]

Indicates whether the connection string profile is regional.

protocol instance-attribute

protocol: NotRequired[str]

The protocol used by the connection string profile.

session_mode instance-attribute

session_mode: NotRequired[str]

The session mode of the connection string profile.

syntax_format instance-attribute

syntax_format: NotRequired[str]

The syntax format of the connection string profile.

tls_authentication instance-attribute

tls_authentication: NotRequired[str]

The TLS authentication method used by the connection string profile.

value instance-attribute

value: NotRequired[str]

The connection string value of the profile.