Aws Rds Datasource

Table of values

Name	Value	Notes
Identifier	aws-rds
Default versioning	No default versioning
Custom registry support	Yes
Release timestamp support	No
Source URL support	No

Description

This datasource returns the database engine versions available for use on AWS RDS via the AWS API.

Generally speaking, all publicly released database versions are available for use on RDS. However, new versions may not be available on RDS for a few weeks or months after their release while AWS tests them. In addition, AWS may pull existing versions if serious problems arise during their use.

Warning

The default versioning of the aws-rds datasource is not compatible with AWS Aurora! If you use AWS Aurora, you must set your own custom versioning. Scroll down to see an example.

AWS API configuration

Since the datasource uses the AWS SDK for JavaScript, you can configure it like other AWS Tools. You can use common AWS configuration options, for example:

• Set the region via the AWS_REGION environment variable or your ~/.aws/config file
• Provide credentials via the AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY environment variables or your ~/.aws/credentials file
• Select the profile to use via AWS_PROFILE environment variable

Read the AWS Developer Guide - Configuring the SDK for JavaScript for more information on these configuration options.

Minimal IAM privileges needed for this datasource

{
  "Sid": "AllowDBEngineVersionLookup",
  "Effect": "Allow",
  "Action": ["rds:DescribeDBEngineVersions"],
  "Resource": "*"
}

Read the AWS RDS IAM reference for more information.

Usage

Because Renovate has no manager for the AWS RDS datasource, you need to help Renovate by configuring the custom manager to identify the RDS dependencies you want updated.

When configuring the custom manager, you have to pass a filter as minified JSON as the packageName. For example:

# Getting the latest supported MySQL 5.7 version from RDS as a filter would look like:

[
  {
    "Name": "engine",
    "Values": [ "mysql" ]
  },
  {
    "Name": "engine-version",
    "Values": [ "5.7" ]
  }
]

# In order to use it with this datasource, you have to minify it:

[{"Name":"engine","Values":["mysql"]},{"Name":"engine-version","Values":["5.7"]}]

Using a custom manager to configure this datasource

{
  "customManagers": [
    {
      "customType": "regex",
      "fileMatch": ["\\.yaml$"],
      "matchStrings": [
        ".*rdsFilter=(?<lookupName>.+?)[ ]*\n[ ]*(?<depName>[a-zA-Z0-9-_:]*)[ ]*?:[ ]*?[\"|']?(?<currentValue>[.\\d]+)[\"|']?.*"
      ],
      "datasourceTemplate": "aws-rds"
    }
  ]
}

The configuration above matches every YAML file, and recognizes these lines:

spec:
  # rdsFilter=[{"Name":"engine","Values":["mysql"]},{"Name":"engine-version","Values":["5.7"]}]
  engineVersion: 5.7.34

Using Terraform, aws-rds datasource and Aurora MySQL

Here is the Renovate configuration to use Terraform, aws-rds and Aurora MySQL:

{
  "customManagers": [
    {
      "description": "Update RDS",
      "customType": "regex",
      "fileMatch": [".+\\.tf$"],
      "matchStrings": [
        "\\s*#\\s*renovate:\\s*rdsFilter=(?<lookupName>.+?) depName=(?<depName>.*) versioning=(?<versioning>.*)\\s*.*_version\\s*=\\s*\"(?<currentValue>.*)\""
      ],
      "datasourceTemplate": "aws-rds"
    }
  ]
}

The above configuration is an example of updating an AWS RDS version inside a Terraform file, using a custom manager.

# renovate:rdsFilter=[{"Name":"engine","Values":["aurora-mysql"]},{"Name":"engine-version","Values":["8.0"]}] depName=aurora-mysql versioning=loose
engine_version = "8.0.mysql_aurora.3.05.2"