Skip to content

OptionSetting

Source code in docs_src/capo_rds/types/option_setting.py
class OptionSetting(TypedDict, closed=True):
    name: NotRequired["capo_rds.types.string.String"]
    """<p>The name of the option that has settings that you can set.</p>"""
    value: NotRequired[
        "capo_rds.types.potentially_sensitive_option_setting_value.PotentiallySensitiveOptionSettingValue"
    ]
    """<p>The current value of the option setting.</p>"""
    default_value: NotRequired["capo_rds.types.string.String"]
    """<p>The default value of the option setting.</p>"""
    description: NotRequired["capo_rds.types.string.String"]
    """<p>The description of the option setting.</p>"""
    apply_type: NotRequired["capo_rds.types.string.String"]
    """<p>The DB engine specific parameter type.</p>"""
    data_type: NotRequired["capo_rds.types.string.String"]
    """<p>The data type of the option setting.</p>"""
    allowed_values: NotRequired["capo_rds.types.string.String"]
    """<p>The allowed values of the option setting.</p>"""
    is_modifiable: NotRequired["capo_rds.types.boolean.Boolean"]
    """<p>Indicates whether the option setting can be modified from the default.</p>"""
    is_collection: NotRequired["capo_rds.types.boolean.Boolean"]
    """<p>Indicates whether the option setting is part of a collection.</p>"""

allowed_values instance-attribute

allowed_values: NotRequired[String]

The allowed values of the option setting.

apply_type instance-attribute

apply_type: NotRequired[String]

The DB engine specific parameter type.

data_type instance-attribute

data_type: NotRequired[String]

The data type of the option setting.

default_value instance-attribute

default_value: NotRequired[String]

The default value of the option setting.

description instance-attribute

description: NotRequired[String]

The description of the option setting.

is_collection instance-attribute

is_collection: NotRequired[Boolean]

Indicates whether the option setting is part of a collection.

is_modifiable instance-attribute

is_modifiable: NotRequired[Boolean]

Indicates whether the option setting can be modified from the default.

name instance-attribute

name: NotRequired[String]

The name of the option that has settings that you can set.

value instance-attribute

The current value of the option setting.