Skip to content

OptionGroupOption

Source code in docs_src/capo_rds/types/option_group_option.py
class OptionGroupOption(TypedDict, closed=True):
    name: NotRequired["capo_rds.types.string.String"]
    """<p>The name of the option.</p>"""
    description: NotRequired["capo_rds.types.string.String"]
    """<p>The description of the option.</p>"""
    engine_name: NotRequired["capo_rds.types.string.String"]
    """<p>The name of the engine that this option can be applied to.</p>"""
    major_engine_version: NotRequired["capo_rds.types.string.String"]
    """<p>Indicates the major engine version that the option is available for.</p>"""
    minimum_required_minor_engine_version: NotRequired["capo_rds.types.string.String"]
    """<p>The minimum required engine version for the option to be applied.</p>"""
    port_required: NotRequired["capo_rds.types.boolean.Boolean"]
    """<p>Indicates whether the option requires a port.</p>"""
    default_port: NotRequired["capo_rds.types.integer_optional.IntegerOptional"]
    """<p>If the option requires a port, specifies the default port for the option.</p>"""
    options_depended_on: NotRequired[
        "capo_rds.types.options_depended_on.OptionsDependedOn"
    ]
    """<p>The options that are prerequisites for this option.</p>"""
    options_conflicts_with: NotRequired[
        "capo_rds.types.options_conflicts_with.OptionsConflictsWith"
    ]
    """<p>The options that conflict with this option.</p>"""
    persistent: NotRequired["capo_rds.types.boolean.Boolean"]
    """<p>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.</p>"""
    permanent: NotRequired["capo_rds.types.boolean.Boolean"]
    """<p>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.</p>"""
    requires_auto_minor_engine_version_upgrade: NotRequired[
        "capo_rds.types.boolean.Boolean"
    ]
    """<p>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.</p>"""
    vpc_only: NotRequired["capo_rds.types.boolean.Boolean"]
    """<p>If true, you can only use this option with a DB instance that is in a VPC.</p>"""
    supports_option_version_downgrade: NotRequired[
        "capo_rds.types.boolean_optional.BooleanOptional"
    ]
    """<p>If true, you can change the option to an earlier version of the option. This only applies to options that have different versions available.</p>"""
    option_group_option_settings: NotRequired[
        "capo_rds.types.option_group_option_settings_list.OptionGroupOptionSettingsList"
    ]
    """<p>The option settings that are available (and the default value) for each option in an option group.</p>"""
    option_group_option_versions: NotRequired[
        "capo_rds.types.option_group_option_versions_list.OptionGroupOptionVersionsList"
    ]
    """<p>The versions that are available for the option.</p>"""
    copyable_cross_account: NotRequired[
        "capo_rds.types.boolean_optional.BooleanOptional"
    ]
    """<p>Indicates whether the option can be copied across Amazon Web Services accounts.</p>"""

copyable_cross_account instance-attribute

copyable_cross_account: NotRequired[BooleanOptional]

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

default_port instance-attribute

default_port: NotRequired[IntegerOptional]

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

description instance-attribute

description: NotRequired[String]

The description of the option.

engine_name instance-attribute

engine_name: NotRequired[String]

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

major_engine_version instance-attribute

major_engine_version: NotRequired[String]

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

minimum_required_minor_engine_version instance-attribute

minimum_required_minor_engine_version: NotRequired[String]

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

name instance-attribute

name: NotRequired[String]

The name of the option.

option_group_option_settings instance-attribute

option_group_option_settings: NotRequired[OptionGroupOptionSettingsList]

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

option_group_option_versions instance-attribute

option_group_option_versions: NotRequired[OptionGroupOptionVersionsList]

The versions that are available for the option.

options_conflicts_with instance-attribute

options_conflicts_with: NotRequired[OptionsConflictsWith]

The options that conflict with this option.

options_depended_on instance-attribute

options_depended_on: NotRequired[OptionsDependedOn]

The options that are prerequisites for this option.

permanent instance-attribute

permanent: NotRequired[Boolean]

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 instance-attribute

persistent: NotRequired[Boolean]

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 instance-attribute

port_required: NotRequired[Boolean]

Indicates whether the option requires a port.

requires_auto_minor_engine_version_upgrade instance-attribute

requires_auto_minor_engine_version_upgrade: NotRequired[Boolean]

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 instance-attribute

supports_option_version_downgrade: NotRequired[BooleanOptional]

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 instance-attribute

vpc_only: NotRequired[Boolean]

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