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.

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

Backend s3 new assume_role argument change, role_arn was previously not required #35142

Open
tonglil opened this issue May 9, 2024 · 1 comment
Labels
backend/s3 documentation new new issue not yet triaged

Comments

@tonglil
Copy link

tonglil commented May 9, 2024

Terraform Version

1.8.3

Affected Pages

https://developer.hashicorp.com/terraform/language/settings/backends/s3#assume-role-configuration

What is the docs issue?

role_arn use to be optional, but is now made required when updating to the new nested syntax.

role_arn - (Required) Amazon Resource Name (ARN) of the IAM Role to assume.

role_arn - (Optional) Amazon Resource Name (ARN) of the IAM Role to assume. Use assume_role.role_arn instead.

Why is this so, when it use to be possible to just specify session_name? How do I migrate from the deprecated parameter without knowing the role_arn to specify?

session_name - (Optional) Session name to use when assuming the role. Use assume_role.session_name instead.

No changes. Your infrastructure matches the configuration.

Terraform has compared your real infrastructure against your configuration
and found no differences, so no changes are needed.
╷
│ Warning: Deprecated Parameters
│ 
│   with data.terraform_remote_state.baseline,
│   on backend.tf line 13, in data "terraform_remote_state" "baseline":
│   13: data "terraform_remote_state" "baseline" {
│ 
│ The following parameters have been deprecated. Replace them as follows:
│   * session_name -> assume_role.session_name
│ 
│ 
│ (and 2 more similar warnings elsewhere)

Proposal

Allow role_arn to be optional in the nested argument format.

References

@tonglil tonglil added documentation new new issue not yet triaged labels May 9, 2024
@crw
Copy link
Collaborator

crw commented May 9, 2024

Thanks for this request!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backend/s3 documentation new new issue not yet triaged
Projects
None yet
Development

No branches or pull requests

3 participants