Skip to content

Commit

Permalink
Merge pull request #87 from Cox-Automotive/updateReadme
Browse files Browse the repository at this point in the history
Update Docs
  • Loading branch information
amagana3 authored Jul 22, 2020
2 parents d25081e + 32680a5 commit 34ba8e1
Showing 1 changed file with 22 additions and 6 deletions.
28 changes: 22 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ This module is used for creating IAM Roles via the ALKS API.
For example on macOS:

```
curl -L https://github.com/Cox-Automotive/terraform-provider-alks/releases/download/1.4.2/terraform-provider-alks-darwin-amd64.tar.gz | tar zxv
curl -L https://github.com/Cox-Automotive/terraform-provider-alks/releases/download/1.4.3/terraform-provider-alks-darwin-amd64.tar.gz | tar zxv
```

* Configure Terraform to use this plugin by placing the binary in `.terraform.d/plugins/` on MacOS/Linux or `terraform.d\plugins\` in your user's "Application Data" directory on Windows.
Expand All @@ -41,7 +41,7 @@ Static credentials can be provided via an `access_key`, `secret_key` and `token`
```tf
provider "alks" {
url = "https://alks.foo.com/rest"
version = "~> 1.4.0"
version = "~> 1.4.3"
access_key = "accesskey"
secret_key = "secretkey"
token = "sessiontoken"
Expand All @@ -55,7 +55,7 @@ You can provide your credentials via the `AWS_ACCESS_KEY_ID`, `AWS_SECRET_ACCESS
```tf
provider "alks" {
url = "https://alks.foo.com/rest"
version = "~> 1.4.0"
version = "~> 1.4.3"
}
```

Expand All @@ -74,7 +74,7 @@ You can use an AWS credentials file to specify your credentials. The default loc
```tf
provider "alks" {
url = "https://alks.foo.com/rest"
version = "~> 1.4.0"
version = "~> 1.4.3"
shared_credentials_file = "/Users/brianantonelli/.aws/credentials"
profile = "foo"
}
Expand All @@ -93,7 +93,7 @@ Your ALKS provider block can look just like this:
```tf
provider "alks" {
url = "https://alks.foo.com/rest"
version = "~> 1.4.0"
version = "~> 1.4.3"
}
```

Expand All @@ -102,7 +102,7 @@ Since Machine Identities work with Instance Profile Metadata directly, it can be
```tf
provider "alks" {
url = "https://alks.foo.com/rest"
version = "~> 1.4.0"
version = "~> 1.4.3"
assume_role {
role_arn = "arn:aws:iam::112233445566:role/acct-managed/JenkinsPRODAccountTrust"
}
Expand Down Expand Up @@ -170,6 +170,22 @@ Value | Type | Forces New | Value Type | Descrip
`ip_arn` | Computed | n/a | string | If `role_added_to_ip` was `true` this will provide the ARN of the instance profile role.
`enable_alks_access` | Optional | yes | bool | If `true`, allows ALKS calls to be made by instance profiles or Lambda functions making use of this role.

### `alks_ltk`

```tf
resource "alks_ltk" "test_ltk_user" {
iam_username = "My_LTK_User_Name"
}
```

Value | Type | Forces New | Value Type | Description
--------------------------------- | -------- | ---------- | ---------- | -----------
`iam_username` | Required | yes | string | The name of the IAM user to create. This parameter allows a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-. User names are not distinguished by case.
`iam_user_arn` | Computed | n/a | string | The ARN associated with the LTK user.
`access_key` | Computed | n/a | string | Generated access key for the LTK user. Note: This is saved in the state file, so please be aware of this.
`secret_key` | Computed | n/a | string | Generated secret key for the LTK user. Note: This is saved in the state file, so please be aware of this.


## Example

See [this example](examples/alks.tf) for a basic Terraform script which:
Expand Down

0 comments on commit 34ba8e1

Please sign in to comment.