UPD: improved README

This commit is contained in:
xpk 2023-07-03 08:32:09 +08:00
parent f061b0dc8d
commit c3d8b0a030
Signed by: xpk
GPG Key ID: CD4FF6793F09AB86

View File

@ -1,12 +1,21 @@
# assume_role module # assume_role module
This module calls sts and run assume role. Returns the temp credential as a map. This module uses awscli, calls sts and obtain temp credentials for role switching. Returns the temp credential as a map.
## System requirements ## System requirements
* awscli * awscli
* jq * jq
## Inputs
| variable | type | required | description |
|:------------------|--------|----------|----------------------------------------------------------------------------|
| account_id | string | yes | target aws account id |
| role_name | string | yes | target role name |
| role_session_name | string | no | session name, useful for tracing logs in cloudtrail. defaults to tf_awscli |
## Outputs ## Outputs
temp_credential: A map of strings returned by awscli. Variable is sensitive. | variable | type | sensitive | description |
|-----------------|---------------|-----------|-------------------------|
| temp_credential | map of string | yes | json output from awscli |
```json ```json
{ {