Skip to content

[aws] Add support for external_id to datastreams fetching logs from S3 #13956

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.

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
merged 4 commits into from
Jun 5, 2025

Conversation

devamanv
Copy link
Contributor

@devamanv devamanv commented May 21, 2025

Proposed commit message

The PR adds an option to configure external_id which will be used in conjunction with the role_arn field to assume the role and establish trust between Elastic and AWS. The change is specifically for datastreams that collect logs from S3. For more info on the use of external ID and how it uses the Assume Role APIs, refer this.

Checklist

  • I have reviewed tips for building integrations and this pull request is aligned with them.
  • I have verified that all data streams collect metrics or logs.
  • I have added an entry to my package's changelog.yml file.
  • I have verified that Kibana version constraints are current according to guidelines.
  • I have verified that any added dashboard complies with Kibana's Dashboard good practices

Author's Checklist

  • Test whether you can assume the role both with and without the correct external ID

How to test this PR locally

Related issues

Screenshots

image

@lalit-satapathy lalit-satapathy requested a review from agithomas May 21, 2025 08:36
@devamanv devamanv marked this pull request as ready for review June 1, 2025 18:45
@devamanv devamanv requested review from a team as code owners June 1, 2025 18:45
@devamanv devamanv added the enhancement New feature or request label Jun 1, 2025
@elastic-vault-github-plugin-prod
Copy link

elastic-vault-github-plugin-prod bot commented Jun 1, 2025

🚀 Benchmarks report

Package aws 👍(16) 💚(3) 💔(2)

Expand to view
Data stream Previous EPS New EPS Diff (%) Result
guardduty 1132.5 847.46 -285.04 (-25.17%) 💔
securityhub_findings_full_posture 1522.07 1206.27 -315.8 (-20.75%) 💔

To see the full report comment with /test benchmark fullreport

@@ -1,4 +1,9 @@
# newer versions go on top
- version: "3.5.0"
changes:
- description: Add the external_id field to datastreams collecting data from S3.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- description: Add the external_id field to datastreams collecting data from S3.
- description: Add the `external_id` field to data streams collecting data from S3.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

done!

multi: false
required: false
show_user: false
description: External ID to use when assuming a role in another account.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggest adding text that links to the AWS documentation as we have in the input's documentation.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@efd6 Added the link to the documentation, please review again.

@elasticmachine
Copy link

💚 Build Succeeded

History

Copy link

@andrewkroh andrewkroh added Team:obs-ds-hosted-services Observability Hosted Services team [elastic/obs-ds-hosted-services] Team:Security-Service Integrations Security Service Integrations team [elastic/security-service-integrations] Team:Obs-InfraObs Observability Infrastructure Monitoring team [elastic/obs-infraobs-integrations] labels Jun 2, 2025
@elasticmachine
Copy link

Pinging @elastic/security-service-integrations (Team:Security-Service Integrations)

@devamanv devamanv requested a review from efd6 June 2, 2025 16:55
Copy link
Contributor

@efd6 efd6 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM for files owned by SSI

Copy link
Contributor

@agithomas agithomas left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

Copy link
Contributor

@zmoog zmoog left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM.

@devamanv devamanv merged commit 4eed396 into elastic:main Jun 5, 2025
8 checks passed
@devamanv devamanv deleted the aws-add-external-id-s3 branch June 5, 2025 09:27
@elastic-vault-github-plugin-prod

Package aws - 3.5.0 containing this change is available at https://epr.elastic.co/package/aws/3.5.0/

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request Integration:aws AWS Team:obs-ds-hosted-services Observability Hosted Services team [elastic/obs-ds-hosted-services] Team:Obs-InfraObs Observability Infrastructure Monitoring team [elastic/obs-infraobs-integrations] Team:Security-Service Integrations Security Service Integrations team [elastic/security-service-integrations]
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants