Skip to content

OrderableDBInstanceOption

Source code in docs_src/capo_rds/types/orderable_db_instance_option.py
class OrderableDBInstanceOption(TypedDict, closed=True):
    engine: NotRequired["capo_rds.types.string.String"]
    """<p>The engine type of a DB instance.</p>"""
    engine_version: NotRequired["capo_rds.types.string.String"]
    """<p>The engine version of a DB instance.</p>"""
    db_instance_class: NotRequired["capo_rds.types.string.String"]
    """<p>The DB instance class for a DB instance.</p>"""
    license_model: NotRequired["capo_rds.types.string.String"]
    """<p>The license model for a DB instance.</p>"""
    availability_zone_group: NotRequired["capo_rds.types.string.String"]
    """<p>The Availability Zone group for a DB instance.</p>"""
    availability_zones: NotRequired[
        "capo_rds.types.availability_zone_list.AvailabilityZoneList"
    ]
    """<p>A list of Availability Zones for a DB instance.</p>"""
    multi_az_capable: NotRequired["capo_rds.types.boolean.Boolean"]
    """<p>Indicates whether a DB instance is Multi-AZ capable.</p>"""
    read_replica_capable: NotRequired["capo_rds.types.boolean.Boolean"]
    """<p>Indicates whether a DB instance can have a read replica.</p>"""
    vpc: NotRequired["capo_rds.types.boolean.Boolean"]
    """<p>Indicates whether a DB instance is in a VPC.</p>"""
    supports_storage_encryption: NotRequired["capo_rds.types.boolean.Boolean"]
    """<p>Indicates whether a DB instance supports encrypted storage.</p>"""
    storage_type: NotRequired["capo_rds.types.string.String"]
    """<p>The storage type for a DB instance.</p>"""
    supports_iops: NotRequired["capo_rds.types.boolean.Boolean"]
    """<p>Indicates whether a DB instance supports provisioned IOPS.</p>"""
    supports_storage_throughput: NotRequired["capo_rds.types.boolean.Boolean"]
    """<p>Indicates whether a DB instance supports storage throughput.</p>"""
    supports_enhanced_monitoring: NotRequired["capo_rds.types.boolean.Boolean"]
    """<p>Indicates whether a DB instance supports Enhanced Monitoring at intervals from 1 to 60 seconds.</p>"""
    supports_iam_database_authentication: NotRequired["capo_rds.types.boolean.Boolean"]
    """<p>Indicates whether a DB instance supports IAM database authentication.</p>"""
    supports_performance_insights: NotRequired["capo_rds.types.boolean.Boolean"]
    """<p>Indicates whether a DB instance supports Performance Insights.</p>"""
    min_storage_size: NotRequired["capo_rds.types.integer_optional.IntegerOptional"]
    """<p>Minimum storage size for a DB instance.</p>"""
    max_storage_size: NotRequired["capo_rds.types.integer_optional.IntegerOptional"]
    """<p>Maximum storage size for a DB instance.</p>"""
    min_iops_per_db_instance: NotRequired[
        "capo_rds.types.integer_optional.IntegerOptional"
    ]
    """<p>Minimum total provisioned IOPS for a DB instance.</p>"""
    max_iops_per_db_instance: NotRequired[
        "capo_rds.types.integer_optional.IntegerOptional"
    ]
    """<p>Maximum total provisioned IOPS for a DB instance.</p>"""
    min_iops_per_gib: NotRequired["capo_rds.types.double_optional.DoubleOptional"]
    """<p>Minimum provisioned IOPS per GiB for a DB instance.</p>"""
    max_iops_per_gib: NotRequired["capo_rds.types.double_optional.DoubleOptional"]
    """<p>Maximum provisioned IOPS per GiB for a DB instance.</p>"""
    min_storage_throughput_per_db_instance: NotRequired[
        "capo_rds.types.integer_optional.IntegerOptional"
    ]
    """<p>Minimum storage throughput for a DB instance.</p>"""
    max_storage_throughput_per_db_instance: NotRequired[
        "capo_rds.types.integer_optional.IntegerOptional"
    ]
    """<p>Maximum storage throughput for a DB instance.</p>"""
    min_storage_throughput_per_iops: NotRequired[
        "capo_rds.types.double_optional.DoubleOptional"
    ]
    """<p>Minimum storage throughput to provisioned IOPS ratio for a DB instance.</p>"""
    max_storage_throughput_per_iops: NotRequired[
        "capo_rds.types.double_optional.DoubleOptional"
    ]
    """<p>Maximum storage throughput to provisioned IOPS ratio for a DB instance.</p>"""
    available_processor_features: NotRequired[
        "capo_rds.types.available_processor_feature_list.AvailableProcessorFeatureList"
    ]
    """<p>A list of the available processor features for the DB instance class of a DB instance.</p>"""
    supported_engine_modes: NotRequired[
        "capo_rds.types.engine_mode_list.EngineModeList"
    ]
    """<p>A list of the supported DB engine modes.</p>"""
    supports_storage_autoscaling: NotRequired[
        "capo_rds.types.boolean_optional.BooleanOptional"
    ]
    """<p>Indicates whether Amazon RDS can automatically scale storage for DB instances that use the specified DB instance class.</p>"""
    supports_kerberos_authentication: NotRequired[
        "capo_rds.types.boolean_optional.BooleanOptional"
    ]
    """<p>Indicates whether a DB instance supports Kerberos Authentication.</p>"""
    outpost_capable: NotRequired["capo_rds.types.boolean.Boolean"]
    """<p>Indicates whether a DB instance supports RDS on Outposts.</p> <p>For more information about RDS on Outposts, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-on-outposts.html">Amazon RDS on Amazon Web Services Outposts</a> in the <i>Amazon RDS User Guide.</i> </p>"""
    supported_activity_stream_modes: NotRequired[
        "capo_rds.types.activity_stream_mode_list.ActivityStreamModeList"
    ]
    """<p>The list of supported modes for Database Activity Streams. Aurora PostgreSQL returns the value <code>[sync, async]</code>. Aurora MySQL and RDS for Oracle return <code>[async]</code> only. If Database Activity Streams isn't supported, the return value is an empty list.</p>"""
    supports_global_databases: NotRequired["capo_rds.types.boolean.Boolean"]
    """<p>Indicates whether you can use Aurora global databases with a specific combination of other DB engine attributes.</p>"""
    supported_network_types: NotRequired["capo_rds.types.string_list.StringList"]
    """<p>The network types supported by the DB instance (<code>IPV4</code> or <code>DUAL</code>).</p> <p>A DB instance can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (<code>DUAL</code>).</p> <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html"> Working with a DB instance in a VPC</a> in the <i>Amazon RDS User Guide.</i> </p>"""
    supports_clusters: NotRequired["capo_rds.types.boolean.Boolean"]
    """<p>Indicates whether DB instances can be configured as a Multi-AZ DB cluster.</p> <p>For more information on Multi-AZ DB clusters, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html"> Multi-AZ deployments with two readable standby DB instances</a> in the <i>Amazon RDS User Guide.</i> </p>"""
    supports_dedicated_log_volume: NotRequired["capo_rds.types.boolean.Boolean"]
    """<p>Indicates whether a DB instance supports using a dedicated log volume (DLV).</p>"""
    supports_additional_storage_volumes: NotRequired[
        "capo_rds.types.boolean_optional.BooleanOptional"
    ]
    """<p>Indicates whether the DB instance class supports additional storage volumes.</p>"""
    supports_http_endpoint: NotRequired["capo_rds.types.boolean.Boolean"]
    """<p>Indicates whether a DB instance supports HTTP endpoints.</p>"""
    available_additional_storage_volumes_options: NotRequired[
        "capo_rds.types.available_additional_storage_volumes_option_list.AvailableAdditionalStorageVolumesOptionList"
    ]
    """<p>The available options for additional storage volumes for the DB instance class.</p>"""

availability_zone_group instance-attribute

availability_zone_group: NotRequired[String]

The Availability Zone group for a DB instance.

availability_zones instance-attribute

availability_zones: NotRequired[AvailabilityZoneList]

A list of Availability Zones for a DB instance.

available_additional_storage_volumes_options instance-attribute

available_additional_storage_volumes_options: NotRequired[
    AvailableAdditionalStorageVolumesOptionList
]

The available options for additional storage volumes for the DB instance class.

available_processor_features instance-attribute

available_processor_features: NotRequired[AvailableProcessorFeatureList]

A list of the available processor features for the DB instance class of a DB instance.

db_instance_class instance-attribute

db_instance_class: NotRequired[String]

The DB instance class for a DB instance.

engine instance-attribute

engine: NotRequired[String]

The engine type of a DB instance.

engine_version instance-attribute

engine_version: NotRequired[String]

The engine version of a DB instance.

license_model instance-attribute

license_model: NotRequired[String]

The license model for a DB instance.

max_iops_per_db_instance instance-attribute

max_iops_per_db_instance: NotRequired[IntegerOptional]

Maximum total provisioned IOPS for a DB instance.

max_iops_per_gib instance-attribute

max_iops_per_gib: NotRequired[DoubleOptional]

Maximum provisioned IOPS per GiB for a DB instance.

max_storage_size instance-attribute

max_storage_size: NotRequired[IntegerOptional]

Maximum storage size for a DB instance.

max_storage_throughput_per_db_instance instance-attribute

max_storage_throughput_per_db_instance: NotRequired[IntegerOptional]

Maximum storage throughput for a DB instance.

max_storage_throughput_per_iops instance-attribute

max_storage_throughput_per_iops: NotRequired[DoubleOptional]

Maximum storage throughput to provisioned IOPS ratio for a DB instance.

min_iops_per_db_instance instance-attribute

min_iops_per_db_instance: NotRequired[IntegerOptional]

Minimum total provisioned IOPS for a DB instance.

min_iops_per_gib instance-attribute

min_iops_per_gib: NotRequired[DoubleOptional]

Minimum provisioned IOPS per GiB for a DB instance.

min_storage_size instance-attribute

min_storage_size: NotRequired[IntegerOptional]

Minimum storage size for a DB instance.

min_storage_throughput_per_db_instance instance-attribute

min_storage_throughput_per_db_instance: NotRequired[IntegerOptional]

Minimum storage throughput for a DB instance.

min_storage_throughput_per_iops instance-attribute

min_storage_throughput_per_iops: NotRequired[DoubleOptional]

Minimum storage throughput to provisioned IOPS ratio for a DB instance.

multi_az_capable instance-attribute

multi_az_capable: NotRequired[Boolean]

Indicates whether a DB instance is Multi-AZ capable.

outpost_capable instance-attribute

outpost_capable: NotRequired[Boolean]

Indicates whether a DB instance supports RDS on Outposts.

For more information about RDS on Outposts, see Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.

read_replica_capable instance-attribute

read_replica_capable: NotRequired[Boolean]

Indicates whether a DB instance can have a read replica.

storage_type instance-attribute

storage_type: NotRequired[String]

The storage type for a DB instance.

supported_activity_stream_modes instance-attribute

supported_activity_stream_modes: NotRequired[ActivityStreamModeList]

The list of supported modes for Database Activity Streams. Aurora PostgreSQL returns the value [sync, async]. Aurora MySQL and RDS for Oracle return [async] only. If Database Activity Streams isn't supported, the return value is an empty list.

supported_engine_modes instance-attribute

supported_engine_modes: NotRequired[EngineModeList]

A list of the supported DB engine modes.

supported_network_types instance-attribute

supported_network_types: NotRequired[StringList]

The network types supported by the DB instance (IPV4 or DUAL).

A DB instance can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (DUAL).

For more information, see Working with a DB instance in a VPC in the Amazon RDS User Guide.

supports_additional_storage_volumes instance-attribute

supports_additional_storage_volumes: NotRequired[BooleanOptional]

Indicates whether the DB instance class supports additional storage volumes.

supports_clusters instance-attribute

supports_clusters: NotRequired[Boolean]

Indicates whether DB instances can be configured as a Multi-AZ DB cluster.

For more information on Multi-AZ DB clusters, see Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.

supports_dedicated_log_volume instance-attribute

supports_dedicated_log_volume: NotRequired[Boolean]

Indicates whether a DB instance supports using a dedicated log volume (DLV).

supports_enhanced_monitoring instance-attribute

supports_enhanced_monitoring: NotRequired[Boolean]

Indicates whether a DB instance supports Enhanced Monitoring at intervals from 1 to 60 seconds.

supports_global_databases instance-attribute

supports_global_databases: NotRequired[Boolean]

Indicates whether you can use Aurora global databases with a specific combination of other DB engine attributes.

supports_http_endpoint instance-attribute

supports_http_endpoint: NotRequired[Boolean]

Indicates whether a DB instance supports HTTP endpoints.

supports_iam_database_authentication instance-attribute

supports_iam_database_authentication: NotRequired[Boolean]

Indicates whether a DB instance supports IAM database authentication.

supports_iops instance-attribute

supports_iops: NotRequired[Boolean]

Indicates whether a DB instance supports provisioned IOPS.

supports_kerberos_authentication instance-attribute

supports_kerberos_authentication: NotRequired[BooleanOptional]

Indicates whether a DB instance supports Kerberos Authentication.

supports_performance_insights instance-attribute

supports_performance_insights: NotRequired[Boolean]

Indicates whether a DB instance supports Performance Insights.

supports_storage_autoscaling instance-attribute

supports_storage_autoscaling: NotRequired[BooleanOptional]

Indicates whether Amazon RDS can automatically scale storage for DB instances that use the specified DB instance class.

supports_storage_encryption instance-attribute

supports_storage_encryption: NotRequired[Boolean]

Indicates whether a DB instance supports encrypted storage.

supports_storage_throughput instance-attribute

supports_storage_throughput: NotRequired[Boolean]

Indicates whether a DB instance supports storage throughput.

vpc instance-attribute

vpc: NotRequired[Boolean]

Indicates whether a DB instance is in a VPC.