# OpenIdConnectProvider

IAM OIDC identity providers are entities in IAM that describe an external identity provider (IdP) service that supports the OpenID Connect (OIDC) standard, such as Google or Salesforce.

You use an IAM OIDC identity provider
when you want to establish trust between an OIDC-compatible IdP and your AWS
account.

This implementation has default values for thumbprints and clientIds props
that will be compatible with the eks cluster

Extends: Construct › Resource › OpenIdConnectProvider › OpenIdConnectProvider
Implements: IResource, IOpenIdConnectProvider, IEnvironmentAware, IOIDCProviderRef, IConstruct, IDependable

- CloudFormation: [`AWS::CloudFormation::CustomResource`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/aws-resource-cloudformation-customresource.html)
- L1 type: [`CfnCustomResource`](/cdk/api/v2/docs/aws-cdk-lib.CfnCustomResource.html)
- Source: [`aws-eks/lib/oidc-provider.ts`](https://github.com/aws/aws-cdk/blob/v2.273.0/packages/aws-cdk-lib/aws-eks/lib/oidc-provider.ts#L53)
- Type last changed: v2.196.0 · 16 May 2025

## Example

```ts
import * as cdk from 'aws-cdk-lib';
// Step 1: Add retain policy to existing provider
const existingProvider = new eks.OpenIdConnectProvider(this, 'Provider', {
  url: 'https://oidc.eks.us-west-2.amazonaws.com/id/EXAMPLE',
  removalPolicy: cdk.RemovalPolicy.RETAIN, // Add this line
});
```

## Initializer

```ts
new OpenIdConnectProvider(scope: Construct, id: string, props: OpenIdConnectProviderProps)
```

## Construct Props

- `removalPolicy`: [RemovalPolicy](/cdk/api/v2/docs/aws-cdk-lib.RemovalPolicy.html) = RemovalPolicy.DESTROY — The removal policy to apply to the OpenID Connect Provider.

- `url`: string (required) — The URL of the identity provider.

  The URL must begin with https:// and
  should correspond to the iss claim in the provider's OpenID Connect ID
  tokens. Per the OIDC standard, path components are allowed but query
  parameters are not. Typically the URL consists of only a hostname, like
  https://server.example.org or https://example.com.

  You can find your OIDC Issuer URL by:
  aws eks describe-cluster --name %cluster_name% --query "cluster.identity.oidc.issuer" --output text

## Properties

- `env`: [ResourceEnvironment](/cdk/api/v2/docs/aws-cdk-lib.interfaces.ResourceEnvironment.html) (required) — The environment this resource belongs to.

  For resources that are created and managed in a Stack (those created by
  creating new class instances like `new Role()`, `new Bucket()`, etc.), this
  is always the same as the environment of the stack they belong to.

  For referenced resources (those obtained from referencing methods like
  `Role.fromRoleArn()`, `Bucket.fromBucketName()`, etc.), they might be
  different than the stack they were imported into.

- `node`: [Node](/cdk/api/v2/docs/constructs.Node.html) (required) — The tree node.

- `oidcProviderRef`: [OIDCProviderReference](/cdk/api/v2/docs/aws-cdk-lib.interfaces.aws_iam.OIDCProviderReference.html) (required) — A reference to a OIDCProvider resource.

- `openIdConnectProviderArn`: string (required) — The Amazon Resource Name (ARN) of the IAM OpenID Connect provider.

- `openIdConnectProviderIssuer`: string (required) — The issuer for OIDC Provider.

- `openIdConnectProviderthumbprints`: string (required) — The thumbprints configured for this provider.

- `PROPERTY_INJECTION_ID`: string (required) (static) — Uniquely identifies this class.

- `stack`: [Stack](/cdk/api/v2/docs/aws-cdk-lib.Stack.html) (required) — The stack in which this resource is defined.

## Methods

- `applyCrossStackReferenceStrength(strength: ReferenceStrength): void` — Override the cross-stack reference strength for this resource.

  When set, any cross-stack reference to this resource will use the specified
  mechanism instead of the global default determined by the
  `@aws-cdk/core:defaultCrossStackReferences` context key. This is useful for
  selectively weakening specific references to avoid the "deadly embrace" problem
  without changing the app-wide default.

  **Parameters**

  - `strength` — - The reference strength to use for this resource.

- `applyRemovalPolicy(policy: RemovalPolicy): void` — Apply the given removal policy to this resource.

  The Removal Policy controls what happens to this resource when it stops
  being managed by CloudFormation, either because you've removed it from the
  CDK application or because you've made a change that requires the resource
  to be replaced.

  The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS
  account for data recovery and cleanup later (`RemovalPolicy.RETAIN`).

- `fromOpenIdConnectProviderArn(scope: Construct, id: string, openIdConnectProviderArn: string): IOpenIdConnectProvider` (static) — Imports an Open ID connect provider from an ARN.

  **Parameters**

  - `scope` — The definition scope.
  - `id` — ID of the construct.
  - `openIdConnectProviderArn` — the ARN to import.

- `isConstruct(x: any): boolean` (static) — Checks if `x` is a construct.

  Use this method instead of `instanceof` to properly detect `Construct`
  instances, even when the construct library is symlinked.

  Explanation: in JavaScript, multiple copies of the `constructs` library on
  disk are seen as independent, completely different libraries. As a
  consequence, the class `Construct` in each copy of the `constructs` library
  is seen as a different class, and an instance of one class will not test as
  `instanceof` the other class. `npm install` will not create installations
  like this, but users may manually symlink construct libraries together or
  use a monorepo tool: in those cases, multiple copies of the `constructs`
  library can be accidentally installed, and `instanceof` will behave
  unpredictably. It is safest to avoid using `instanceof`, and using
  this type-testing method instead.

  **Parameters**

  - `x` — Any object.

  **Returns:** true if `x` is an object created from a class which extends `Construct`.

- `isOwnedResource(construct: IConstruct): boolean` (static) — Returns true if the construct was created by CDK, and false otherwise.

- `isResource(construct: IConstruct): boolean` (static) — Check whether the given construct is a Resource.

- `toString(): string` — Returns a string representation of this construct.

- `with(...mixins: IMixin[]): IConstruct` — Applies one or more mixins to this construct.

  Mixins are applied in order. The list of constructs is captured at the
  start of the call, so constructs added by a mixin will not be visited.
  Use multiple `with()` calls if subsequent mixins should apply to added
  constructs.