UPD: improved README
This commit is contained in:
parent
f061b0dc8d
commit
c3d8b0a030
@ -1,12 +1,21 @@
|
||||
# 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
|
||||
* awscli
|
||||
* 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
|
||||
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
|
||||
{
|
||||
|
Loading…
Reference in New Issue
Block a user