Skip to content

Commit ab9bb1d

Browse files
committed
feat: mark module as deprecated and add deprecation warning output
1 parent 4839fc7 commit ab9bb1d

File tree

2 files changed

+15
-2
lines changed

2 files changed

+15
-2
lines changed

README.md

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,13 @@
1-
# AWS AutoMQ BYOC Environment Terrafrom module
2-
![General_Availability](https://img.shields.io/badge/Lifecycle_Stage-General_Availability(GA)-green?style=flat&logoColor=8A3BE2&labelColor=rgba)
1+
# ⚠️ DEPRECATED
2+
3+
> [!CAUTION]
4+
> **This module is deprecated and no longer maintained.**
5+
>
6+
> Please use the new deployment approach: **[AutoMQ BYOC Setup Guide](https://docs.automq.com/automq-cloud/getting-started/install-byoc-environment)**
7+
8+
---
9+
10+
![Deprecated](https://img.shields.io/badge/Lifecycle_Stage-Deprecated-red?style=flat&logoColor=8A3BE2&labelColor=rgba)
311

412
This module is designed for deploying the AutoMQ BYOC (Bring Your Own Cloud) environment using the AWS Provider within an AWS cloud environment.
513

outputs.tf

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
output "deprecation_warning" {
2+
description = "IMPORTANT: This module is deprecated and no longer maintained."
3+
value = "⚠️ DEPRECATED: This module is no longer maintained. Please migrate to: https://docs.automq.com/automq-cloud/getting-started/install-byoc-environment"
4+
}
5+
16
output "automq_byoc_env_id" {
27
description = "This parameter is used to create resources within the environment. Additionally, all cloud resource names will incorporate this parameter as part of their names. This parameter supports only numbers, uppercase and lowercase English letters, and hyphens. It must start with a letter and is limited to a length of 32 characters."
38
value = var.automq_byoc_env_id

0 commit comments

Comments
 (0)