Skip to content

RDS  >  Operations  >  modify_option_group

modify_option_group

Operation

modify_option_group async 

modify_option_group(input: ModifyOptionGroupInput, plugins: list[Plugin] | None = None) -> ModifyOptionGroupOutput

Modifies an existing option group.

Parameters:

Name Type Description Default
input ModifyOptionGroupInput

An instance of ModifyOptionGroupInput.

 required
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

Returns:

Type Description
ModifyOptionGroupOutput

An instance of ModifyOptionGroupOutput.

Input

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.

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

Options in this list are removed from the option group.

Output

ModifyOptionGroupOutput dataclass

Bases: _SerdeShape

Dataclass for ModifyOptionGroupOutput structure.

Attributes

option_group class-attribute instance-attribute 
option_group: OptionGroup | None = ...
response_metadata class-attribute instance-attribute 
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.