Show / Hide Table of Contents

Class OidcProviderNative

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.

Inheritance
object
Resource
OidcProviderNative
Implements
IOidcProvider
IResource
IOIDCProviderRef
IConstruct
IDependable
IEnvironmentAware
Inherited Members
Resource.IsOwnedResource(IConstruct)
Resource.IsResource(IConstruct)
Resource.ApplyRemovalPolicy(RemovalPolicy)
Resource.GeneratePhysicalName()
Resource.GetResourceArnAttribute(string, IArnComponents)
Resource.GetResourceNameAttribute(string)
Resource.Env
Resource.PhysicalName
Resource.Stack
Namespace: Amazon.CDK.AWS.IAM
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class OidcProviderNative : Resource, IOidcProvider, IResource, IOIDCProviderRef, IConstruct, IDependable, IEnvironmentAware
Syntax (vb)
Public Class OidcProviderNative Inherits Resource Implements IOidcProvider, IResource, IOIDCProviderRef, IConstruct, IDependable, IEnvironmentAware
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::IAM::OIDCProvider

ExampleMetadata: infused

Examples
var nativeProvider = new OidcProviderNative(this, "MyProvider", new OidcProviderNativeProps {
                 Url = "https://openid/connect",
                 ClientIds = new [] { "myclient1", "myclient2" },
                 Thumbprints = new [] { "aa00aa1122aa00aa1122aa00aa1122aa00aa1122" }
             });

Synopsis

Constructors

OidcProviderNative(Construct, string, IOidcProviderNativeProps)

Defines a Native OpenID Connect provider.

Properties

OidcProviderArn

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

OidcProviderIssuer

The issuer for the Native OIDC Provider.

OidcProviderRef

A reference to a OIDCProvider resource.

OidcProviderThumbprints

The thumbprints configured for this provider.

PROPERTY_INJECTION_ID

Uniquely identifies this class.

Methods

FromOidcProviderArn(Construct, string, string)

Imports an Open ID connect provider from an ARN.

Constructors

OidcProviderNative(Construct, string, IOidcProviderNativeProps)

Defines a Native OpenID Connect provider.

public OidcProviderNative(Construct scope, string id, IOidcProviderNativeProps props)
Parameters
scope Construct

The definition scope.

id string

Construct ID.

props IOidcProviderNativeProps

Initialization properties.

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::IAM::OIDCProvider

ExampleMetadata: infused

Properties

OidcProviderArn

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

public virtual string OidcProviderArn { get; }
Property Value

string

Remarks

Attribute: true

OidcProviderIssuer

The issuer for the Native OIDC Provider.

public virtual string OidcProviderIssuer { get; }
Property Value

string

Remarks

Attribute: true

OidcProviderRef

A reference to a OIDCProvider resource.

public virtual IOIDCProviderReference OidcProviderRef { get; }
Property Value

IOIDCProviderReference

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::IAM::OIDCProvider

ExampleMetadata: infused

OidcProviderThumbprints

The thumbprints configured for this provider.

public virtual string OidcProviderThumbprints { get; }
Property Value

string

Remarks

Attribute: true

PROPERTY_INJECTION_ID

Uniquely identifies this class.

public static string PROPERTY_INJECTION_ID { get; }
Property Value

string

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::IAM::OIDCProvider

ExampleMetadata: infused

Methods

FromOidcProviderArn(Construct, string, string)

Imports an Open ID connect provider from an ARN.

public static IOidcProvider FromOidcProviderArn(Construct scope, string id, string oidcProviderArn)
Parameters
scope Construct

The definition scope.

id string

ID of the construct.

oidcProviderArn string

the ARN to import.

Returns

IOidcProvider

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::IAM::OIDCProvider

ExampleMetadata: infused

Implements

IOidcProvider
IResource
IOIDCProviderRef
Constructs.IConstruct
Constructs.IDependable
IEnvironmentAware
Back to top Generated by DocFX