rds_database_recommendations
Creates, updates, deletes, gets or lists a rds_database_recommendations resource.
Overview
| Name | rds_database_recommendations |
| Type | Resource |
| Id | aws.compute_optimizer.rds_database_recommendations |
Fields
The following fields are returned by SELECT queries:
- get_rds_database_recommendations
| Name | Datatype | Description |
|---|---|---|
errors | array | An array of objects that describe errors of the request. |
next_token | string | The token to advance to the next page of Amazon Aurora and RDS database recommendations. |
rds_db_recommendations | array | An array of objects that describe the Amazon Aurora and RDS database recommendations. |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get_rds_database_recommendations | select | region | Returns Amazon Aurora and RDS database recommendations. Compute Optimizer generates recommendations for Amazon Aurora and RDS databases that meet a specific set of requirements. For more information, see the Supported resources and requirements in the Compute Optimizer User Guide. | |
export_rds_database_recommendations | exec | region, s3DestinationConfig | Export optimization recommendations for your Amazon Aurora and Amazon Relational Database Service (Amazon RDS) databases. Recommendations are exported in a comma-separated values (CSV) file, and its metadata in a JavaScript Object Notation (JSON) file, to an existing Amazon Simple Storage Service (Amazon S3) bucket that you specify. For more information, see Exporting Recommendations in the Compute Optimizer User Guide. You can have only one Amazon Aurora or RDS export job in progress per Amazon Web Services Region. |
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 |
|---|---|---|
region | string | AWS region (default: us-east-1) |
SELECT examples
- get_rds_database_recommendations
Returns Amazon Aurora and RDS database recommendations. Compute Optimizer generates recommendations for Amazon Aurora and RDS databases that meet a specific set of requirements. For more information, see the Supported resources and requirements in the Compute Optimizer User Guide.
SELECT
errors,
next_token,
rds_db_recommendations
FROM aws.compute_optimizer.rds_database_recommendations
WHERE region = '{{ region }}' -- required
;
Lifecycle Methods
- export_rds_database_recommendations
Export optimization recommendations for your Amazon Aurora and Amazon Relational Database Service (Amazon RDS) databases. Recommendations are exported in a comma-separated values (CSV) file, and its metadata in a JavaScript Object Notation (JSON) file, to an existing Amazon Simple Storage Service (Amazon S3) bucket that you specify. For more information, see Exporting Recommendations in the Compute Optimizer User Guide. You can have only one Amazon Aurora or RDS export job in progress per Amazon Web Services Region.
EXEC aws.compute_optimizer.rds_database_recommendations.export_rds_database_recommendations
@region='{{ region }}' --required
@@json=
'{
"accountIds": "{{ accountIds }}",
"filters": "{{ filters }}",
"fieldsToExport": "{{ fieldsToExport }}",
"s3DestinationConfig": "{{ s3DestinationConfig }}",
"fileFormat": "{{ fileFormat }}",
"includeMemberAccounts": {{ includeMemberAccounts }},
"recommendationPreferences": "{{ recommendationPreferences }}"
}'
;