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
Import
import { OpenIdConnectProvider } from 'aws-cdk-lib/aws-iam';Or use the module namespace:
import * as iam from 'aws-cdk-lib/aws-iam';
// iam.OpenIdConnectProviderProperties
Configuration passed to the constructor as OpenIdConnectProviderProps.
urlRequiredstringThe 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.
clientIdsOptionalstring[]A list of client IDs (also known as audiences). 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.
Default: - no clients are allowed
removalPolicyOptionalRemovalPolicyThe removal policy to apply to the OpenID Connect Provider.
Default: - RemovalPolicy.DESTROY
thumbprintsOptionalstring[]A list of server certificate thumbprints for the OpenID Connect (OIDC) identity provider's server certificates. 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.
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
Get the AWS IAM Cheat Sheet
Everything you need to know about AWS IAM on one page. HD quality, print-friendly.
Download Free InfographicQuick Facts
aws-iam