[RUN-4503] Document ssm-sts-region property for AWS opt-in regions#1824
Open
Jesus-Osuna-M wants to merge 2 commits into
Open
[RUN-4503] Document ssm-sts-region property for AWS opt-in regions#1824Jesus-Osuna-M wants to merge 2 commits into
Jesus-Osuna-M wants to merge 2 commits into
Conversation
Add documentation for the new ssm-sts-region plugin property introduced in PR rundeckpro/rundeckpro#4748 to fix InvalidClientTokenId errors when executing SSM commands on nodes in AWS opt-in regions (e.g. eu-central-2). - aws-ssm.md: Add "STS Region Configuration for AWS Opt-In Regions" section explaining v1/v2 token behavior and all four configuration methods - cross-account-aws-ssm.md: Add warning block for opt-in region setups pointing users to ssm-sts-region when using cross-account AssumeRole Co-authored-by: Cursor <cursoragent@cursor.com>
Contributor
There was a problem hiding this comment.
Pull request overview
Adds documentation for the new ssm-sts-region configuration to address InvalidClientTokenId (HTTP 403) errors when running SSM against nodes in AWS opt-in regions, and surfaces this guidance in the cross-account SSM how-to.
Changes:
- Added a new “STS Region Configuration for AWS Opt-In Regions” section to the AWS SSM node executor docs, including rationale and supported configuration methods.
- Added a warning callout to the cross-account AWS SSM how-to directing users in opt-in regions to configure
ssm-sts-regionand linking to the reference section.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 4 comments.
| File | Description |
|---|---|
| docs/manual/projects/node-execution/aws-ssm.md | Documents ssm-sts-region behavior, why it’s needed for opt-in regions, and how to configure it at multiple scopes. |
| docs/learning/howto/cross-account-aws-ssm.md | Adds an opt-in region warning and points readers to the full ssm-sts-region reference section. |
Co-authored-by: Cursor <cursoragent@cursor.com>
carlosrfranco
approved these changes
Jun 25, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Documents the new
ssm-sts-regionplugin property introduced in rundeckpro/rundeckpro#4748 to fixInvalidClientTokenId (HTTP 403)errors when executing SSM commands on nodes in AWS opt-in regions (e.g.,eu-central-2— Zurich).Jira: RUN-4503
Changes
docs/manual/projects/node-execution/aws-ssm.mdproject.ssm-sts-region, node-attributedocs/learning/howto/cross-account-aws-ssm.md::: warningcallout in the "Option 1: Individual Nodes and Node Sources Setting" sectionssm-sts-region.default=us-east-1aws-ssm.mdContext
AWS opt-in regions (those that must be manually enabled in the AWS account) reject STS v1 tokens with
InvalidClientTokenId. The global STS endpoint (sts.amazonaws.com) issues v1 tokens by default. The newssm-sts-regionproperty forces the plugin to use a regional STS endpoint, which always issues v2 tokens valid in all AWS regions.The property is optional and backward-compatible — when not set, behavior is identical to previous versions.
Test plan
aws-ssm.md#sts-region-configurationanchor resolve correctlyMade with Cursor