Skip to content

OptionGroup

Source code in docs_src/capo_rds/types/option_group.py
class OptionGroup(TypedDict, closed=True):
    option_group_name: NotRequired["capo_rds.types.string.String"]
    """<p>Specifies the name of the option group.</p>"""
    option_group_description: NotRequired["capo_rds.types.string.String"]
    """<p>Provides a description of the option group.</p>"""
    engine_name: NotRequired["capo_rds.types.string.String"]
    """<p>Indicates the name of the engine that this option group can be applied to.</p>"""
    major_engine_version: NotRequired["capo_rds.types.string.String"]
    """<p>Indicates the major engine version associated with this option group.</p>"""
    options: NotRequired["capo_rds.types.options_list.OptionsList"]
    """<p>Indicates what options are available in the option group.</p>"""
    allows_vpc_and_non_vpc_instance_memberships: NotRequired[
        "capo_rds.types.boolean.Boolean"
    ]
    """<p>Indicates whether this option group can be applied to both VPC and non-VPC instances. The value <code>true</code> indicates the option group can be applied to both VPC and non-VPC instances.</p>"""
    vpc_id: NotRequired["capo_rds.types.string.String"]
    """<p>If <b>AllowsVpcAndNonVpcInstanceMemberships</b> is <code>false</code>, this field is blank. If <b>AllowsVpcAndNonVpcInstanceMemberships</b> is <code>true</code> and this field is blank, then this option group can be applied to both VPC and non-VPC instances. If this field contains a value, then this option group can only be applied to instances that are in the VPC indicated by this field.</p>"""
    option_group_arn: NotRequired["capo_rds.types.string.String"]
    """<p>Specifies the Amazon Resource Name (ARN) for the option group.</p>"""
    source_option_group: NotRequired["capo_rds.types.string.String"]
    """<p>Specifies the name of the option group from which this option group is copied.</p>"""
    source_account_id: NotRequired["capo_rds.types.string.String"]
    """<p>Specifies the Amazon Web Services account ID for the option group from which this option group is copied.</p>"""
    copy_timestamp: NotRequired["capo_rds.types.t_stamp.TStamp"]
    """<p>Indicates when the option group was copied.</p>"""

allows_vpc_and_non_vpc_instance_memberships instance-attribute

allows_vpc_and_non_vpc_instance_memberships: NotRequired[Boolean]

Indicates whether this option group can be applied to both VPC and non-VPC instances. The value true indicates the option group can be applied to both VPC and non-VPC instances.

copy_timestamp instance-attribute

copy_timestamp: NotRequired[TStamp]

Indicates when the option group was copied.

engine_name instance-attribute

engine_name: NotRequired[String]

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

major_engine_version instance-attribute

major_engine_version: NotRequired[String]

Indicates the major engine version associated with this option group.

option_group_arn instance-attribute

option_group_arn: NotRequired[String]

Specifies the Amazon Resource Name (ARN) for the option group.

option_group_description instance-attribute

option_group_description: NotRequired[String]

Provides a description of the option group.

option_group_name instance-attribute

option_group_name: NotRequired[String]

Specifies the name of the option group.

options instance-attribute

options: NotRequired[OptionsList]

Indicates what options are available in the option group.

source_account_id instance-attribute

source_account_id: NotRequired[String]

Specifies the Amazon Web Services account ID for the option group from which this option group is copied.

source_option_group instance-attribute

source_option_group: NotRequired[String]

Specifies the name of the option group from which this option group is copied.

vpc_id instance-attribute

vpc_id: NotRequired[String]

If AllowsVpcAndNonVpcInstanceMemberships is false, this field is blank. If AllowsVpcAndNonVpcInstanceMemberships is true and this field is blank, then this option group can be applied to both VPC and non-VPC instances. If this field contains a value, then this option group can only be applied to instances that are in the VPC indicated by this field.