Skip to content

[DOCS-13133] Add IAM troubleshooting to AWS manual setup guide#35353

Open
buraizu wants to merge 5 commits intomasterfrom
docs13133/aws-manual-setup-iam-troubleshooting
Open

[DOCS-13133] Add IAM troubleshooting to AWS manual setup guide#35353
buraizu wants to merge 5 commits intomasterfrom
docs13133/aws-manual-setup-iam-troubleshooting

Conversation

@buraizu
Copy link
Contributor

@buraizu buraizu commented Mar 17, 2026

What does this PR do? What is the motivation?

Adds a "Troubleshoot IAM role issues" section to the AWS Manual Setup Guide, addressing common IAM-related support ticket themes from DOCS-13133. Covers:

  • Common trust policy mistakes (wrong account ID, expired external ID, ARN capitalization)
  • AWS CLI command to validate role assumption
  • Service Control Policy (SCP) interference warning

Merge instructions

Merge readiness:

  • Ready for merge

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@buraizu buraizu added the WORK IN PROGRESS No review needed, it's a wip ;) label Mar 17, 2026
@buraizu buraizu requested a review from a team as a code owner March 17, 2026 19:15
@buraizu buraizu added the WORK IN PROGRESS No review needed, it's a wip ;) label Mar 17, 2026
Copy link

@chatgpt-codex-connector chatgpt-codex-connector bot left a comment

Choose a reason for hiding this comment

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

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 8efb9303de

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

[6]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements_condition.html
[7]: https://aws.amazon.com/blogs/security/easier-way-to-control-access-to-aws-regions-using-iam-policies/
[8]: /getting_started/site/
[9]: /integrations/guide/error-datadog-not-authorized-sts-assume-role/

Choose a reason for hiding this comment

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

P2 Badge Restore the partitions reference link target

This change assigns [9] to the AssumeRole troubleshooting page, but the Access Keys setup section already uses [Partitions][9], so that existing link now points to the wrong document instead of AWS partition guidance. Readers following Access Keys setup will be sent to unrelated IAM troubleshooting content, which breaks the instructions flow.

Useful? React with 👍 / 👎.

Run the following command from a machine with AWS CLI access to confirm that the role can be assumed:
```shell
aws sts assume-role \
--role-arn "arn:aws:iam::<YOUR_AWS_ACCOUNT_ID>:role/DatadogIntegrationRole" \

Choose a reason for hiding this comment

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

P2 Badge Use a partition-agnostic ARN in the CLI validation step

The new assume-role example hardcodes arn:aws:iam::..., but this same guide supports non-commercial partitions (for example GovCloud in the Role Delegation flow), where the ARN prefix is not arn:aws. Users in those partitions who copy this command will get a failed validation for the wrong reason, which undermines the troubleshooting step.

Useful? React with 👍 / 👎.

@github-actions github-actions bot added the Guide Content impacting a guide label Mar 17, 2026
@github-actions
Copy link
Contributor

Preview links (active after the build_preview check completes)

Modified Files

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@buraizu
Copy link
Contributor Author

buraizu commented Mar 17, 2026

Re: partition-agnostic ARN — Applied, replaced hardcoded arn:aws with a <YOUR_PARTITION> placeholder and added guidance line with commercial and GovCloud examples in f633aa2.

@buraizu
Copy link
Contributor Author

buraizu commented Mar 17, 2026

Re: link collision — Applied, added missing [9] Partitions link definition to the Access Keys tab to fix the collision in f633aa2.

Copy link

@chatgpt-codex-connector chatgpt-codex-connector bot left a comment

Choose a reason for hiding this comment

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

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: f633aa279b

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment on lines +137 to +140
Run the following command from a machine with AWS CLI access to confirm that the role can be assumed:
```shell
aws sts assume-role \
--role-arn "arn:<YOUR_PARTITION>:iam::<YOUR_AWS_ACCOUNT_ID>:role/DatadogIntegrationRole" \

Choose a reason for hiding this comment

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

P1 Badge Remove customer-side AssumeRole validation step

This troubleshooting step tells customers to run aws sts assume-role from their own CLI session and concludes that any failure means the role config is wrong, but in this setup the role trust policy is intentionally limited to Datadog’s AWS account principal (see content/en/integrations/guide/error-datadog-not-authorized-sts-assume-role.md lines 19-31), so customer credentials are typically not allowed to assume the role at all. In that common case the command will fail even when the integration is configured correctly, leading to a false negative and incorrect remediation.

Useful? React with 👍 / 👎.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@buraizu
Copy link
Contributor Author

buraizu commented Mar 17, 2026

Re: customer-side AssumeRole validation — Applied, replaced the aws sts assume-role CLI step with UI-based validation guidance, since the trust policy only allows Datadog's AWS account to assume the role and customer credentials would produce a false negative in 37e27e5.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Guide Content impacting a guide WORK IN PROGRESS No review needed, it's a wip ;)

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant