DBEngineVersion ¶

class DBEngineVersion(TypedDict, closed=True):
    engine: NotRequired["capo_rds.types.string.String"]
    """<p>The name of the database engine.</p>"""
    major_engine_version: NotRequired["capo_rds.types.string.String"]
    """<p>The major engine version of the CEV.</p>"""
    engine_version: NotRequired["capo_rds.types.string.String"]
    """<p>The version number of the database engine.</p>"""
    database_installation_files_s3_bucket_name: NotRequired[
        "capo_rds.types.string.String"
    ]
    """<p>The name of the Amazon S3 bucket that contains your database installation files.</p>"""
    database_installation_files_s3_prefix: NotRequired["capo_rds.types.string.String"]
    """<p>The Amazon S3 directory that contains the database installation files. If not specified, then no prefix is assumed.</p>"""
    database_installation_files: NotRequired["capo_rds.types.string_list.StringList"]
    """<p>The database installation files (ISO and EXE) that were uploaded to Amazon S3 and used to import the database engine version to Amazon RDS. Returned for RDS for SQL Server engine versions (<code>sqlserver-ee</code>, <code>sqlserver-se</code>, and <code>sqlserver-dev-ee</code>) created from customer-supplied installation media.</p>"""
    custom_db_engine_version_manifest: NotRequired[
        "capo_rds.types.custom_db_engine_version_manifest.CustomDBEngineVersionManifest"
    ]
    """<p>JSON string that lists the installation files and parameters that RDS Custom uses to create a custom engine version (CEV). RDS Custom applies the patches in the order in which they're listed in the manifest. You can set the Oracle home, Oracle base, and UNIX/Linux user and group using the installation parameters. For more information, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-cev.preparing.html#custom-cev.preparing.manifest.fields">JSON fields in the CEV manifest</a> in the <i>Amazon RDS User Guide</i>. </p>"""
    db_parameter_group_family: NotRequired["capo_rds.types.string.String"]
    """<p>The name of the DB parameter group family for the database engine.</p>"""
    db_engine_description: NotRequired["capo_rds.types.string.String"]
    """<p>The description of the database engine.</p>"""
    db_engine_version_arn: NotRequired["capo_rds.types.string.String"]
    """<p>The ARN of the custom engine version.</p>"""
    db_engine_version_description: NotRequired["capo_rds.types.string.String"]
    """<p>The description of the database engine version.</p>"""
    default_character_set: NotRequired["capo_rds.types.character_set.CharacterSet"]
    """<p>The default character set for new instances of this engine version, if the <code>CharacterSetName</code> parameter of the CreateDBInstance API isn't specified.</p>"""
    failure_reason: NotRequired["capo_rds.types.string.String"]
    """<p>The reason that the custom engine version creation failed with an <code>incompatible-installation-media</code> status. Applicable to RDS for SQL Server engine versions (<code>sqlserver-ee</code>, <code>sqlserver-se</code>, and <code>sqlserver-dev-ee</code>).</p>"""
    image: NotRequired[
        "capo_rds.types.custom_db_engine_version_ami.CustomDBEngineVersionAMI"
    ]
    """<p>The EC2 image</p>"""
    db_engine_media_type: NotRequired["capo_rds.types.string.String"]
    """<p>The source of the installation media for this engine version. A value of <code>Customer Provided</code> indicates that the engine version was created from customer-supplied installation media using <code>CreateCustomDBEngineVersion</code>. Applicable to RDS Custom for SQL Server and to RDS for SQL Server engine versions (<code>sqlserver-ee</code> and <code>sqlserver-se</code> with the <code>bring-your-own-media</code> license model, and <code>sqlserver-dev-ee</code>).</p>"""
    kms_key_id: NotRequired["capo_rds.types.string.String"]
    """<p>The Amazon Web Services KMS key identifier for an encrypted CEV. This parameter is required for RDS Custom, but optional for Amazon RDS.</p>"""
    create_time: NotRequired["capo_rds.types.t_stamp.TStamp"]
    """<p>The creation time of the DB engine version.</p>"""
    supported_character_sets: NotRequired[
        "capo_rds.types.supported_character_sets_list.SupportedCharacterSetsList"
    ]
    """<p>A list of the character sets supported by this engine for the <code>CharacterSetName</code> parameter of the <code>CreateDBInstance</code> operation.</p>"""
    supported_nchar_character_sets: NotRequired[
        "capo_rds.types.supported_character_sets_list.SupportedCharacterSetsList"
    ]
    """<p>A list of the character sets supported by the Oracle DB engine for the <code>NcharCharacterSetName</code> parameter of the <code>CreateDBInstance</code> operation.</p>"""
    valid_upgrade_target: NotRequired[
        "capo_rds.types.valid_upgrade_target_list.ValidUpgradeTargetList"
    ]
    """<p>A list of engine versions that this database engine version can be upgraded to.</p>"""
    supported_timezones: NotRequired[
        "capo_rds.types.supported_timezones_list.SupportedTimezonesList"
    ]
    """<p>A list of the time zones supported by this engine for the <code>Timezone</code> parameter of the <code>CreateDBInstance</code> action.</p>"""
    exportable_log_types: NotRequired["capo_rds.types.log_type_list.LogTypeList"]
    """<p>The types of logs that the database engine has available for export to CloudWatch Logs.</p>"""
    supports_log_exports_to_cloudwatch_logs: NotRequired[
        "capo_rds.types.boolean.Boolean"
    ]
    """<p>Indicates whether the engine version supports exporting the log types specified by ExportableLogTypes to CloudWatch Logs.</p>"""
    supports_read_replica: NotRequired["capo_rds.types.boolean.Boolean"]
    """<p>Indicates whether the database engine version supports read replicas.</p>"""
    supported_engine_modes: NotRequired[
        "capo_rds.types.engine_mode_list.EngineModeList"
    ]
    """<p>A list of the supported DB engine modes.</p>"""
    supported_feature_names: NotRequired[
        "capo_rds.types.feature_name_list.FeatureNameList"
    ]
    """<p>A list of features supported by the DB engine.</p> <p>The supported features vary by DB engine and DB engine version.</p> <p>To determine the supported features for a specific DB engine and DB engine version using the CLI, use the following command:</p> <p> <code>aws rds describe-db-engine-versions --engine &lt;engine_name&gt; --engine-version &lt;engine_version&gt;</code> </p> <p>For example, to determine the supported features for RDS for PostgreSQL version 13.3 using the CLI, use the following command:</p> <p> <code>aws rds describe-db-engine-versions --engine postgres --engine-version 13.3</code> </p> <p>The supported features are listed under <code>SupportedFeatureNames</code> in the output.</p>"""
    status: NotRequired["capo_rds.types.string.String"]
    """<p>The status of the DB engine version, either <code>available</code> or <code>deprecated</code>.</p>"""
    supports_parallel_query: NotRequired["capo_rds.types.boolean.Boolean"]
    """<p>Indicates whether you can use Aurora parallel query with a specific DB engine version.</p>"""
    supports_global_databases: NotRequired["capo_rds.types.boolean.Boolean"]
    """<p>Indicates whether you can use Aurora global databases with a specific DB engine version.</p>"""
    tag_list: NotRequired["capo_rds.types.tag_list.TagList"]
    supports_babelfish: NotRequired["capo_rds.types.boolean.Boolean"]
    """<p>Indicates whether the engine version supports Babelfish for Aurora PostgreSQL.</p>"""
    supports_limitless_database: NotRequired["capo_rds.types.boolean.Boolean"]
    """<p>Indicates whether the DB engine version supports Aurora Limitless Database.</p>"""
    supports_certificate_rotation_without_restart: NotRequired[
        "capo_rds.types.boolean_optional.BooleanOptional"
    ]
    """<p>Indicates whether the engine version supports rotating the server certificate without rebooting the DB instance.</p>"""
    supported_ca_certificate_identifiers: NotRequired[
        "capo_rds.types.ca_certificate_identifiers_list.CACertificateIdentifiersList"
    ]
    """<p>A list of the supported CA certificate identifiers.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.SSL.html">Using SSL/TLS to encrypt a connection to a DB instance</a> in the <i>Amazon RDS User Guide</i> and <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.SSL.html"> Using SSL/TLS to encrypt a connection to a DB cluster</a> in the <i>Amazon Aurora User Guide</i>.</p>"""
    supports_local_write_forwarding: NotRequired[
        "capo_rds.types.boolean_optional.BooleanOptional"
    ]
    """<p>Indicates whether the DB engine version supports forwarding write operations from reader DB instances to the writer DB instance in the DB cluster. By default, write operations aren't allowed on reader DB instances.</p> <p>Valid for: Aurora DB clusters only</p>"""
    supports_integrations: NotRequired["capo_rds.types.boolean.Boolean"]
    """<p>Indicates whether the DB engine version supports zero-ETL integrations with Amazon Redshift.</p>"""
    serverless_v2_features_support: NotRequired[
        "capo_rds.types.serverless_v2_features_support.ServerlessV2FeaturesSupport"
    ]
    """<p>Specifies any Aurora Serverless v2 properties or limits that differ between Aurora engine versions. You can test the values of this attribute when deciding which Aurora version to use in a new or upgraded DB cluster. You can also retrieve the version of an existing DB cluster and check whether that version supports certain Aurora Serverless v2 features before you attempt to use those features. </p>"""