# 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 is useful when creating a mobile app or web application that
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

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

- 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-iam/lib/oidc-provider.ts`](https://github.com/aws/aws-cdk/blob/v2.276.0/packages/aws-cdk-lib/aws-iam/lib/oidc-provider.ts#L125)
- Type last changed: v2.224.0 · 13 Nov 2025

## Example

```ts
const provider = new iam.OpenIdConnectProvider(this, 'MyProvider', {
  url: 'https://openid/connect',
  clientIds: [ 'myclient1', 'myclient2' ],
});
```

## Initializer

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

## Construct Props

- `clientIds`: string[] — A list of client IDs (also known as audiences).

  **Default:** no clients are allowed

  When a mobile or web app
  registers with an OpenID Connect provider, they establish a value that
  identifies the application. (This is the value that's sent as the client_id
  parameter on OAuth requests.)

  You can register multiple client IDs with the same provider. For example,
  you might have multiple applications that use the same OIDC provider. You
  cannot register more than 100 client IDs with a single IAM OIDC provider.

  Client IDs are up to 255 characters long.

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

- `thumbprints`: string[] — A list of server certificate thumbprints for the OpenID Connect (OIDC) identity provider's server certificates.

  **Default:** If no thumbprints are specified (an empty array or `undefined`), the thumbprint of the root certificate authority will be obtained from the provider's server as described in https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_providers_create_oidc_verify-thumbprint.html

  Typically this list includes only one entry. However, IAM lets you have up
  to five thumbprints for an OIDC provider. This lets you maintain multiple
  thumbprints if the identity provider is rotating certificates.

  The server certificate thumbprint is the hex-encoded SHA-1 hash value of
  the X.509 certificate used by the domain where the OpenID Connect provider
  makes its keys available. It is always a 40-character string.

  You must provide at least one thumbprint when creating an IAM OIDC
  provider. For example, assume that the OIDC provider is server.example.com
  and the provider stores its keys at
  https://keys.server.example.com/openid-connect. In that case, the
  thumbprint string would be the hex-encoded SHA-1 hash value of the
  certificate used by https://keys.server.example.com.

- `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 cannot register the same provider multiple times in a single AWS
  account. If you try to submit a URL that has already been used for an
  OpenID Connect provider in the AWS account, you will get an error.

## Properties

- `env`: [ResourceEnvironment](/cdk/api/v2/docs/aws-cdk-lib.interfaces.ResourceEnvironment.html) — 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) — The tree node.

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

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

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

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

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

- `stack`: [Stack](/cdk/api/v2/docs/aws-cdk-lib.Stack.html) — 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.