software.amazon.awscdk.services.iam

Class OpenIdConnectPrincipal

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.iam.PrincipalBase

software.amazon.awscdk.services.iam.FederatedPrincipal

software.amazon.awscdk.services.iam.WebIdentityPrincipal

software.amazon.awscdk.services.iam.OpenIdConnectPrincipal

All Implemented Interfaces:

IAssumeRolePrincipal, IComparablePrincipal, IGrantable, IPrincipal, software.amazon.jsii.JsiiSerializable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:39.777Z")
 @Stability(value=Stable)
public class OpenIdConnectPrincipal
extends WebIdentityPrincipal

A principal that represents a federated identity provider as from a OpenID Connect provider.

Example:

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

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.iam.IAssumeRolePrincipal

IAssumeRolePrincipal.Jsii$Default

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.iam.IComparablePrincipal

IComparablePrincipal.Jsii$Default

Constructor Summary

Constructors

Modifier	Constructor and Description
	OpenIdConnectPrincipal(IOpenIdConnectProvider openIdConnectProvider)
	OpenIdConnectPrincipal(IOpenIdConnectProvider openIdConnectProvider, Map<String,Object> conditions)
protected	OpenIdConnectPrincipal(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	OpenIdConnectPrincipal(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
PrincipalPolicyFragment	getPolicyFragment() Return the policy fragment that identifies this principal in a Policy.
String	toString() Returns a string representation of an object.

Methods inherited from class software.amazon.awscdk.services.iam.FederatedPrincipal

dedupeString, getAssumeRoleAction, getConditions, getFederated

Methods inherited from class software.amazon.awscdk.services.iam.PrincipalBase

addToAssumeRolePolicy, addToPolicy, addToPrincipalPolicy, getGrantPrincipal, getPrincipalAccount, toJSON, withConditions, withSessionTags

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

OpenIdConnectPrincipal

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

OpenIdConnectPrincipal

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

OpenIdConnectPrincipal

@Stability(value=Stable)
public OpenIdConnectPrincipal(@NotNull
                                                       IOpenIdConnectProvider openIdConnectProvider,
                                                       @Nullable
                                                       Map<String,Object> conditions)

Parameters:

openIdConnectProvider - OpenID Connect provider. This parameter is required.

conditions - The conditions under which the policy is in effect.

OpenIdConnectPrincipal

@Stability(value=Stable)
public OpenIdConnectPrincipal(@NotNull
                                                       IOpenIdConnectProvider openIdConnectProvider)

Parameters:

openIdConnectProvider - OpenID Connect provider. This parameter is required.

Method Detail

toString

@Stability(value=Stable)
 @NotNull
public String toString()

Returns a string representation of an object.

Overrides:

toString in class WebIdentityPrincipal

getPolicyFragment

@Stability(value=Stable)
 @NotNull
public PrincipalPolicyFragment getPolicyFragment()

Return the policy fragment that identifies this principal in a Policy.

Specified by:

getPolicyFragment in interface IPrincipal

Overrides:

getPolicyFragment in class WebIdentityPrincipal