db_recommendations

Creates, updates, deletes, gets or lists a db_recommendations resource.

Overview

Name	db_recommendations
Type	Resource
Id	aws.rds.db_recommendations

Fields

The following fields are returned by SELECT queries:

describe_db_recommendations

Name	Datatype	Description
additional_info	string	Additional information about the recommendation. The information might contain markdown.
category	string	The category of the recommendation. Valid values: performance efficiency security reliability cost optimization operational excellence sustainability
created_time	string	The time when the recommendation was created. For example, 2023-09-28T01:13:53.931000+00:00.
description	string	A detailed description of the recommendation. The description might contain markdown.
detection	string	A short description of the issue identified for this recommendation. The description might contain markdown.
impact	string	A short description that explains the possible impact of an issue.
issue_details	string	Details of the issue that caused the recommendation.
links	string	A link to documentation that provides additional information about the recommendation.
reason	string	The reason why this recommendation was created. The information might contain markdown.
recommendation	string	A short description of the recommendation to resolve an issue. The description might contain markdown.
recommendation_id	string	The unique identifier of the recommendation.
recommended_actions	string	A list of recommended actions.
resource_arn	string	The Amazon Resource Name (ARN) of the RDS resource associated with the recommendation.
severity	string	The severity level of the recommendation. The severity level can help you decide the urgency with which to address the recommendation. Valid values: high medium low informational
source	string	The Amazon Web Services service that generated the recommendations.
status	string	The current status of the recommendation. Valid values: active - The recommendations which are ready for you to apply. pending - The applied or scheduled recommendations which are in progress. resolved - The recommendations which are completed. dismissed - The recommendations that you dismissed.
type_detection	string	A short description of the recommendation type. The description might contain markdown.
type_id	string	A value that indicates the type of recommendation. This value determines how the description is rendered.
type_recommendation	string	A short description that summarizes the recommendation to fix all the issues of the recommendation type. The description might contain markdown.
updated_time	string	The time when the recommendation was last updated.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_db_recommendations	select	region	LastUpdatedAfter, LastUpdatedBefore, Locale, Filters, MaxRecords, Marker	Describes the recommendations to resolve the issues for your DB instances, DB clusters, and DB parameter groups.
modify_db_recommendation	update	RecommendationId, region	Locale, Status, RecommendedActionUpdates	Updates the recommendation status and recommended action status for the specified recommendation.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
RecommendationId	string	The identifier of the recommendation to update.
region	string	AWS region (default: us-east-1)
Filters	array	A filter that specifies one or more recommendations to describe. Supported Filters: recommendation-id - Accepts a list of recommendation identifiers. The results list only includes the recommendations whose identifier is one of the specified filter values. status - Accepts a list of recommendation statuses. Valid values: active - The recommendations which are ready for you to apply. pending - The applied or scheduled recommendations which are in progress. resolved - The recommendations which are completed. dismissed - The recommendations that you dismissed. The results list only includes the recommendations whose status is one of the specified filter values. severity - Accepts a list of recommendation severities. The results list only includes the recommendations whose severity is one of the specified filter values. Valid values: high medium low informational type-id - Accepts a list of recommendation type identifiers. The results list only includes the recommendations whose type is one of the specified filter values. dbi-resource-id - Accepts a list of database resource identifiers. The results list only includes the recommendations that generated for the specified databases. cluster-resource-id - Accepts a list of cluster resource identifiers. The results list only includes the recommendations that generated for the specified clusters. pg-arn - Accepts a list of parameter group ARNs. The results list only includes the recommendations that generated for the specified parameter groups. cluster-pg-arn - Accepts a list of cluster parameter group ARNs. The results list only includes the recommendations that generated for the specified cluster parameter groups.
LastUpdatedAfter	string (date-time)	A filter to include only the recommendations that were updated after this specified time.
LastUpdatedBefore	string (date-time)	A filter to include only the recommendations that were updated before this specified time.
Locale	string	The language of the modified recommendation.
Marker	string	An optional pagination token provided by a previous DescribeDBRecommendations request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
MaxRecords	integer	The maximum number of recommendations to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.
RecommendedActionUpdates	array	The list of recommended action status to update. You can update multiple recommended actions at one time.
Status	string	The recommendation status to update. Valid values: active dismissed

SELECT examples

describe_db_recommendations

Describes the recommendations to resolve the issues for your DB instances, DB clusters, and DB parameter groups.

SELECT
additional_info,
category,
created_time,
description,
detection,
impact,
issue_details,
links,
reason,
recommendation,
recommendation_id,
recommended_actions,
resource_arn,
severity,
source,
status,
type_detection,
type_id,
type_recommendation,
updated_time
FROM aws.rds.db_recommendations
WHERE region = '{{ region }}' -- required
AND LastUpdatedAfter = '{{ LastUpdatedAfter }}'
AND LastUpdatedBefore = '{{ LastUpdatedBefore }}'
AND Locale = '{{ Locale }}'
AND Filters = '{{ Filters }}'
AND MaxRecords = '{{ MaxRecords }}'
AND Marker = '{{ Marker }}'
;

UPDATE examples

modify_db_recommendation

Updates the recommendation status and recommended action status for the specified recommendation.

UPDATE aws.rds.db_recommendations
SET 
-- No updatable properties
WHERE 
RecommendationId = '{{ RecommendationId }}' --required
AND region = '{{ region }}' --required
AND Locale = '{{ Locale}}'
AND Status = '{{ Status}}'
AND RecommendedActionUpdates = '{{ RecommendedActionUpdates}}'
RETURNING
additional_info,
category,
created_time,
description,
detection,
impact,
issue_details,
links,
reason,
recommendation,
recommendation_id,
recommended_actions,
resource_arn,
severity,
source,
status,
type_detection,
type_id,
type_recommendation,
updated_time;