Skip to content

Update documentation for using role_arn #979

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.

Sign up for GitHub

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

Merged
kaiyan-sheng merged 2 commits into from
May 13, 2021
Merged

Update documentation for using role_arn #979

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
03f7c3e
Update documentation for using role_arn
kaiyan-sheng May 10, 2021
364e5e6
add changelog
kaiyan-sheng May 10, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 8 additions & 4 deletions packages/aws/_dev/build/docs/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,10 +61,14 @@ temporary credentials. Please see
for more details.

### Supported Formats
1. Use `access_key_id`, `secret_access_key` and/or `session_token` directly
2. Use `role_arn`: If `access_key_id` and `secret_access_key` are not given,
then the package will check for `role_arn`. `role_arn` is used to specify which
AWS IAM role to assume for generating temporary credentials.
1. Use access keys: Access keys include `access_key_id`, `secret_access_key`
and/or `session_token`.
2. Use `role_arn`: `role_arn` is used to specify which AWS IAM role to assume
for generating temporary credentials. If `role_arn` is given, the package will
check if access keys are given. If not, the package will check for credential
profile name. If neither is given, default credential profile will be used.
Please make sure credentials are given under either a credential profile or
access keys.
3. Use `credential_profile_name` and/or `shared_credential_file`:
If `access_key_id`, `secret_access_key` and `role_arn` are all not given, then
the package will check for `credential_profile_name`. If you use different
Expand Down
5 changes: 5 additions & 0 deletions packages/aws/changelog.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,9 @@
# newer versions go on top
- version: "0.5.5"
changes:
- description: Allow role_arn work with access keys for AWS
type: enhancement # can be one of: enhancement, bugfix, breaking-change
link: https://github.com/elastic/integrations/pull/979
- version: "0.5.4"
changes:
- description: Rename s3 input to aws-s3.
Expand Down
12 changes: 8 additions & 4 deletions packages/aws/docs/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,10 +61,14 @@ temporary credentials. Please see
for more details.

### Supported Formats
1. Use `access_key_id`, `secret_access_key` and/or `session_token` directly
2. Use `role_arn`: If `access_key_id` and `secret_access_key` are not given,
then the package will check for `role_arn`. `role_arn` is used to specify which
AWS IAM role to assume for generating temporary credentials.
1. Use access keys: Access keys include `access_key_id`, `secret_access_key`
and/or `session_token`.
2. Use `role_arn`: `role_arn` is used to specify which AWS IAM role to assume
for generating temporary credentials. If `role_arn` is given, the package will
check if access keys are given. If not, the package will check for credential
profile name. If neither is given, default credential profile will be used.
Please make sure credentials are given under either a credential profile or
access keys.
3. Use `credential_profile_name` and/or `shared_credential_file`:
If `access_key_id`, `secret_access_key` and `role_arn` are all not given, then
the package will check for `credential_profile_name`. If you use different
Expand Down
2 changes: 1 addition & 1 deletion packages/aws/manifest.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
format_version: 1.0.0
name: aws
title: AWS
version: 0.5.4
version: 0.5.5
license: basic
description: AWS Integration
type: integration
Expand Down