Skip to content

Commit 55049da

Browse files
committed
feat: update readme
1 parent 870c488 commit 55049da

File tree

1 file changed

+20
-11
lines changed

1 file changed

+20
-11
lines changed

README.md

Lines changed: 20 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -81,20 +81,29 @@ No requirements.
8181

8282
| Name | Source | Version |
8383
|------|--------|---------|
84-
| <a name="module_automq_byoc_data_bucket_name"></a> [automq_byoc_data_bucket_name](#module_automq_byoc_data_bucket_name) | terraform-aws-modules/s3-bucket/aws | 4.1.2 |
85-
| <a name="module_automq_byoc_ops_bucket_name"></a> [automq_byoc_ops_bucket_name](#module_automq_byoc_ops_bucket_name) | terraform-aws-modules/s3-bucket/aws | 4.1.2 |
86-
| <a name="module_automq_byoc_vpc"></a> [automq_byoc_vpc](#module_automq_byoc_vpc) | terraform-aws-modules/vpc/aws | 5.0.0 |
87-
| <a name="module_automq_byoc"></a> [automq_byoc](#module_automq_byoc) | ./modules/aws-console-module | 0.1.0 |
84+
| <a name="module_automq_byoc_data_bucket_name"></a> [automq_byoc_data_bucket_name](#module_automq_byoc_data_bucket_name) | terraform-aws-modules/s3-bucket/aws | 4.1.2 |
85+
| <a name="module_automq_byoc_ops_bucket_name"></a> [automq_byoc_ops_bucket_name](#module_automq_byoc_ops_bucket_name) | terraform-aws-modules/s3-bucket/aws | 4.1.2 |
86+
| <a name="module_automq_byoc_vpc"></a> [automq_byoc_vpc](#module_automq_byoc_vpc) | terraform-aws-modules/vpc/aws | 5.0.0 |
8887

8988
## Resources
9089

9190
| Name | Type |
9291
|------|------|
93-
| [aws_eip.nat](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/eip) | resource |
94-
| [aws_security_group.endpoint_sg](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/security_group) | resource |
95-
| [aws_vpc_endpoint.ec2](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/vpc_endpoint) | resource |
96-
| [aws_vpc_endpoint.s3](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/vpc_endpoint) | resource |
97-
| [aws_availability_zones.available](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/availability_zones) | data source |
92+
| [aws_eip.web_ip](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/eip) | resource |
93+
| [aws_iam_instance_profile.automq_byoc_instance_profile](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_instance_profile) | resource |
94+
| [aws_iam_policy.automq_byoc_policy](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_policy) | resource |
95+
| [aws_iam_role.automq_byoc_role](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_role) | resource |
96+
| [aws_iam_role_policy_attachment.automq_byoc_role_attachment](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_role_policy_attachment) | resource |
97+
| [aws_instance.automq_byoc_console](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/instance) | resource |
98+
| [aws_route53_zone.private_r53](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/route53_zone) | resource |
99+
| [aws_security_group.automq_byoc_console_sg](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/security_group) | resource |
100+
| [aws_security_group.vpc_endpoint_sg](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/security_group) | resource |
101+
| [aws_vpc_endpoint.ec2_endpoint](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/vpc_endpoint) | resource |
102+
| [aws_vpc_endpoint.s3_endpoint](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/vpc_endpoint) | resource |
103+
| [aws_ami.marketplace_ami_details](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/ami) | data source |
104+
| [aws_availability_zones.available_azs](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/availability_zones) | data source |
105+
| [aws_ssm_parameter.marketplace_ami](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/ssm_parameter) | data source |
106+
| [aws_vpc.vpc_id](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/vpc) | data source |
98107

99108
## Inputs
100109

@@ -108,7 +117,7 @@ No requirements.
108117
| <a name="input_automq_byoc_env_console_cidr"></a> [automq_byoc_env_console_cidr](#input_automq_byoc_env_console_cidr) | Set CIDR block to restrict the source IP address range for accessing the AutoMQ environment console. If not set, the default is 0.0.0.0/0. | `string` | `"0.0.0.0/0"` | no |
109118
| <a name="input_automq_byoc_data_bucket_name"></a> [automq_byoc_data_bucket_name](#input_automq_byoc_data_bucket_name) | Set the existed S3 bucket used to store message data generated by applications. If this parameter is not set, a new S3 bucket will be automatically created. The message data Bucket must be separate from the Ops Bucket. | `string` | `""` | no |
110119
| <a name="input_automq_byoc_ops_bucket_name"></a> [automq_byoc_ops_bucket_name](#input_automq_byoc_ops_bucket_name) | Set the existed S3 bucket used to store AutoMQ system logs and metrics data for system monitoring and alerts. If this parameter is not set, a new S3 bucket will be automatically created. This Bucket does not contain any application business data. The Ops Bucket must be separate from the message data Bucket. | `string` | `""` | no |
111-
| <a name="input_automq_byoc_ec2_instance_type"></a> [automq_byoc_ec2_instance_type](#input_automq_byoc_ec2_instance_type) | Set the EC2 instance type; this parameter is used only for deploying the AutoMQ environment console. You need to provide an EC2 instance type with at least 2 cores and 8 GB of memory. | `string` | `"m5d.large"` | no |
120+
| <a name="input_automq_byoc_ec2_instance_type"></a> [automq_byoc_ec2_instance_type](#input_automq_byoc_ec2_instance_type) | Set the EC2 instance type; this parameter is used only for deploying the AutoMQ environment console. You need to provide an EC2 instance type with at least 2 cores and 8 GB of memory. | `string` | `"t3.large"` | no |
112121
| <a name="input_automq_byoc_env_version"></a> [automq_byoc_env_version](#input_automq_byoc_env_version) | Set the version for the AutoMQ BYOC environment console. It is recommended to keep the default value, which is the latest version. Historical release note reference [document](https://docs.automq.com/automq-cloud/release-notes). | `string` | `"latest"` | no |
113122
| <a name="input_specified_ami_by_marketplace"></a> [specified_ami_by_marketplace](#input_specified_ami_by_marketplace) | The parameter defaults to true, which means the AMI will be obtained from AWS Marketplace. If you wish to use a custom AMI, set this parameter to false and specify the `automq_byoc_env_console_ami` parameter with your custom AMI ID. | `bool` | `true` | no |
114123
| <a name="input_automq_byoc_env_console_ami"></a> [automq_byoc_env_console_ami](#input_automq_byoc_env_console_ami) | When parameter `specified_ami_by_marketplace` set to false, this parameter must set a custom AMI to deploy automq console. | `string` | `""` | no |
@@ -117,7 +126,7 @@ No requirements.
117126

118127
| Name | Description |
119128
|------|-------------|
120-
| <a name="output_automq_byoc_env_id"></a> [automq_byoc_env_id](#output_automq_byoc_env_id) | 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. |
129+
| <a name="output_automq_byoc_env_id"></a> [automq_byoc_env_id](#output_automq_byoc_env_id) | 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. |
121130
| <a name="output_automq_byoc_endpoint"></a> [automq_byoc_endpoint](#output_automq_byoc_endpoint) | The endpoint for the AutoMQ environment console. Users can set this endpoint to the AutoMQ Terraform Provider to manage resources through Terraform. Additionally, users can access this endpoint via web browser, log in, and manage resources within the environment using the WebUI. |
122131
| <a name="output_automq_byoc_initial_username"></a> [automq_byoc_initial_username](#output_automq_byoc_initial_username) | The initial username for the AutoMQ environment console. It has the `EnvironmentAdmin` role permissions. This account is used to log in to the environment, create ServiceAccounts, and manage other resources. For detailed information about environment members, please refer to the [documentation](https://docs.automq.com/automq-cloud/manage-identities-and-access/member-accounts). |
123132
| <a name="output_automq_byoc_initial_password"></a> [automq_byoc_initial_password](#output_automq_byoc_initial_password) | The initial password for the AutoMQ environment console. This account is used to log in to the environment, create ServiceAccounts, and manage other resources. For detailed information about environment members, please refer to the [documentation](https://docs.automq.com/automq-cloud/manage-identities-and-access/member-accounts). |

0 commit comments

Comments
 (0)