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

Document AWS_SDK_LOAD_CONFIG on aws provider #8451

Merged
merged 1 commit into from
Jun 7, 2019
Merged

Document AWS_SDK_LOAD_CONFIG on aws provider #8451

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
3 changes: 3 additions & 0 deletions website/docs/index.html.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -101,6 +101,9 @@ provider "aws" {
}
```

If specifying the profile through the `AWS_PROFILE` environment variable, you
must also set `AWS_SDK_LOAD_CONFIG` to a truthy value, e.g. `AWS_SDK_LOAD_CONFIG=1`
Copy link
Contributor

Choose a reason for hiding this comment

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

The wording of "must" here is overly strong, since AWS_PROFILE can successfully be used today in situations without AWS_SDK_LOAD_CONFIG. For example, the usage of only the AWS_PROFILE environment variable, works when the credentials are in a credentials file and the profile does not have any advanced configurations, such as: https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html

See also: #8779 (comment)

My recommendation would be to call out specific usages that require the additional environment variable, e.g.

Suggested change
must also set `AWS_SDK_LOAD_CONFIG` to a truthy value, e.g. `AWS_SDK_LOAD_CONFIG=1`
may also need to set `AWS_SDK_LOAD_CONFIG` to a truthy value (e.g. `AWS_SDK_LOAD_CONFIG=1`) for advanced AWS client configurations, such as profiles that use the `source_profile` or `role_arn` configurations.


### ECS and CodeBuild Task Roles

If you're running Terraform on ECS or CodeBuild and you have configured an [IAM Task Role](http://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-iam-roles.html),
Expand Down