amazon.aws.rds_engine_versions_info module – Describes the properties of specific versions of DB engines

Note

This module is part of the amazon.aws collection (version 10.0.0-dev0).

It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install amazon.aws. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: amazon.aws.rds_engine_versions_info.

New in amazon.aws 7.6.0

Synopsis

  • Obtain information about a specific versions of DB engines.

Requirements

The below requirements are needed on the host that executes this module.

  • python >= 3.6

  • boto3 >= 1.28.0

  • botocore >= 1.31.0

Parameters

Parameter

Comments

access_key

aliases: aws_access_key_id, aws_access_key, ec2_access_key

string

AWS access key ID.

See the AWS documentation for more information about access tokens https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys.

The AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variables may also be used in decreasing order of preference.

The aws_access_key and profile options are mutually exclusive.

The aws_access_key_id alias was added in release 5.1.0 for consistency with the AWS botocore SDK.

The ec2_access_key alias has been deprecated and will be removed in a release after 2024-12-01.

Support for the EC2_ACCESS_KEY environment variable has been deprecated and will be removed in a release after 2024-12-01.

aws_ca_bundle

path

The location of a CA Bundle to use when validating SSL certificates.

The AWS_CA_BUNDLE environment variable may also be used.

aws_config

dictionary

A dictionary to modify the botocore configuration.

Parameters can be found in the AWS documentation https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config.

db_parameter_group_family

string

The name of a specific RDS parameter group family to return details for.

debug_botocore_endpoint_logs

boolean

Use a botocore.endpoint logger to parse the unique (rather than total) "resource:action" API calls made during a task, outputing the set to the resource_actions key in the task results. Use the aws_resource_action callback to output to total list made during a playbook.

The ANSIBLE_DEBUG_BOTOCORE_LOGS environment variable may also be used.

Choices:

  • false ← (default)

  • true

default_only

boolean

Specifies whether to return only the default version of the specified engine or the engine and major version combination.

Choices:

  • false ← (default)

  • true

endpoint_url

aliases: ec2_url, aws_endpoint_url, s3_url

string

URL to connect to instead of the default AWS endpoints. While this can be used to connection to other AWS-compatible services the amazon.aws and community.aws collections are only tested against AWS.

The AWS_URL or EC2_URL environment variables may also be used, in decreasing order of preference.

The ec2_url and s3_url aliases have been deprecated and will be removed in a release after 2024-12-01.

Support for the EC2_URL environment variable has been deprecated and will be removed in a release after 2024-12-01.

engine

string

The database engine to return version details for.

Choices:

  • "aurora-mysql"

  • "aurora-postgresql"

  • "custom-oracle-ee"

  • "db2-ae"

  • "db2-se"

  • "mariadb"

  • "mysql"

  • "oracle-ee"

  • "oracle-ee-cdb"

  • "oracle-se2"

  • "oracle-se2-cdb"

  • "postgres"

  • "sqlserver-ee"

  • "sqlserver-se"

  • "sqlserver-ex"

  • "sqlserver-web"

engine_version

string

A specific database engine version to return details for.

filters

dictionary

A filter that specifies one or more DB engine versions to describe. See https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DescribeDBEngineVersions.html.

profile

aliases: aws_profile

string

A named AWS profile to use for authentication.

See the AWS documentation for more information about named profiles https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html.

The AWS_PROFILE environment variable may also be used.

The profile option is mutually exclusive with the aws_access_key, aws_secret_key and security_token options.

region

aliases: aws_region, ec2_region

string

The AWS region to use.

For global services such as IAM, Route53 and CloudFront, region is ignored.

The AWS_REGION or EC2_REGION environment variables may also be used.

See the Amazon AWS documentation for more information http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region.

The ec2_region alias has been deprecated and will be removed in a release after 2024-12-01

Support for the EC2_REGION environment variable has been deprecated and will be removed in a release after 2024-12-01.

secret_key

aliases: aws_secret_access_key, aws_secret_key, ec2_secret_key

string

AWS secret access key.

See the AWS documentation for more information about access tokens https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys.

The AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variables may also be used in decreasing order of preference.

The secret_key and profile options are mutually exclusive.

The aws_secret_access_key alias was added in release 5.1.0 for consistency with the AWS botocore SDK.

The ec2_secret_key alias has been deprecated and will be removed in a release after 2024-12-01.

Support for the EC2_SECRET_KEY environment variable has been deprecated and will be removed in a release after 2024-12-01.

session_token

aliases: aws_session_token, security_token, aws_security_token, access_token

string

AWS STS session token for use with temporary credentials.

See the AWS documentation for more information about access tokens https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys.

The AWS_SESSION_TOKEN, AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variables may also be used in decreasing order of preference.

The security_token and profile options are mutually exclusive.

Aliases aws_session_token and session_token were added in release 3.2.0, with the parameter being renamed from security_token to session_token in release 6.0.0.

The security_token, aws_security_token, and access_token aliases have been deprecated and will be removed in a release after 2024-12-01.

Support for the EC2_SECRET_KEY and AWS_SECURITY_TOKEN environment variables has been deprecated and will be removed in a release after 2024-12-01.

validate_certs

boolean

When set to false, SSL certificates will not be validated for communication with the AWS APIs.

Setting validate_certs=false is strongly discouraged, as an alternative, consider setting aws_ca_bundle instead.

Choices:

  • false

  • true ← (default)

Notes

Note

  • Caution: For modules, environment variables and configuration files are read from the Ansible ‘host’ context and not the ‘controller’ context. As such, files may need to be explicitly copied to the ‘host’. For lookup and connection plugins, environment variables and configuration files are read from the Ansible ‘controller’ context and not the ‘host’ context.

  • The AWS SDK (boto3) that Ansible uses may also read defaults for credentials and other settings, such as the region, from its configuration files in the Ansible ‘host’ context (typically ~/.aws/credentials). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information.

Examples

- name: List all of the available parameter group families for the Aurora PostgreSQL DB engine
  amazon.aws.rds_engine_versions_info:
    engine: aurora-postgresql

- name: List all of the available parameter group families for the Aurora PostgreSQL DB engine on a specific version
  amazon.aws.rds_engine_versions_info:
    engine: aurora-postgresql
    engine_version: 16.1

- name: Get default engine version for DB parameter group family postgres16
  amazon.aws.rds_engine_versions_info:
    engine: postgres
    default_only: true
    db_parameter_group_family: postgres16

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

db_engine_versions

list / elements=string

List of RDS engine versions.

Returned: always

create_time

string

The creation time of the DB engine version.

Returned: success

custom_db_engine_version_manifest

string

JSON string that lists the installation files and parameters that RDS Custom uses to create a custom engine version (CEV).

Returned: success

database_installation_files_s3_bucket_name

string

The name of the Amazon S3 bucket that contains your database installation files.

Returned: success

database_installation_files_s3_prefix

string

The Amazon S3 directory that contains the database installation files.

Returned: success

db_engine_description

string

The description of the database engine.

Returned: success

db_engine_media_type

string

A value that indicates the source media provider of the AMI based on the usage operation.

Returned: success

db_engine_version_arn

string

The ARN of the custom engine version.

Returned: success

db_engine_version_description

string

The description of the database engine version.

Returned: success

db_parameter_group_family

string

The name of the DB parameter group family for the database engine.

Returned: success

default_character_set

dictionary

The default character set for new instances of this engine version.

Returned: success

Sample: {"character_set_description": "Unicode 5.0 UTF-8 Universal character set", "character_set_name": "AL32UTF8"}

engine

string

The name of the database engine.

Returned: success

engine_version

string

The version number of the database engine.

Returned: success

exportable_log_types

list / elements=string

The types of logs that the database engine has available for export to CloudWatch Logs.

Returned: success

image

complex

The EC2 image

Returned: success

image_id

string

A value that indicates the ID of the AMI.

Returned: success

status

string

A value that indicates the status of a custom engine version (CEV).

Returned: success

kms_key_id

string

The Amazon Web Services KMS key identifier for an encrypted CEV.

Returned: success

major_engine_version

string

The major engine version of the CEV.

Returned: success

status

string

The status of the DB engine version, either available or deprecated.

Returned: success

supported_ca_certificate_identifiers

list / elements=string

A list of the supported CA certificate identifiers.

Returned: success

Sample: ["rds-ca-2019", "rds-ca-ecc384-g1", "rds-ca-rsa4096-g1", "rds-ca-rsa2048-g1"]

supported_character_sets

list / elements=dictionary

A list of the character sets supported by this engine for the CharacterSetName parameter of the CreateDBInstance operation.

Returned: success

character_set_description

string

The description of the character set.

Returned: success

character_set_name

string

The name of the character set.

Returned: success

supported_engine_modes

list / elements=string

A list of the supported DB engine modes.

Returned: success

supported_feature_names

list / elements=string

A list of features supported by the DB engine.

Returned: success

Sample: ["Comprehend", "Lambda", "s3Export", "s3Import", "SageMaker"]

supported_nchar_character_sets

list / elements=dictionary

A list of the character sets supported by the Oracle DB engine.

Returned: success

character_set_description

string

The description of the character set.

Returned: success

character_set_name

string

The name of the character set.

Returned: success

supported_timezones

list / elements=dictionary

A list of the time zones supported by this engine for the Timezone parameter of the CreateDBInstance action.

Returned: success

Sample: [{"TimezoneName": "xxx"}]

supports_babelfish

boolean

Indicates whether the engine version supports Babelfish for Aurora PostgreSQL.

Returned: success

supports_certificate_rotation_without_restart

boolean

Indicates whether the engine version supports rotating the server certificate without rebooting the DB instance.

Returned: success

supports_global_databases

boolean

Indicates whether you can use Aurora global databases with a specific DB engine version.

Returned: success

supports_integrations

boolean

Indicates whether the DB engine version supports zero-ETL integrations with Amazon Redshift.

Returned: success

supports_local_write_forwarding

boolean

Indicates whether the DB engine version supports forwarding write operations from reader DB instances to the writer DB instance in the DB cluster.

Returned: success

supports_log_exports_to_cloudwatchLogs

boolean

Indicates whether the engine version supports exporting the log types specified by ExportableLogTypes to CloudWatch Logs.

Returned: success

supports_parallel_query

boolean

Indicates whether you can use Aurora parallel query with a specific DB engine version.

Returned: success

supports_read_replica

boolean

Indicates whether the database engine version supports read replicas.

Returned: success

tags

dictionary

A dictionary of key value pairs.

Returned: success

Sample: {"some": "tag"}

valid_upgrade_target

list / elements=dictionary

A list of engine versions that this database engine version can be upgraded to.

Returned: success

Sample: [{"auto_upgrade": false, "description": "Aurora PostgreSQL (Compatible with PostgreSQL 15.5)", "engine": "aurora-postgresql", "engine_version": "15.5", "is_major_version_upgrade": false, "supported_engine_modes": ["provisioned"], "supports_babelfish": true, "supports_global_databases": true, "supports_integrations": false, "supports_local_write_forwarding": true, "supports_parallel_query": false}]

Authors

  • Aubin Bikouo (@abikouo)