Package software.amazon.awscdk.services.iam

Class WebIdentityPrincipal

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

All Implemented Interfaces:

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

Direct Known Subclasses:

OpenIdConnectPrincipal

@Generated(value="jsii-pacmak/1.116.0 (build 0eddcff)",
           date="2025-10-24T13:34:39.896Z")
@Stability(Stable)
public class WebIdentityPrincipal
extends FederatedPrincipal

A principal that represents a federated identity provider as Web Identity such as Cognito, Amazon, Facebook, Google, etc.

Example:

 WebIdentityPrincipal principal = new WebIdentityPrincipal("cognito-identity.amazonaws.com", Map.of(
         "StringEquals", Map.of("cognito-identity.amazonaws.com:aud", "us-east-2:12345678-abcd-abcd-abcd-123456"),
         "ForAnyValue:StringLike", Map.of("cognito-identity.amazonaws.com:amr", "unauthenticated")));
 

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	Description
	WebIdentityPrincipal(String identityProvider)
	WebIdentityPrincipal(String identityProvider, Map<String,Object> conditions)
protected	WebIdentityPrincipal(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	WebIdentityPrincipal(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method	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

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Details

WebIdentityPrincipal

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

WebIdentityPrincipal

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

WebIdentityPrincipal

@Stability(Stable)
public WebIdentityPrincipal(@NotNull
 String identityProvider,
 @Nullable
 Map<String,Object> conditions)

Parameters:

identityProvider - identity provider (i.e. 'cognito-identity.amazonaws.com' for users authenticated through Cognito). This parameter is required.

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

WebIdentityPrincipal

@Stability(Stable)
public WebIdentityPrincipal(@NotNull
 String identityProvider)

Parameters:

identityProvider - identity provider (i.e. 'cognito-identity.amazonaws.com' for users authenticated through Cognito). This parameter is required.

Method Details

toString

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

Returns a string representation of an object.

Overrides:

toString in class FederatedPrincipal

getPolicyFragment

@Stability(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 FederatedPrincipal