Skip to content

RDS  >  Structures  >  OptionGroupOption

OptionGroupOption

Structure Class

OptionGroupOption dataclass

Bases: _SerdeShape

Available option.

Attributes

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

Indicates whether the option can be copied across Amazon Web Services accounts.

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

Indicates whether the option can be copied across Amazon Web Services Regions.

default_port class-attribute instance-attribute 
default_port: int | None = ...

If the option requires a port, specifies the default port for the option.

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

The description of the option.

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

The name of the engine that this option can be applied to.

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

Indicates the major engine version that the option is available for.

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

The minimum required engine version for the option to be applied.

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

The name of the option.

option_group_option_settings class-attribute instance-attribute 
option_group_option_settings: list[OptionGroupOptionSetting] | None = ...

The option settings that are available (and the default value) for each option in an option group.

option_group_option_versions class-attribute instance-attribute 
option_group_option_versions: list[OptionVersion] | None = ...

The versions that are available for the option.

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

The options that conflict with this option.

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

The options that are prerequisites for this option.

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

Permanent options can never be removed from an option group. An option group containing a permanent option can't be removed from a DB instance.

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

Persistent options can't be removed from an option group while DB instances are associated with the option group. If you disassociate all DB instances from the option group, your can remove the persistent option from the option group.

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

Indicates whether the option requires a port.

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

If true, you must enable the Auto Minor Version Upgrade setting for your DB instance before you can use this option. You can enable Auto Minor Version Upgrade when you first create your DB instance, or by modifying your DB instance later.

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

If true, you can change the option to an earlier version of the option. This only applies to options that have different versions available.

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

If true, you can only use this option with a DB instance that is in a VPC.