Class FederatedPrincipal

java.lang.Object
software.amazon.jsii.JsiiObject
software.amazon.awscdk.services.iam.PrincipalBase
software.amazon.awscdk.services.iam.FederatedPrincipal
All Implemented Interfaces:
IAssumeRolePrincipal, IComparablePrincipal, IGrantable, IPrincipal, software.amazon.jsii.JsiiSerializable
Direct Known Subclasses:
SamlPrincipal, WebIdentityPrincipal

@Generated(value="jsii-pacmak/1.98.0 (build 00b106d)", date="2024-05-24T02:42:39.105Z") @Stability(Stable) public class FederatedPrincipal extends PrincipalBase
Principal entity that represents a federated identity provider such as Amazon Cognito, that can be used to provide temporary security credentials to users who have been authenticated.

Additional condition keys are available when the temporary security credentials are used to make a request. You can use these keys to write policies that limit the access of federated users.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.iam.*;
 Object conditions;
 FederatedPrincipal federatedPrincipal = new FederatedPrincipal("federated", Map.of(
         "conditionsKey", conditions), "assumeRoleAction");
 

See Also:
  • Constructor Details

    • FederatedPrincipal

      protected FederatedPrincipal(software.amazon.jsii.JsiiObjectRef objRef)
    • FederatedPrincipal

      protected FederatedPrincipal(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
    • FederatedPrincipal

      @Stability(Stable) public FederatedPrincipal(@NotNull String federated, @Nullable Map<String,Object> conditions, @Nullable String assumeRoleAction)
      Parameters:
      federated - federated identity provider (i.e. 'cognito-identity.amazonaws.com' for users authenticated through Cognito). This parameter is required.
      conditions -
      assumeRoleAction - When this Principal is used in an AssumeRole policy, the action to use.
    • FederatedPrincipal

      @Stability(Stable) public FederatedPrincipal(@NotNull String federated, @Nullable Map<String,Object> conditions)
      Parameters:
      federated - federated identity provider (i.e. 'cognito-identity.amazonaws.com' for users authenticated through Cognito). This parameter is required.
      conditions -
    • FederatedPrincipal

      @Stability(Stable) public FederatedPrincipal(@NotNull String federated)
      Parameters:
      federated - federated identity provider (i.e. 'cognito-identity.amazonaws.com' for users authenticated through Cognito). This parameter is required.
  • Method Details