OpenIdConnectProvider L2 construct
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:
- Consider implementing the feature in
OidcProviderNativeinstead - Discuss with the CDK team before proceeding
- Ensure any changes maintain strict backward compatibility
Example
const provider = new iam.OpenIdConnectProvider(this, 'MyProvider', {
url: 'https://openid/connect',
clientIds: [ 'myclient1', 'myclient2' ],
});
provider = iam.OpenIdConnectProvider(self, "MyProvider",
url="https://openid/connect",
client_ids=["myclient1", "myclient2"]
)
OpenIdConnectProvider provider = OpenIdConnectProvider.Builder.create(this, "MyProvider")
.url("https://openid/connect")
.clientIds(List.of("myclient1", "myclient2"))
.build();
// Install: dotnet add package Amazon.CDK.Lib
var provider = new OpenIdConnectProvider(this, "MyProvider", new OpenIdConnectProviderProps {
Url = "https://openid/connect",
ClientIds = new [] { "myclient1", "myclient2" }
});
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
provider := iam.NewOpenIdConnectProvider(this, jsii.String("MyProvider"), &OpenIdConnectProviderProps{
Url: jsii.String("https://openid/connect"),
ClientIds: []*string{
jsii.String("myclient1"),
jsii.String("myclient2"),
},
})
Initializer
new OpenIdConnectProvider(scope: Construct, id: string, props: OpenIdConnectProviderProps)
OpenIdConnectProvider(scope: Construct, id: str, props: OpenIdConnectProviderProps)
new OpenIdConnectProvider(Construct scope, String id, OpenIdConnectProviderProps props)
new OpenIdConnectProvider(Construct scope, string id, OpenIdConnectProviderProps props)
NewOpenIdConnectProvider(Scope Construct, Id *string, Props OpenIdConnectProviderProps)
Construct Props
clientIdsoptionalstring[]client_idsoptionaltyping.List[str]clientIdsoptionalList<String>ClientIdsoptionalstring[]ClientIdsoptional*[]*string#Default: no clients are allowed
notes
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.
removalPolicyoptionalRemovalPolicyremoval_policyoptionalRemovalPolicyremovalPolicyoptionalRemovalPolicyRemovalPolicyoptionalRemovalPolicyRemovalPolicyoptionalRemovalPolicy= RemovalPolicy.DESTROY#thumbprintsoptionalstring[]thumbprintsoptionaltyping.List[str]thumbprintsoptionalList<String>Thumbprintsoptionalstring[]Thumbprintsoptional*[]*string#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
notes
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.
notes
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
envResourceEnvironmentenvResourceEnvironmentenvResourceEnvironmentEnvResourceEnvironmentEnvResourceEnvironment#notes
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.
oidcProviderRefOIDCProviderReferenceoidc_provider_refOIDCProviderReferenceoidcProviderRefOIDCProviderReferenceOidcProviderRefOIDCProviderReferenceOidcProviderRefOIDCProviderReference#openIdConnectProviderArnstringopen_id_connect_provider_arnstropenIdConnectProviderArnStringOpenIdConnectProviderArnstringOpenIdConnectProviderArn*string#openIdConnectProviderIssuerstringopen_id_connect_provider_issuerstropenIdConnectProviderIssuerStringOpenIdConnectProviderIssuerstringOpenIdConnectProviderIssuer*string#openIdConnectProviderthumbprintsstringopen_id_connect_providerthumbprintsstropenIdConnectProviderthumbprintsStringOpenIdConnectProviderthumbprintsstringOpenIdConnectProviderthumbprints*string#PROPERTY_INJECTION_IDstringproperty_injection_idstrPROPERTY_INJECTION_IDStringPROPERTY_INJECTION_IDstringPROPERTY_INJECTION_ID*stringstatic#Methods
applyCrossStackReferenceStrength(strength: ReferenceStrength): voiddef apply_cross_stack_reference_strength(self, strength: ReferenceStrength) -> Nonepublic void applyCrossStackReferenceStrength(ReferenceStrength strength)public void ApplyCrossStackReferenceStrength(ReferenceStrength strength)func ApplyCrossStackReferenceStrength(Strength ReferenceStrength)#notes · 1 parameter
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
strengthstrengthstrengthstrengthStrength— - The reference strength to use for this resource.
applyRemovalPolicy(policy: RemovalPolicy): voiddef apply_removal_policy(self, policy: RemovalPolicy) -> Nonepublic void applyRemovalPolicy(RemovalPolicy policy)public void ApplyRemovalPolicy(RemovalPolicy policy)func ApplyRemovalPolicy(Policy RemovalPolicy)#notes
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@staticmethod def from_open_id_connect_provider_arn(scope: Construct, id: str, open_id_connect_provider_arn: str) -> IOpenIdConnectProviderpublic static IOpenIdConnectProvider fromOpenIdConnectProviderArn(Construct scope, String id, String openIdConnectProviderArn)public static IOpenIdConnectProvider FromOpenIdConnectProviderArn(Construct scope, string id, string openIdConnectProviderArn)func FromOpenIdConnectProviderArn(Scope Construct, Id *string, OpenIdConnectProviderArn *string) IOpenIdConnectProviderstatic#3 parameters
Parameters
scopescopescopescopeScope— The definition scope.ididididId— ID of the construct.openIdConnectProviderArnopen_id_connect_provider_arnopenIdConnectProviderArnopenIdConnectProviderArnOpenIdConnectProviderArn— the ARN to import.
isConstruct(x: any): boolean@staticmethod def is_construct(x: Any) -> boolpublic static Boolean isConstruct(Object x)public static bool IsConstruct(object x)func IsConstruct(X interface{}) *boolstatic#notes · 1 parameter · returns
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
xxxxX— Any object.
Returns: true if x is an object created from a class which extends Construct.
isOwnedResource(construct: IConstruct): boolean@staticmethod def is_owned_resource(construct: IConstruct) -> boolpublic static Boolean isOwnedResource(IConstruct construct)public static bool IsOwnedResource(IConstruct construct)func IsOwnedResource(Construct IConstruct) *boolstatic#isResource(construct: IConstruct): boolean@staticmethod def is_resource(construct: IConstruct) -> boolpublic static Boolean isResource(IConstruct construct)public static bool IsResource(IConstruct construct)func IsResource(Construct IConstruct) *boolstatic#toString(): stringdef to_string(self, ) -> strpublic String toString()public string ToString()func ToString() *string#with(...mixins: IMixin[]): IConstructdef with(self, mixins: IMixin) -> IConstructpublic IConstruct with(IMixin mixins)public IConstruct With(IMixin mixins)func With(Mixins IMixin) IConstruct#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.