Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Clarify Performance Insights documentation for cluster and instance level configuration #479

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

yuto-ohta
Copy link

Description

This PR updates the documentation to clarify Performance Insights configuration at both cluster and instance levels. It follows the recent documentation improvements made in terraform-provider-aws (#40704).

Specifically, this PR:

  • Updates cluster_performance_insights_enabled documentation to remove incorrect limitation about Non-Aurora Multi-AZ DB Clusters
  • Clarifies the relationship between cluster-level and instance-level Performance Insights configuration in performance_insights_enabled documentation

Motivation and Context

The documentation previously implied Performance Insights was only available for Non-Aurora Multi-AZ DB Clusters, which is incorrect. This update aligns our documentation with the actual AWS capabilities and the recent documentation improvements in the AWS provider.

Related terraform-provider-aws PR: hashicorp/terraform-provider-aws#40704

Breaking Changes

No breaking changes. This is a documentation-only update.

How Has This Been Tested?

  • I have manually tested and confirmed that setting cluster_performance_insights_enabled successfully enables cluster-level Performance Insights when creating an Aurora cluster through this module
  • I have executed pre-commit run -a on my pull request

@yuto-ohta yuto-ohta changed the title docs: clarify Performance Insights documentation for cluster and instance level configuration docs: Clarify Performance Insights documentation for cluster and instance level configuration Dec 28, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant