Show / Hide Table of Contents

Class WebIdentityPrincipal

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

Inheritance
object
PrincipalBase
FederatedPrincipal
WebIdentityPrincipal
OpenIdConnectPrincipal
Implements
IAssumeRolePrincipal
IComparablePrincipal
IPrincipal
IGrantable
Inherited Members
FederatedPrincipal.DedupeString()
FederatedPrincipal.AssumeRoleAction
FederatedPrincipal.Conditions
FederatedPrincipal.Federated
PrincipalBase.AddToAssumeRolePolicy(PolicyDocument)
PrincipalBase.AddToPolicy(PolicyStatement)
PrincipalBase.AddToPrincipalPolicy(PolicyStatement)
PrincipalBase.ToJSON()
PrincipalBase.WithConditions(IDictionary<string, object>)
PrincipalBase.WithSessionTags()
PrincipalBase.GrantPrincipal
PrincipalBase.PrincipalAccount
Namespace: Amazon.CDK.AWS.IAM
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class WebIdentityPrincipal : FederatedPrincipal, IAssumeRolePrincipal, IComparablePrincipal, IPrincipal, IGrantable
Syntax (vb)
Public Class WebIdentityPrincipal Inherits FederatedPrincipal Implements IAssumeRolePrincipal, IComparablePrincipal, IPrincipal, IGrantable
Remarks

ExampleMetadata: infused

Examples
var principal = new WebIdentityPrincipal("cognito-identity.amazonaws.com", new Dictionary<string, object> {
                { "StringEquals", new Dictionary<string, string> { { "cognito-identity.amazonaws.com:aud", "us-east-2:12345678-abcd-abcd-abcd-123456" } } },
                { "ForAnyValue:StringLike", new Dictionary<string, string> { { "cognito-identity.amazonaws.com:amr", "unauthenticated" } } }
            });

Synopsis

Constructors

WebIdentityPrincipal(string, IDictionary<string, object>?)

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

Properties

PolicyFragment

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

Methods

ToString()

Returns a string representation of an object.

Constructors

WebIdentityPrincipal(string, IDictionary<string, object>?)

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

public WebIdentityPrincipal(string identityProvider, IDictionary<string, object>? conditions = null)
Parameters
identityProvider string

identity provider (i.e. 'cognito-identity.amazonaws.com' for users authenticated through Cognito).

conditions IDictionary<string, object>

The conditions under which the policy is in effect.

Remarks

ExampleMetadata: infused

Properties

PolicyFragment

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

public override PrincipalPolicyFragment PolicyFragment { get; }
Property Value

PrincipalPolicyFragment

Overrides
FederatedPrincipal.PolicyFragment
Remarks

ExampleMetadata: infused

Methods

ToString()

Returns a string representation of an object.

public override string ToString()
Returns

string

Overrides
FederatedPrincipal.ToString()
Remarks

ExampleMetadata: infused

Implements

IAssumeRolePrincipal
IComparablePrincipal
IPrincipal
IGrantable
Back to top Generated by DocFX