Skip to content

Parameter

Source code in docs_src/capo_rds/types/parameter.py 
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
class Parameter(TypedDict, closed=True):
    parameter_name: NotRequired["capo_rds.types.string.String"]
    """<p>The name of the parameter.</p>"""
    parameter_value: NotRequired[
        "capo_rds.types.potentially_sensitive_parameter_value.PotentiallySensitiveParameterValue"
    ]
    """<p>The value of the parameter.</p>"""
    description: NotRequired["capo_rds.types.string.String"]
    """<p>Provides a description of the parameter.</p>"""
    source: NotRequired["capo_rds.types.string.String"]
    """<p>The source of the parameter value.</p>"""
    apply_type: NotRequired["capo_rds.types.string.String"]
    """<p>Specifies the engine specific parameters type.</p>"""
    data_type: NotRequired["capo_rds.types.string.String"]
    """<p>Specifies the valid data type for the parameter.</p>"""
    allowed_values: NotRequired["capo_rds.types.string.String"]
    """<p>Specifies the valid range of values for the parameter.</p>"""
    is_modifiable: NotRequired["capo_rds.types.boolean.Boolean"]
    """<p>Indicates whether (<code>true</code>) or not (<code>false</code>) the parameter can be modified. Some parameters have security or operational implications that prevent them from being changed.</p>"""
    minimum_engine_version: NotRequired["capo_rds.types.string.String"]
    """<p>The earliest engine version to which the parameter can apply.</p>"""
    apply_method: NotRequired["capo_rds.types.apply_method.ApplyMethod"]
    """<p>Indicates when to apply parameter updates.</p>"""
    supported_engine_modes: NotRequired[
        "capo_rds.types.engine_mode_list.EngineModeList"
    ]
    """<p>The valid DB engine modes.</p>"""

allowed_values instance-attribute 

allowed_values: NotRequired[String]

Specifies the valid range of values for the parameter.

apply_method instance-attribute 

apply_method: NotRequired[ApplyMethod]

Indicates when to apply parameter updates.

apply_type instance-attribute 

apply_type: NotRequired[String]

Specifies the engine specific parameters type.

data_type instance-attribute 

data_type: NotRequired[String]

Specifies the valid data type for the parameter.

description instance-attribute 

description: NotRequired[String]

Provides a description of the parameter.

is_modifiable instance-attribute 

is_modifiable: NotRequired[Boolean]

Indicates whether (true) or not (false) the parameter can be modified. Some parameters have security or operational implications that prevent them from being changed.

minimum_engine_version instance-attribute 

minimum_engine_version: NotRequired[String]

The earliest engine version to which the parameter can apply.

parameter_name instance-attribute 

parameter_name: NotRequired[String]

The name of the parameter.

parameter_value instance-attribute 

parameter_value: NotRequired[PotentiallySensitiveParameterValue]

The value of the parameter.

source instance-attribute 

source: NotRequired[String]

The source of the parameter value.

supported_engine_modes instance-attribute 

supported_engine_modes: NotRequired[EngineModeList]

The valid DB engine modes.