Skip to content

Option

Source code in docs_src/capo_rds/types/option.py
class Option(TypedDict, closed=True):
    option_name: NotRequired["capo_rds.types.string.String"]
    """<p>The name of the option.</p>"""
    option_description: NotRequired["capo_rds.types.string.String"]
    """<p>The description of the option.</p>"""
    persistent: NotRequired["capo_rds.types.boolean.Boolean"]
    """<p>Indicates whether this option is persistent.</p>"""
    permanent: NotRequired["capo_rds.types.boolean.Boolean"]
    """<p>Indicates whether this option is permanent.</p>"""
    port: NotRequired["capo_rds.types.integer_optional.IntegerOptional"]
    """<p>If required, the port configured for this option to use.</p>"""
    option_version: NotRequired["capo_rds.types.string.String"]
    """<p>The version of the option.</p>"""
    option_settings: NotRequired[
        "capo_rds.types.option_setting_configuration_list.OptionSettingConfigurationList"
    ]
    """<p>The option settings for this option.</p>"""
    db_security_group_memberships: NotRequired[
        "capo_rds.types.db_security_group_membership_list.DBSecurityGroupMembershipList"
    ]
    """<p>If the option requires access to a port, then this DB security group allows access to the port.</p>"""
    vpc_security_group_memberships: NotRequired[
        "capo_rds.types.vpc_security_group_membership_list.VpcSecurityGroupMembershipList"
    ]
    """<p>If the option requires access to a port, then this VPC security group allows access to the port.</p>"""

db_security_group_memberships instance-attribute

db_security_group_memberships: NotRequired[DBSecurityGroupMembershipList]

If the option requires access to a port, then this DB security group allows access to the port.

option_description instance-attribute

option_description: NotRequired[String]

The description of the option.

option_name instance-attribute

option_name: NotRequired[String]

The name of the option.

option_settings instance-attribute

option_settings: NotRequired[OptionSettingConfigurationList]

The option settings for this option.

option_version instance-attribute

option_version: NotRequired[String]

The version of the option.

permanent instance-attribute

permanent: NotRequired[Boolean]

Indicates whether this option is permanent.

persistent instance-attribute

persistent: NotRequired[Boolean]

Indicates whether this option is persistent.

port instance-attribute

port: NotRequired[IntegerOptional]

If required, the port configured for this option to use.

vpc_security_group_memberships instance-attribute

vpc_security_group_memberships: NotRequired[VpcSecurityGroupMembershipList]

If the option requires access to a port, then this VPC security group allows access to the port.