modify_option_group¶
Operation¶
modify_option_group
¶
modify_option_group(request: ModifyOptionGroupInput | ModifyOptionGroupInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[ModifyOptionGroupInputDict]) -> ModifyOptionGroupOutput
Modifies an existing option group.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
ModifyOptionGroupInput | ModifyOptionGroupInputDict | None
|
The input as a model or dictionary. Pass this or keyword arguments, not both. |
None
|
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
**kwargs
|
Unpack[ModifyOptionGroupInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
ModifyOptionGroupOutput
|
An instance of |
modify_option_group
async
¶
modify_option_group(request: ModifyOptionGroupInput | ModifyOptionGroupInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[ModifyOptionGroupInputDict]) -> ModifyOptionGroupOutput
Modifies an existing option group.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
ModifyOptionGroupInput | ModifyOptionGroupInputDict | None
|
The input as a model or dictionary. Pass this or keyword arguments, not both. |
None
|
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
**kwargs
|
Unpack[ModifyOptionGroupInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
ModifyOptionGroupOutput
|
An instance of |
Input¶
Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.
ModifyOptionGroupInputDict
¶
Bases: TypedDict
Dictionary form of ModifyOptionGroupInput.
Attributes¶
apply_immediately
instance-attribute
¶
apply_immediately: bool | None
Specifies whether to apply the change immediately or during the next maintenance window for each instance associated with the option group.
option_group_name
instance-attribute
¶
The name of the option group to be modified.
Permanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed from an option group, and that option group can't be removed from a DB instance once it is associated with a DB instance
options_to_include
instance-attribute
¶
options_to_include: Sequence[OptionConfiguration | OptionConfigurationDict] | None
Options in this list are added to the option group or, if already present, the specified configuration is used to update the existing configuration.
ModifyOptionGroupInput
dataclass
¶
Bases: _SerdeShape
Attributes¶
apply_immediately
class-attribute
instance-attribute
¶
apply_immediately: bool | None = ...
Specifies whether to apply the change immediately or during the next maintenance window for each instance associated with the option group.
option_group_name
class-attribute
instance-attribute
¶
option_group_name: str | None = ...
The name of the option group to be modified.
Permanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed from an option group, and that option group can't be removed from a DB instance once it is associated with a DB instance
options_to_include
class-attribute
instance-attribute
¶
options_to_include: list[OptionConfiguration] | None = ...
Options in this list are added to the option group or, if already present, the specified configuration is used to update the existing configuration.
Output¶
ModifyOptionGroupOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for ModifyOptionGroupOutput structure.