Skip to content

Commit cbf0b03

Browse files
authored
fix(iam): undeprecate openIdConnectProviderArn and openIdConnectProviderIssuer in IOidcProvider (#36859)
### Issue # (if applicable) ### Reason for this change #36589 mistakenly added these props as deprecated, which will cause warnings when trying to use the OidcProviderNative with EKS constructs. ### Description of changes - undeprecate openIdConnectProviderArn and openIdConnectProviderIssuer in IOidcProvider ### Describe any new or updated permissions being added None ### Description of how you validated changes Nothing to test. ### Checklist - [X] My code adheres to the [CONTRIBUTING GUIDE](https://github.com/aws/aws-cdk/blob/main/CONTRIBUTING.md) and [DESIGN GUIDELINES](https://github.com/aws/aws-cdk/blob/main/docs/DESIGN_GUIDELINES.md) ---- *By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
1 parent ac3628d commit cbf0b03

File tree

1 file changed

+6
-26
lines changed

1 file changed

+6
-26
lines changed

packages/aws-cdk-lib/aws-iam/lib/oidc-provider-native.ts

Lines changed: 6 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -26,16 +26,18 @@ export interface IOidcProvider extends IResource, IOIDCProviderRef {
2626
readonly oidcProviderIssuer: string;
2727

2828
/**
29-
* The Amazon Resource Name (ARN) of the IAM OpenID Connect provider.
29+
* Alias for `oidcProviderArn` to maintain backwards compatibility for
30+
* constructs which accept `iam.IOpenIdConnectProvider`.
3031
*
31-
* @deprecated Use `oidcProviderArn` instead. This property exists for backward compatibility with existing constructs as migrating between the 2 constructs (OpenIdConnectProvider and OidcProviderNative) is not reasonably feasible as it requires a manual step (cdk import) since the resource type is changing between OpenIdConnectProvider and OidcProviderNative.
32+
* Use `oidcProviderArn` instead. This property exists for backward compatibility with existing constructs as migrating between the 2 constructs (OpenIdConnectProvider and OidcProviderNative) is not reasonably feasible as it requires a manual step (cdk import) since the resource type is changing between OpenIdConnectProvider and OidcProviderNative.
3233
*/
3334
readonly openIdConnectProviderArn: string;
3435

3536
/**
36-
* The issuer for OIDC Provider
37+
* Alias for `oidcProviderIssuer` to maintain backwards compatibility for
38+
* constructs which accept `iam.IOpenIdConnectProvider.
3739
*
38-
* @deprecated Use `oidcProviderIssuer` instead. This property exists for backward compatibility with existing constructs as migrating between the 2 constructs (OpenIdConnectProvider and OidcProviderNative) is not reasonably feasible as it requires a manual step (cdk import) since the resource type is changing between OpenIdConnectProvider and OidcProviderNative.
40+
* Use `oidcProviderIssuer` instead. This property exists for backward compatibility with existing constructs as migrating between the 2 constructs (OpenIdConnectProvider and OidcProviderNative) is not reasonably feasible as it requires a manual step (cdk import) since the resource type is changing between OpenIdConnectProvider and OidcProviderNative.
3941
*/
4042
readonly openIdConnectProviderIssuer: string;
4143
}
@@ -158,22 +160,10 @@ export class OidcProviderNative extends Resource implements IOidcProvider {
158160
public readonly oidcProviderArn = oidcProviderArn;
159161
public readonly oidcProviderIssuer = resourceName;
160162

161-
/**
162-
* The Amazon Resource Name (ARN) of the IAM OpenID Connect provider.
163-
* This is an alias for oidcProviderArn to maintain compatibility with IOpenIdConnectProvider.
164-
*
165-
* @deprecated Use `oidcProviderArn` instead. This property exists for backward compatibility with existing constructs as migrating between the 2 constructs (OpenIdConnectProvider and OidcProviderNative) is not reasonably feasible as it requires a manual step (cdk import) since the resource type is changing between OpenIdConnectProvider and OidcProviderNative.
166-
*/
167163
public get openIdConnectProviderArn(): string {
168164
return this.oidcProviderArn;
169165
}
170166

171-
/**
172-
* The issuer for OIDC Provider.
173-
* This is an alias for oidcProviderIssuer to maintain compatibility with IOpenIdConnectProvider.
174-
*
175-
* @deprecated Use `oidcProviderIssuer` instead. This property exists for backward compatibility with existing constructs as migrating between the 2 constructs (OpenIdConnectProvider and OidcProviderNative) is not reasonably feasible as it requires a manual step (cdk import) since the resource type is changing between OpenIdConnectProvider and OidcProviderNative.
176-
*/
177167
public get openIdConnectProviderIssuer(): string {
178168
return this.oidcProviderIssuer;
179169
}
@@ -190,20 +180,10 @@ export class OidcProviderNative extends Resource implements IOidcProvider {
190180

191181
private readonly resource: CfnOIDCProvider;
192182

193-
/**
194-
* The Amazon Resource Name (ARN) of the IAM OpenID Connect provider.
195-
*
196-
* @deprecated Use `oidcProviderArn` instead. This property exists for backward compatibility with existing constructs as migrating between the 2 constructs (OpenIdConnectProvider and OidcProviderNative) is not reasonably feasible as it requires a manual step (cdk import) since the resource type is changing between OpenIdConnectProvider and OidcProviderNative.
197-
*/
198183
public get openIdConnectProviderArn(): string {
199184
return this.oidcProviderArn;
200185
}
201186

202-
/**
203-
* The issuer for OIDC Provider.
204-
*
205-
* @deprecated use `oidcProviderIssuer` instead. This property exists for backward compatibility with existing constructs as migrating between the 2 constructs (OpenIdConnectProvider and OidcProviderNative) is not reasonably feasible as it requires a manual step (cdk import) since the resource type is changing between OpenIdConnectProvider and OidcProviderNative.
206-
*/
207187
public get openIdConnectProviderIssuer(): string {
208188
return this.oidcProviderIssuer;
209189
}

0 commit comments

Comments
 (0)