Skip to main content

customdb_engine_version_tags

Expands all tag keys and values for customdb_engine_versions in a region

Overview

Namecustomdb_engine_version_tags
TypeResource
DescriptionCreates a custom DB engine version (CEV).
Idaws.rds.customdb_engine_version_tags

Fields

NameDatatypeDescription
database_installation_files_s3_bucket_namestringThe name of an Amazon S3 bucket that contains database installation files for your CEV. For example, a valid bucket name is my-custom-installation-files.
database_installation_files_s3_prefixstringThe Amazon S3 directory that contains the database installation files for your CEV. For example, a valid bucket name is 123456789012/cev1. If this setting isn't specified, no prefix is assumed.
descriptionstringAn optional description of your CEV.
enginestringThe database engine to use for your custom engine version (CEV).
Valid values:
+ custom-oracle-ee
+ custom-oracle-ee-cdb
engine_versionstringThe name of your CEV. The name format is major version.customized_string. For example, a valid CEV name is 19.my_cev1. This setting is required for RDS Custom for Oracle, but optional for Amazon RDS. The combination of Engine and EngineVersion is unique per customer per Region.
Constraints: Minimum length is 1. Maximum length is 60.
Pattern: ^[a-z0-9_.-]{1,60$}
kms_key_idstringThe AWS KMS key identifier for an encrypted CEV. A symmetric encryption KMS key is required for RDS Custom, but optional for Amazon RDS.
If you have an existing symmetric encryption KMS key in your account, you can use it with RDS Custom. No further action is necessary. If you don't already have a symmetric encryption KMS key in your account, follow the instructions in [Creating a symmetric encryption KMS key](https://docs.aws.amazon.com/kms/latest/developerguide/create-keys.html#create-symmetric-cmk) in the Key Management Service Developer Guide.
You can choose the same symmetric encryption key when you create a CEV and a DB instance, or choose different keys.
manifeststringThe CEV manifest, which is a JSON document that describes the installation .zip files stored in Amazon S3. Specify the name/value pairs in a file or a quoted string. RDS Custom applies the patches in the order in which they are listed.
The following JSON fields are valid:
+ MediaImportTemplateVersion Version of the CEV manifest. The date is in the format YYYY-MM-DD. + databaseInstallationFileNames Ordered list of installation files for the CEV. + opatchFileNames Ordered list of OPatch installers used for the Oracle DB engine. + psuRuPatchFileNames The PSU and RU patches for this CEV. + OtherPatchFileNames The patches that are not in the list of PSU and RU patches. Amazon RDS applies these patches after applying the PSU and RU patches.
For more information, see [Creating the CEV manifest](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-cev.html#custom-cev.preparing.manifest) in the Amazon RDS User Guide.
db_engine_version_arnstring
source_custom_db_engine_version_identifierstringThe ARN of a CEV to use as a source for creating a new CEV. You can specify a different Amazon Machine Imagine (AMI) by using either Source or UseAwsProvidedLatestImage. You can't specify a different JSON manifest when you specify SourceCustomDbEngineVersionIdentifier.
use_aws_provided_latest_imagebooleanSpecifies whether to use the latest service-provided Amazon Machine Image (AMI) for the CEV. If you specify UseAwsProvidedLatestImage, you can't also specify ImageId.
image_idstringA value that indicates the ID of the AMI.
statusstringA value that indicates the status of a custom engine version (CEV).
tag_keystringTag key.
tag_valuestringTag value.
regionstringAWS region.

Methods

NameAccessible byRequired Params
list_resourcesSELECTregion

SELECT examples

Expands tags for all customdb_engine_versions in a region.

SELECT
region,
database_installation_files_s3_bucket_name,
database_installation_files_s3_prefix,
description,
engine,
engine_version,
kms_key_id,
manifest,
db_engine_version_arn,
source_custom_db_engine_version_identifier,
use_aws_provided_latest_image,
image_id,
status,
tag_key,
tag_value
FROM aws.rds.customdb_engine_version_tags
WHERE region = 'us-east-1';

Permissions

For permissions required to operate on the customdb_engine_version_tags resource, see customdb_engine_versions