Class OpenIdConnectProvider

Namespace

Amazon.CDK.AWS.IAM

Assembly

Amazon.CDK.AWS.IAM.dll

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.

public class OpenIdConnectProvider : Resource, IOpenIdConnectProvider, IResource, IConstruct, IConstruct, IDependable

Inheritance

object

OpenIdConnectProvider

Implements

IOpenIdConnectProvider

IResource

IConstruct

IConstruct

IDependable

Examples

var provider = new OpenIdConnectProvider(this, "MyProvider", new OpenIdConnectProviderProps {
                 Url = "https://openid/connect",
                 ClientIds = new [] { "myclient1", "myclient2" }
             });

Remarks

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.

See: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_providers_oidc.html

Resource: AWS::CloudFormation::CustomResource

ExampleMetadata: infused

Constructors

OpenIdConnectProvider(Construct, string, IOpenIdConnectProviderProps)

Defines an OpenID Connect provider.

public OpenIdConnectProvider(Construct scope, string id, IOpenIdConnectProviderProps props)

Parameters

scope Construct

The definition scope.

id string

Construct ID.

props IOpenIdConnectProviderProps

Initialization properties.

Properties

OpenIdConnectProviderArn

The Amazon Resource Name (ARN) of the IAM OpenID Connect provider.

public virtual string OpenIdConnectProviderArn { get; }

Property Value

string

OpenIdConnectProviderIssuer

The issuer for OIDC Provider.

public virtual string OpenIdConnectProviderIssuer { get; }

Property Value

string

OpenIdConnectProviderthumbprints

The thumbprints configured for this provider.

public virtual string OpenIdConnectProviderthumbprints { get; }

Property Value

string

Methods

FromOpenIdConnectProviderArn(Construct, string, string)

Imports an Open ID connect provider from an ARN.

public static IOpenIdConnectProvider FromOpenIdConnectProviderArn(Construct scope, string id, string openIdConnectProviderArn)

Parameters

scope Construct

The definition scope.

id string

ID of the construct.

openIdConnectProviderArn string

the ARN to import.

Returns

IOpenIdConnectProvider