Skip to content

docs: add a note to prevent additional feature changes to OpenIdConnectProvider #35310

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
merged 2 commits into from
Aug 25, 2025
Merged

docs: add a note to prevent additional feature changes to OpenIdConnectProvider #35310

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
adca971
docs: add a note to prevent additional feature changes to OpenIdConne…
iankhou Aug 22, 2025
7728c31
Merge branch 'main' into iankhou-oidc-provider-note
mergify[bot] Aug 25, 2025
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
17 changes: 17 additions & 0 deletions packages/aws-cdk-lib/aws-iam/lib/oidc-provider.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -98,6 +98,23 @@ export interface OpenIdConnectProviderProps {
* requires access to AWS resources, but you don't want to create custom sign-in
* code or manage your own user identities.
*
* ⚠️ **IMPORTANT NOTICE FOR CONTRIBUTORS** ⚠️
*
* **DO NOT ADD NEW FEATURES TO THIS CONSTRUCT**
*
* This construct uses a custom resource with Lambda functions and is maintained
* for backward compatibility only. We cannot deprecate it due to its usage in
* existing services like EKS (see https://github.com/aws/aws-cdk/pull/28634#discussion_r1842962697).
*
* For new functionality, developers should use `OidcProviderNative` instead, which
* utilizes the native CloudFormation resource `AWS::IAM::OIDCProvider` and provides
* the same functionality with less complexity.
*
* If you are considering adding features to this construct, please:
* 1. Consider implementing the feature in `OidcProviderNative` instead
* 2. Discuss with the CDK team before proceeding
* 3. Ensure any changes maintain strict backward compatibility
*
* @see http://openid.net/connect
* @see https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_providers_oidc.html
*
Expand Down
Loading