Package software.amazon.awscdk.services.iam

Class OpenIdConnectProvider

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.core.Construct
software.amazon.awscdk.core.Resource
software.amazon.awscdk.services.iam.OpenIdConnectProvider
All Implemented Interfaces:
IConstruct, IDependable, IResource, IOpenIdConnectProvider, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
Direct Known Subclasses:
OpenIdConnectProvider
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:29:57.348Z") @Stability(Stable) public class OpenIdConnectProvider extends Resource implements IOpenIdConnectProvider
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.

Example: 

 OpenIdConnectProvider provider = OpenIdConnectProvider.Builder.create(this, "MyProvider")
         .url("https://openid/connect")
         .clientIds(List.of("myclient1", "myclient2"))
         .build();

See Also:

  • Constructor Details

    • OpenIdConnectProvider

      protected OpenIdConnectProvider(software.amazon.jsii.JsiiObjectRef objRef)

    • OpenIdConnectProvider

      protected OpenIdConnectProvider(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • OpenIdConnectProvider

      @Stability(Stable) public OpenIdConnectProvider(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull OpenIdConnectProviderProps props)
      Defines an OpenID Connect provider.

      Parameters:
      scope - The definition scope. This parameter is required.
      id - Construct ID. This parameter is required.
      props - Initialization properties. This parameter is required.

  • Method Details

    • fromOpenIdConnectProviderArn

      @Stability(Stable) @NotNull public static IOpenIdConnectProvider fromOpenIdConnectProviderArn(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull String openIdConnectProviderArn)
      Imports an Open ID connect provider from an ARN.

      Parameters:
      scope - The definition scope. This parameter is required.
      id - ID of the construct. This parameter is required.
      openIdConnectProviderArn - the ARN to import. This parameter is required.

    • getOpenIdConnectProviderArn

      @Stability(Stable) @NotNull public String getOpenIdConnectProviderArn()
      The Amazon Resource Name (ARN) of the IAM OpenID Connect provider.
      Specified by:
      getOpenIdConnectProviderArn in interface IOpenIdConnectProvider

    • getOpenIdConnectProviderIssuer

      @Stability(Stable) @NotNull public String getOpenIdConnectProviderIssuer()
      The issuer for OIDC Provider.
      Specified by:
      getOpenIdConnectProviderIssuer in interface IOpenIdConnectProvider

    • getOpenIdConnectProviderthumbprints

      @Stability(Stable) @NotNull public String getOpenIdConnectProviderthumbprints()
      The thumbprints configured for this provider.