Skip to content

RDS  >  Structures  >  OptionSetting

OptionSetting

Structure Class

OptionSetting dataclass

Bases: _SerdeShape

Option settings are the actual settings being applied or configured for that option. It is used when you modify an option group or describe option groups. For example, the NATIVE_NETWORK_ENCRYPTION option has a setting called SQLNET.ENCRYPTION_SERVER that can have several different values.

Attributes

allowed_values class-attribute instance-attribute
allowed_values: str | None = ...

The allowed values of the option setting.

apply_type class-attribute instance-attribute
apply_type: str | None = ...

The DB engine specific parameter type.

data_type class-attribute instance-attribute
data_type: str | None = ...

The data type of the option setting.

default_value class-attribute instance-attribute
default_value: str | None = ...

The default value of the option setting.

description class-attribute instance-attribute
description: str | None = ...

The description of the option setting.

is_collection class-attribute instance-attribute
is_collection: bool | None = ...

Indicates whether the option setting is part of a collection.

is_modifiable class-attribute instance-attribute
is_modifiable: bool | None = ...

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

name class-attribute instance-attribute
name: str | None = ...

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

value class-attribute instance-attribute
value: str | None = ...

The current value of the option setting.