Documentation

Available option.

See: newOptionGroupOption smart constructor.

Create a value of OptionGroupOption with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:copyableCrossAccount:OptionGroupOption', optionGroupOption_copyableCrossAccount - Specifies whether the option can be copied across Amazon Web Services accounts.

$sel:defaultPort:OptionGroupOption', optionGroupOption_defaultPort - If the option requires a port, specifies the default port for the option.

$sel:description:OptionGroupOption', optionGroupOption_description - The description of the option.

$sel:engineName:OptionGroupOption', optionGroupOption_engineName - The name of the engine that this option can be applied to.

$sel:majorEngineVersion:OptionGroupOption', optionGroupOption_majorEngineVersion - Indicates the major engine version that the option is available for.

$sel:minimumRequiredMinorEngineVersion:OptionGroupOption', optionGroupOption_minimumRequiredMinorEngineVersion - The minimum required engine version for the option to be applied.

$sel:name:OptionGroupOption', optionGroupOption_name - The name of the option.

$sel:optionGroupOptionSettings:OptionGroupOption', optionGroupOption_optionGroupOptionSettings - The option settings that are available (and the default value) for each option in an option group.

$sel:optionGroupOptionVersions:OptionGroupOption', optionGroupOption_optionGroupOptionVersions - The versions that are available for the option.

$sel:optionsConflictsWith:OptionGroupOption', optionGroupOption_optionsConflictsWith - The options that conflict with this option.

$sel:optionsDependedOn:OptionGroupOption', optionGroupOption_optionsDependedOn - The options that are prerequisites for this option.

$sel:permanent:OptionGroupOption', optionGroupOption_permanent - 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.

$sel:persistent:OptionGroupOption', optionGroupOption_persistent - 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.

$sel:portRequired:OptionGroupOption', optionGroupOption_portRequired - Specifies whether the option requires a port.

$sel:requiresAutoMinorEngineVersionUpgrade:OptionGroupOption', optionGroupOption_requiresAutoMinorEngineVersionUpgrade - 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.

$sel:supportsOptionVersionDowngrade:OptionGroupOption', optionGroupOption_supportsOptionVersionDowngrade - If true, you can change the option to an earlier version of the option. This only applies to options that have different versions available.

$sel:vpcOnly:OptionGroupOption', optionGroupOption_vpcOnly - If true, you can only use this option with a DB instance that is in a VPC.

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

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

The description of the option.

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

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

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

The name of the option.

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

The versions that are available for the option.

The options that conflict with this option.

The options that are prerequisites for this option.

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 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.

Specifies whether the option requires a port.

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.

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

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