feat(pipelines): document aws_partition field for aws_oidc block#3082
Open
ZachGoldberg wants to merge 1 commit into
Open
feat(pipelines): document aws_partition field for aws_oidc block#3082ZachGoldberg wants to merge 1 commit into
ZachGoldberg wants to merge 1 commit into
Conversation
Documents the new optional aws_partition config field that allows Pipelines to target non-commercial AWS partitions (aws-cn, aws-us-gov) explicitly, rather than relying solely on region-based inference.
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Contributor
|
Important Review skippedAuto reviews are disabled on base/target branches other than the default branch. Please check the settings in the CodeRabbit UI or the ⚙️ Run configurationConfiguration used: Repository UI Review profile: CHILL Plan: Pro Run ID: You can disable this status message by setting the Use the checkbox below for a quick retry:
✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
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
aws_partitionto theaws_oidcblock attributes in the API reference (api.mdx)aws_partitionmust also be set toaws-us-govalongside the partition in the role ARNsContext
The Pipelines codebase is gaining a new optional
aws_partitionfield on theaws_oidcblock (gruntwork-io/pipelines PR forthcoming). The field defaults toawsand acceptsaws,aws-cn, oraws-us-gov. It's required when using theAWSRoleNameworkflow parameter with non-commercial partitions.Test plan
aws_partitionrenders correctly in the API reference with its default value shownaws_partitionresolves