Skip to content

Commit

Permalink
Merge pull request #4 from Traceableai/jacob
Browse files Browse the repository at this point in the history
feat: updating readme
  • Loading branch information
varkey98 authored May 7, 2024
2 parents e5d40b3 + 3e7301d commit c8aafd0
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 3 deletions.
16 changes: 14 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,8 @@ The AWS-API-Gateway-Resource Provider is a plugin for Terraform that allows work
For a more comprehensive explanation see [awsapigateway_resource](./docs/resources/awsapigateway_resource.md) documentation.

## Usage

The first example will track all apis defined by the cross account role arn `test-arn-1` except for the api with id `api1`.
The second example will only track apis with id `api1` and `api2` from the account where the deployment is made
```hcl
terraform {
required_providers {
Expand All @@ -16,10 +17,21 @@ terraform {
}
}
resource "awsapigateway_resouce" "traceable-example-1" {
identifier = uuid()
ignore_access_log_settings = false
accounts {
region = "us-east-2"
api_list = ["api1"]
cross_account_role_arn = "test-arn-1"
exclude = true
}
}
resource "awsapigateway_resouce" "traceable-example-2" {
identifier = uuid()
ignore_access_log_settings = false
account {
accounts {
region = "us-east-1"
api_list = ["api1", "api2"]
cross_account_role_arn = ""
Expand Down
2 changes: 1 addition & 1 deletion examples/default/main.tf
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ resource "awsapigateway_resource" "traceable-example-1" {
resource "awsapigateway_resouce" "traceable-example-2" {
identifier = uuid()
ignore_access_log_settings = false
account {
accounts {
region = "us-east-1"
api_list = ["api1", "api2"]
cross_account_role_arn = ""
Expand Down

0 comments on commit c8aafd0

Please sign in to comment.