@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)", date="2023-03-22T19:35:36.613Z") public class FederatedPrincipal extends PrincipalBase
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");
IAssumeRolePrincipal.Jsii$Default
IComparablePrincipal.Jsii$Default
Modifier | Constructor and Description |
---|---|
protected |
FederatedPrincipal(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) |
protected |
FederatedPrincipal(software.amazon.jsii.JsiiObjectRef objRef) |
|
FederatedPrincipal(java.lang.String federated,
java.util.Map<java.lang.String,java.lang.Object> conditions) |
|
FederatedPrincipal(java.lang.String federated,
java.util.Map<java.lang.String,java.lang.Object> conditions,
java.lang.String assumeRoleAction) |
Modifier and Type | Method and Description |
---|---|
java.lang.String |
dedupeString()
Return whether or not this principal is equal to the given principal.
|
java.lang.String |
getAssumeRoleAction()
When this Principal is used in an AssumeRole policy, the action to use.
|
java.util.Map<java.lang.String,java.lang.Object> |
getConditions()
The conditions under which the policy is in effect.
|
java.lang.String |
getFederated()
federated identity provider (i.e.
|
PrincipalPolicyFragment |
getPolicyFragment()
Return the policy fragment that identifies this principal in a Policy.
|
java.lang.String |
toString()
Returns a string representation of an object.
|
addToAssumeRolePolicy, addToPolicy, addToPrincipalPolicy, getGrantPrincipal, getPrincipalAccount, toJSON, withConditions, withSessionTags
protected FederatedPrincipal(software.amazon.jsii.JsiiObjectRef objRef)
protected FederatedPrincipal(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
public FederatedPrincipal(java.lang.String federated, java.util.Map<java.lang.String,java.lang.Object> conditions, java.lang.String assumeRoleAction)
federated
- federated 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. This parameter is required.assumeRoleAction
- public FederatedPrincipal(java.lang.String federated, java.util.Map<java.lang.String,java.lang.Object> conditions)
federated
- federated 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. This parameter is required.public java.lang.String dedupeString()
dedupeString
in interface IComparablePrincipal
dedupeString
in class PrincipalBase
public java.lang.String toString()
toString
in class PrincipalBase
public java.lang.String getAssumeRoleAction()
getAssumeRoleAction
in interface IPrincipal
getAssumeRoleAction
in class PrincipalBase
public java.util.Map<java.lang.String,java.lang.Object> getConditions()
public java.lang.String getFederated()
public PrincipalPolicyFragment getPolicyFragment()
getPolicyFragment
in interface IPrincipal
getPolicyFragment
in class PrincipalBase