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.

Sign up for GitHub

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 regarding the awsutils provider #151

Closed
wants to merge 5 commits into from
Closed

Docs regarding the awsutils provider #151

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
1ef934e
Update README.yaml
nitrocode Jun 24, 2022
a5721fe
Auto Format
cloudpossebot Jun 24, 2022
16ff6b5
Merge branch 'master' into docs
joe-niland Jul 13, 2022
5c9ded7
Update README.yaml
nitrocode Jul 24, 2022
4af4d27
Auto Format
cloudpossebot Jul 24, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion .github/auto-release.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,6 @@ version-resolver:
- 'bugfix'
- 'bug'
- 'hotfix'
- 'no-release'
default: 'minor'

categories:
Expand Down
18 changes: 16 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -108,6 +108,18 @@ The table below correctly indicates which inputs are required.

Using a [canned ACL](https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html).

NOTE: As of 2.0.2, this module will now require the `awsutils` provider to be defined with a region. This can be the same region as the `aws` provider.

```hcl
provider "aws" {
region = var.region
}

provider "awsutils" {
region = var.region
}
```

```hcl
module "s3_bucket" {
source = "cloudposse/s3-bucket/aws"
Expand Down Expand Up @@ -526,8 +538,8 @@ Check out [our other projects][github], [follow us on twitter][twitter], [apply
### Contributors

<!-- markdownlint-disable -->
| [![Erik Osterman][osterman_avatar]][osterman_homepage]<br/>[Erik Osterman][osterman_homepage] | [![Andriy Knysh][aknysh_avatar]][aknysh_homepage]<br/>[Andriy Knysh][aknysh_homepage] | [![Maxim Mironenko][maximmi_avatar]][maximmi_homepage]<br/>[Maxim Mironenko][maximmi_homepage] | [![Josh Myers][joshmyers_avatar]][joshmyers_homepage]<br/>[Josh Myers][joshmyers_homepage] | [![Yonatan Koren][korenyoni_avatar]][korenyoni_homepage]<br/>[Yonatan Koren][korenyoni_homepage] |
|---|---|---|---|---|
| [![Erik Osterman][osterman_avatar]][osterman_homepage]<br/>[Erik Osterman][osterman_homepage] | [![Andriy Knysh][aknysh_avatar]][aknysh_homepage]<br/>[Andriy Knysh][aknysh_homepage] | [![Maxim Mironenko][maximmi_avatar]][maximmi_homepage]<br/>[Maxim Mironenko][maximmi_homepage] | [![Josh Myers][joshmyers_avatar]][joshmyers_homepage]<br/>[Josh Myers][joshmyers_homepage] | [![Yonatan Koren][korenyoni_avatar]][korenyoni_homepage]<br/>[Yonatan Koren][korenyoni_homepage] | [![RB][nitrocode_avatar]][nitrocode_homepage]<br/>[RB][nitrocode_homepage] |
|---|---|---|---|---|---|
<!-- markdownlint-restore -->

[osterman_homepage]: https://github.com/osterman
Expand All @@ -540,6 +552,8 @@ Check out [our other projects][github], [follow us on twitter][twitter], [apply
[joshmyers_avatar]: https://img.cloudposse.com/150x150/https://github.com/joshmyers.png
[korenyoni_homepage]: https://github.com/korenyoni
[korenyoni_avatar]: https://img.cloudposse.com/150x150/https://github.com/korenyoni.png
[nitrocode_homepage]: https://github.com/nitrocode
[nitrocode_avatar]: https://img.cloudposse.com/150x150/https://github.com/nitrocode.png

[![README Footer][readme_footer_img]][readme_footer_link]
[![Beacon][beacon]][website]
Expand Down
14 changes: 14 additions & 0 deletions README.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -85,6 +85,18 @@ description: |-
usage: |-
Using a [canned ACL](https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html).

NOTE: As of 2.0.2, this module will now require the `awsutils` provider to be defined with a region. This can be the same region as the `aws` provider.

```hcl
provider "aws" {
region = var.region
}

provider "awsutils" {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also worth mentioning awsutils has to be included in required_providers ?

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should it be included in required_providers in this module? If so, no-release PR tag should be removed.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Once region is optional in the awsutils provider (like it is for the aws provider) then the provider won't need to be explicitly set, no?

region = var.region
}
```

```hcl
module "s3_bucket" {
source = "cloudposse/s3-bucket/aws"
Expand Down Expand Up @@ -223,3 +235,5 @@ contributors:
github: "joshmyers"
- name: "Yonatan Koren"
github: "korenyoni"
- name: "RB"
github: "nitrocode"