Skip to content

RDS  >  Structures  >  Parameter

Parameter

Structure Class

Parameter dataclass

Bases: _SerdeShape

This data type is used as a request parameter in the ModifyDBParameterGroup and ResetDBParameterGroup actions.

This data type is used as a response element in the DescribeEngineDefaultParameters and DescribeDBParameters actions.

Attributes

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

Specifies the valid range of values for the parameter.

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

Indicates when to apply parameter updates.

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

Specifies the engine specific parameters type.

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

Specifies the valid data type for the parameter.

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

Provides a description of the parameter.

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

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 class-attribute instance-attribute 
minimum_engine_version: str | None = ...

The earliest engine version to which the parameter can apply.

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

The name of the parameter.

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

The value of the parameter.

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

The source of the parameter value.

supported_engine_modes class-attribute instance-attribute 
supported_engine_modes: list[str] | None = ...

The valid DB engine modes.