modify_custom_db_engine_version¶
Operation¶
async
¶
modify_custom_db_engine_version(input: ModifyCustomDBEngineVersionInput, plugins: list[Plugin] | None = None) -> ModifyCustomDBEngineVersionOutput
Modifies the status of a custom engine version (CEV). You can find CEVs
to modify by calling DescribeDBEngineVersions.
Note
The MediaImport service that imports files from Amazon S3 to create CEVs
isn't integrated with Amazon Web Services CloudTrail. If you turn on
data logging for Amazon RDS in CloudTrail, calls to the
ModifyCustomDbEngineVersion event aren't logged. However, you might
see calls from the API gateway that accesses your Amazon S3 bucket.
These calls originate from the MediaImport service for the
ModifyCustomDbEngineVersion event.
For more information, see Modifying CEV status in the Amazon RDS User Guide.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
ModifyCustomDBEngineVersionInput
|
An instance of |
required |
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
Returns:
| Type | Description |
|---|---|
ModifyCustomDBEngineVersionOutput
|
An instance of |
Input¶
dataclass
¶
Bases: _SerdeShape
Dataclass for ModifyCustomDBEngineVersionInput structure.
Attributes¶
class-attribute
instance-attribute
¶
description: str | None = ...
An optional description of your CEV.
class-attribute
instance-attribute
¶
engine: str | None = ...
The database engine.
RDS Custom for Oracle supports the following values:
-
custom-oracle-ee -
custom-oracle-ee-cdb -
custom-oracle-se2 -
custom-oracle-se2-cdb
RDS Custom for SQL Server supports the following values:
-
custom-sqlserver-ee -
custom-sqlserver-se -
custom-sqlserver-web -
custom-sqlserver-dev
RDS for SQL Server supports the following values:
-
sqlserver-ee(Bring Your Own Media) -
sqlserver-se(Bring Your Own Media) -
sqlserver-dev-ee
class-attribute
instance-attribute
¶
engine_version: str | None = ...
The custom engine version (CEV) that you want to modify. This option is
required for RDS Custom for Oracle, but optional for Amazon RDS. The
combination of Engine and EngineVersion is unique per customer per
Amazon Web Services Region.
class-attribute
instance-attribute
¶
status: str | None = ...
The availability status to be assigned to the CEV. Valid values are as follows:
- available
-
You can use this CEV to create a new RDS Custom DB instance.
- inactive
-
You can create a new RDS Custom instance by restoring a DB snapshot with this CEV. You can't patch or create new instances with this CEV.
You can change any status to any status. A typical reason to change
status is to prevent the accidental use of a CEV, or to make a
deprecated CEV eligible for use again. For example, you might change the
status of your CEV from available to inactive, and from inactive
back to available. To change the availability status of the CEV, it
must not currently be in use by an RDS Custom instance, snapshot, or
automated backup.
Output¶
dataclass
¶
Bases: _SerdeShape
This data type is used as a response element in the action
DescribeDBEngineVersions.
Attributes¶
class-attribute
instance-attribute
¶
create_time: datetime | None = ...
The creation time of the DB engine version.
class-attribute
instance-attribute
¶
custom_db_engine_version_manifest: str | None = ...
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 JSON fields in the CEV manifest in the Amazon RDS User Guide.
class-attribute
instance-attribute
¶
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 (sqlserver-ee,
sqlserver-se, and sqlserver-dev-ee) created from customer-supplied
installation media.
class-attribute
instance-attribute
¶
database_installation_files_s3_bucket_name: str | None = ...
The name of the Amazon S3 bucket that contains your database installation files.
class-attribute
instance-attribute
¶
database_installation_files_s3_prefix: str | None = ...
The Amazon S3 directory that contains the database installation files. If not specified, then no prefix is assumed.
class-attribute
instance-attribute
¶
db_engine_description: str | None = ...
The description of the database engine.
class-attribute
instance-attribute
¶
db_engine_media_type: str | None = ...
The source of the installation media for this engine version. A value of
Customer Provided indicates that the engine version was created from
customer-supplied installation media using
CreateCustomDBEngineVersion. Applicable to RDS Custom for SQL Server
and to RDS for SQL Server engine versions (sqlserver-ee and
sqlserver-se with the bring-your-own-media license model, and
sqlserver-dev-ee).
class-attribute
instance-attribute
¶
db_engine_version_arn: str | None = ...
The ARN of the custom engine version.
class-attribute
instance-attribute
¶
db_engine_version_description: str | None = ...
The description of the database engine version.
class-attribute
instance-attribute
¶
db_parameter_group_family: str | None = ...
The name of the DB parameter group family for the database engine.
class-attribute
instance-attribute
¶
default_character_set: CharacterSet | None = ...
The default character set for new instances of this engine version, if
the CharacterSetName parameter of the CreateDBInstance API isn't
specified.
class-attribute
instance-attribute
¶
engine: str | None = ...
The name of the database engine.
class-attribute
instance-attribute
¶
engine_version: str | None = ...
The version number of the database engine.
class-attribute
instance-attribute
¶
The types of logs that the database engine has available for export to CloudWatch Logs.
class-attribute
instance-attribute
¶
failure_reason: str | None = ...
The reason that the custom engine version creation failed with an
incompatible-installation-media status. Applicable to RDS for SQL
Server engine versions (sqlserver-ee, sqlserver-se, and
sqlserver-dev-ee).
class-attribute
instance-attribute
¶
image: CustomDBEngineVersionAMI | None = ...
The EC2 image
class-attribute
instance-attribute
¶
kms_key_id: str | None = ...
The Amazon Web Services KMS key identifier for an encrypted CEV. This parameter is required for RDS Custom, but optional for Amazon RDS.
class-attribute
instance-attribute
¶
major_engine_version: str | None = ...
The major engine version of the CEV.
class-attribute
instance-attribute
¶
Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.
class-attribute
instance-attribute
¶
serverless_v2_features_support: ServerlessV2FeaturesSupport | None = ...
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.
class-attribute
instance-attribute
¶
status: str | None = ...
The status of the DB engine version, either available or deprecated.
class-attribute
instance-attribute
¶
A list of the supported CA certificate identifiers.
For more information, see Using SSL/TLS to encrypt a connection to a DB instance in the Amazon RDS User Guide and Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora User Guide.
class-attribute
instance-attribute
¶
supported_character_sets: list[CharacterSet] | None = ...
A list of the character sets supported by this engine for the
CharacterSetName parameter of the CreateDBInstance operation.
class-attribute
instance-attribute
¶
A list of the supported DB engine modes.
class-attribute
instance-attribute
¶
A list of features supported by the DB engine.
The supported features vary by DB engine and DB engine version.
To determine the supported features for a specific DB engine and DB engine version using the CLI, use the following command:
aws rds describe-db-engine-versions --engine <engine_name> --engine-version <engine_version>
For example, to determine the supported features for RDS for PostgreSQL version 13.3 using the CLI, use the following command:
aws rds describe-db-engine-versions --engine postgres --engine-version 13.3
The supported features are listed under SupportedFeatureNames in the
output.
class-attribute
instance-attribute
¶
supported_nchar_character_sets: list[CharacterSet] | None = ...
A list of the character sets supported by the Oracle DB engine for the
NcharCharacterSetName parameter of the CreateDBInstance operation.
class-attribute
instance-attribute
¶
A list of the time zones supported by this engine for the Timezone
parameter of the CreateDBInstance action.
class-attribute
instance-attribute
¶
supports_babelfish: bool | None = ...
Indicates whether the engine version supports Babelfish for Aurora PostgreSQL.
class-attribute
instance-attribute
¶
supports_certificate_rotation_without_restart: bool | None = ...
Indicates whether the engine version supports rotating the server certificate without rebooting the DB instance.
class-attribute
instance-attribute
¶
supports_global_databases: bool | None = ...
Indicates whether you can use Aurora global databases with a specific DB engine version.
class-attribute
instance-attribute
¶
supports_integrations: bool | None = ...
Indicates whether the DB engine version supports zero-ETL integrations with Amazon Redshift.
class-attribute
instance-attribute
¶
supports_limitless_database: bool | None = ...
Indicates whether the DB engine version supports Aurora Limitless Database.
class-attribute
instance-attribute
¶
supports_local_write_forwarding: bool | None = ...
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.
Valid for: Aurora DB clusters only
class-attribute
instance-attribute
¶
supports_log_exports_to_cloudwatch_logs: bool | None = ...
Indicates whether the engine version supports exporting the log types specified by ExportableLogTypes to CloudWatch Logs.
class-attribute
instance-attribute
¶
supports_parallel_query: bool | None = ...
Indicates whether you can use Aurora parallel query with a specific DB engine version.
class-attribute
instance-attribute
¶
supports_read_replica: bool | None = ...
Indicates whether the database engine version supports read replicas.
class-attribute
instance-attribute
¶
A list of tags.
For more information, see Tagging Amazon RDS resources in the Amazon RDS User Guide or Tagging Amazon Aurora and Amazon RDS resources in the Amazon Aurora User Guide.
class-attribute
instance-attribute
¶
valid_upgrade_target: list[UpgradeTarget] | None = ...
A list of engine versions that this database engine version can be upgraded to.