Compare commits
1
Commits
main
...
readme-updates
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
4c4a901d33 |
No files matched your search
@@ -25,6 +25,8 @@ Credential rotation can be turned off by setting the
|
||||
This plugin will attempt to assume a role when a `role_arn` is supplied through the
|
||||
`attributes` object. More information about assume an AWS role can be found [here](https://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRole.html). This feature only works when the plugin is running on a self managed Boundary [worker](https://developer.hashicorp.com/boundary/tutorials/hcp-administration/hcp-manage-workers).
|
||||
|
||||
To discover hosts across multiple AWS accounts, supply a `target_role_arn` in addition to `role_arn`. The plugin uses the principal credentials to assume the target role via a two-hop `AssumeRole` chain, enabling cross-account host discovery from a single worker. See [Attributes and Secrets](plugin/service/host/README.md#attributes-and-secrets) for the full list of `target_*` attributes.
|
||||
|
||||
### Environment Credentials
|
||||
|
||||
This plugin will attempt to retrieve credentials from environment variables. More
|
||||
|
||||
@@ -109,13 +109,23 @@ The following `attributes` are valid on an AWS host catalog resource:
|
||||
- `region` (string): The region to configure the host catalog for. All host sets
|
||||
in this catalog will be configured for this region.
|
||||
- `role_arn` (string): The AWS Role ARN used for `AssumeRole` authentication. If
|
||||
provided, `disable_credential_rotation` must be also set to `true.
|
||||
- `role_external_id` (string): The external id configured for the `AssumeRole`
|
||||
provided, `disable_credential_rotation` must be also set to `true`.
|
||||
- `role_external_id` (string): The external ID configured for the principal `AssumeRole`
|
||||
provider.
|
||||
- `role_session_name` (string): The session name configured for the `AssumeRole`
|
||||
- `role_session_name` (string): The session name configured for the principal `AssumeRole`
|
||||
provider.
|
||||
- `role_tags` (object): The key-value pair tags configured for the `AssumeRole`
|
||||
- `role_tags` (object): The key-value pair tags configured for the principal `AssumeRole`
|
||||
provider.
|
||||
- `target_role_arn` (string): The AWS role ARN of the target IAM role to assume for
|
||||
cross-account discovery. Required if any other `target_*` attributes are configured.
|
||||
- `target_region` (string): The region where the target hosts reside. Defaults to the
|
||||
principal account `region` if omitted.
|
||||
- `target_role_external_id` (string): The external ID configured for the target
|
||||
`AssumeRole` provider.
|
||||
- `target_role_session_name` (string): The session name configured for the target
|
||||
`AssumeRole` provider.
|
||||
- `target_role_tags` (object): The key-value pair tags configured for the target
|
||||
`AssumeRole` provider.
|
||||
|
||||
The following `secrets` are required on an AWS host catalog resource:
|
||||
|
||||
|
||||
Reference in new issue
Block a user