Class 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.
Inherited Members
Namespace: Amazon.CDK.AWS.IAM
Assembly: Amazon.CDK.AWS.IAM.dll
Syntax (csharp)
public class OpenIdConnectProvider : Resource, IOpenIdConnectProvider, IResource, IConstruct, IDependable
Syntax (vb)
Public Class OpenIdConnectProvider
Inherits Resource
Implements IOpenIdConnectProvider, IResource, IConstruct, IDependable
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
Examples
var provider = new OpenIdConnectProvider(this, "MyProvider", new OpenIdConnectProviderProps {
Url = "https://openid/connect",
ClientIds = new [] { "myclient1", "myclient2" }
});
Synopsis
Constructors
OpenIdConnectProvider(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
OpenIdConnectProvider(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
OpenIdConnectProvider(Construct, String, IOpenIdConnectProviderProps) | Defines an OpenID Connect provider. |
Properties
OpenIdConnectProviderArn | The Amazon Resource Name (ARN) of the IAM OpenID Connect provider. |
OpenIdConnectProviderIssuer | The issuer for OIDC Provider. |
OpenIdConnectProviderthumbprints | The thumbprints configured for this provider. |
Methods
FromOpenIdConnectProviderArn(Construct, String, String) | Imports an Open ID connect provider from an ARN. |
Constructors
OpenIdConnectProvider(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected OpenIdConnectProvider(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
OpenIdConnectProvider(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected OpenIdConnectProvider(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
OpenIdConnectProvider(Construct, String, IOpenIdConnectProviderProps)
Defines an OpenID Connect provider.
public OpenIdConnectProvider(Construct scope, string id, IOpenIdConnectProviderProps props)
Parameters
- scope Constructs.Construct
The definition scope.
- id System.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
System.String
OpenIdConnectProviderIssuer
The issuer for OIDC Provider.
public virtual string OpenIdConnectProviderIssuer { get; }
Property Value
System.String
OpenIdConnectProviderthumbprints
The thumbprints configured for this provider.
public virtual string OpenIdConnectProviderthumbprints { get; }
Property Value
System.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 Constructs.Construct
The definition scope.
- id System.String
ID of the construct.
- openIdConnectProviderArn System.String
the ARN to import.
Returns