Skip to content

Commit 1308988

Browse files
committed
update readme
1 parent 8861d98 commit 1308988

File tree

3 files changed

+24
-0
lines changed

3 files changed

+24
-0
lines changed

.header.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,12 +10,19 @@ Integrate Amazon Bedrock to your HashiCorp Cloud Platform Terraform (Terraform C
1010

1111
### Terraform plan summary
1212

13+
Summarize Terraform plan output in plain human language.
1314
![Example](./images/example.png)
1415

1516
### Function calling (AMI analysis)
1617

18+
Use function calling to execute other tools, such as analyzing AMI data.
1719
![Example2](./images/example2.png)
1820

21+
### Bedrock guardrail
22+
23+
Implement safeguards customized to your organization requirements and responsible AI policies
24+
![Example3](./images/example3.png)
25+
1926
## Architecture
2027

2128
![Diagram](./images/arch.png)
@@ -29,6 +36,7 @@ Please refer to the [best-practice](#best-practice) section below for more detai
2936
To use this module you need have the following:
3037

3138
1. AWS account and credentials
39+
1. Amazon Bedrock model access (default model is `Claude 3 Sonnet`)
3240
1. HCP Terraform account
3341

3442
## Usage
@@ -39,6 +47,8 @@ To use this module you need have the following:
3947
make all
4048
```
4149

50+
* Enable Bedrock model access for `Claude 3 Sonnet`. Refer to [this guide for more info](https://docs.aws.amazon.com/bedrock/latest/userguide/model-access.html).
51+
4252
* Reference the `examples/basic` folder on how to use this module
4353

4454
```sh
@@ -57,3 +67,5 @@ To use this module you need have the following:
5767
* Enable the AWS WAF setup by setting variable `deploy_waf` to `true` (additional cost will apply). This will add WAF protection to the Run Tasks URL endpoint.
5868

5969
* We recommend you to setup additional CloudWatch alarm to monitor Lambda concurrency and WAF rules.
70+
71+
* We recommend to add additional topic to the Bedrock Guardrail to fit your organization requirements.

README.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,12 +11,19 @@ Integrate Amazon Bedrock to your HashiCorp Cloud Platform Terraform (Terraform C
1111

1212
### Terraform plan summary
1313

14+
Summarize Terraform plan output in plain human language.
1415
![Example](./images/example.png)
1516

1617
### Function calling (AMI analysis)
1718

19+
Use function calling to execute other tools, such as analyzing AMI data.
1820
![Example2](./images/example2.png)
1921

22+
### Bedrock guardrail
23+
24+
Implement safeguards customized to your organization requirements and responsible AI policies
25+
![Example3](./images/example3.png)
26+
2027
## Architecture
2128

2229
![Diagram](./images/arch.png)
@@ -30,6 +37,7 @@ Please refer to the [best-practice](#best-practice) section below for more detai
3037
To use this module you need have the following:
3138

3239
1. AWS account and credentials
40+
1. Amazon Bedrock model access (default model is `Claude 3 Sonnet`)
3341
1. HCP Terraform account
3442

3543
## Usage
@@ -40,6 +48,8 @@ To use this module you need have the following:
4048
make all
4149
```
4250

51+
* Enable Bedrock model access for `Claude 3 Sonnet`. Refer to [this guide for more info](https://docs.aws.amazon.com/bedrock/latest/userguide/model-access.html).
52+
4353
* Reference the `examples/basic` folder on how to use this module
4454

4555
```sh
@@ -59,6 +69,8 @@ To use this module you need have the following:
5969

6070
* We recommend you to setup additional CloudWatch alarm to monitor Lambda concurrency and WAF rules.
6171

72+
* We recommend to add additional topic to the Bedrock Guardrail to fit your organization requirements.
73+
6274
## Requirements
6375

6476
| Name | Version |

images/example3.png

51 KB
Loading

0 commit comments

Comments
 (0)