Package software.amazon.awscdk.services.iam

Class SamlConsolePrincipal

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.iam.PrincipalBase

software.amazon.awscdk.services.iam.FederatedPrincipal

software.amazon.awscdk.services.iam.SamlPrincipal

software.amazon.awscdk.services.iam.SamlConsolePrincipal

All Implemented Interfaces:

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

@Generated(value="jsii-pacmak/1.113.0 (build fc68b25)",
           date="2025-10-14T12:28:12.227Z")
@Stability(Stable)
public class SamlConsolePrincipal
extends SamlPrincipal

Principal entity that represents a SAML federated identity provider for programmatic and AWS Management Console access.

Example:

 SamlProvider provider = SamlProvider.Builder.create(this, "Provider")
         .metadataDocument(SamlMetadataDocument.fromFile("/path/to/saml-metadata-document.xml"))
         .build();
 Role.Builder.create(this, "Role")
         .assumedBy(new SamlConsolePrincipal(provider))
         .build();
 

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

Method Summary

Modifier and Type	Method	Description
String	toString()	Returns a string representation of an object.

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

dedupeString, getAssumeRoleAction, getConditions, getFederated, getPolicyFragment

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

SamlConsolePrincipal

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

SamlConsolePrincipal

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

SamlConsolePrincipal

@Stability(Stable)
public SamlConsolePrincipal(@NotNull
 ISamlProvider samlProvider,
 @Nullable
 Map<String,Object> conditions)

Parameters:

samlProvider - This parameter is required.

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

SamlConsolePrincipal

@Stability(Stable)
public SamlConsolePrincipal(@NotNull
 ISamlProvider samlProvider)

Parameters:

samlProvider - This parameter is required.

Method Details

toString

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

Returns a string representation of an object.

Overrides:

toString in class SamlPrincipal