software.amazon.awscdk.services.iam

Class PrincipalWithConditions

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.iam.PrincipalBase

software.amazon.awscdk.services.iam.PrincipalWithConditions

All Implemented Interfaces:

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

@Generated(value="jsii-pacmak/1.63.2 (build a8a8833)",
           date="2022-08-08T20:48:14.009Z")
 @Stability(value=Stable)
public class PrincipalWithConditions
extends PrincipalBase

An IAM principal with additional conditions specifying when the policy is in effect.

For more information about conditions, see: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements_condition.html

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;
 IPrincipal principal;
 PrincipalWithConditions principalWithConditions = new PrincipalWithConditions(principal, Map.of(
         "conditionsKey", conditions));
 

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

Method Summary

Modifier and Type	Method and Description
void	addCondition(String key, Object value) Add a condition to the principal.
void	addConditions(Map<String,Object> conditions) Adds multiple conditions to the principal.
Boolean	addToPolicy(PolicyStatement statement) Add to the policy of this principal.
AddToPrincipalPolicyResult	addToPrincipalPolicy(PolicyStatement statement) Add to the policy of this principal.
protected String	appendDedupe(String append) Append the given string to the wrapped principal's dedupe string (if available).
String	dedupeString() Return whether or not this principal is equal to the given principal.
String	getAssumeRoleAction() When this Principal is used in an AssumeRole policy, the action to use.
Map<String,Object>	getConditions() The conditions under which the policy is in effect.
PrincipalPolicyFragment	getPolicyFragment() Return the policy fragment that identifies this principal in a Policy.
String	getPrincipalAccount() The AWS account ID of this principal.
Map<String,List<String>>	toJSON() JSON-ify the principal.
String	toString() Returns a string representation of an object.

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

addToAssumeRolePolicy, getGrantPrincipal, 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

Constructor Detail

PrincipalWithConditions

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

PrincipalWithConditions

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

PrincipalWithConditions

@Stability(value=Stable)
public PrincipalWithConditions(@NotNull
                                                        IPrincipal principal,
                                                        @NotNull
                                                        Map<String,Object> conditions)

Parameters:

principal - This parameter is required.

conditions - This parameter is required.

Method Detail

addCondition

@Stability(value=Stable)
public void addCondition(@NotNull
                                                  String key,
                                                  @NotNull
                                                  Object value)

Add a condition to the principal.

Parameters:

key - This parameter is required.

value - This parameter is required.

addConditions

@Stability(value=Stable)
public void addConditions(@NotNull
                                                   Map<String,Object> conditions)

Adds multiple conditions to the principal.

Values from the conditions parameter will overwrite existing values with the same operator and key.

Parameters:

conditions - This parameter is required.

addToPolicy

@Stability(value=Stable)
 @NotNull
public Boolean addToPolicy(@NotNull
                                                              PolicyStatement statement)

Add to the policy of this principal.

Overrides:

addToPolicy in class PrincipalBase

Parameters:

statement - This parameter is required.

addToPrincipalPolicy

@Stability(value=Stable)
 @NotNull
public AddToPrincipalPolicyResult addToPrincipalPolicy(@NotNull
                                                                                          PolicyStatement statement)

Add to the policy of this principal.

Specified by:

addToPrincipalPolicy in interface IPrincipal

Overrides:

addToPrincipalPolicy in class PrincipalBase

Parameters:

statement - This parameter is required.

appendDedupe

@Stability(value=Stable)
 @Nullable
protected String appendDedupe(@NotNull
                                                                  String append)

Append the given string to the wrapped principal's dedupe string (if available).

Parameters:

append - This parameter is required.

dedupeString

@Stability(value=Stable)
 @Nullable
public String dedupeString()

Return whether or not this principal is equal to the given principal.

Specified by:

dedupeString in interface IComparablePrincipal

Specified by:

dedupeString in class PrincipalBase

toJSON

@Stability(value=Stable)
 @NotNull
public Map<String,List<String>> toJSON()

JSON-ify the principal.

Used when JSON.stringify() is called

Overrides:

toJSON in class PrincipalBase

toString

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

Returns a string representation of an object.

Overrides:

toString in class PrincipalBase

getAssumeRoleAction

@Stability(value=Stable)
 @NotNull
public String getAssumeRoleAction()

When this Principal is used in an AssumeRole policy, the action to use.

Specified by:

getAssumeRoleAction in interface IPrincipal

Overrides:

getAssumeRoleAction in class PrincipalBase

getConditions

@Stability(value=Stable)
 @NotNull
public Map<String,Object> getConditions()

The conditions under which the policy is in effect.

See the IAM documentation.

getPolicyFragment

@Stability(value=Stable)
 @NotNull
public PrincipalPolicyFragment getPolicyFragment()

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

Specified by:

getPolicyFragment in interface IPrincipal

Specified by:

getPolicyFragment in class PrincipalBase

getPrincipalAccount

@Stability(value=Stable)
 @Nullable
public String getPrincipalAccount()

The AWS account ID of this principal.

Can be undefined when the account is not known (for example, for service principals). Can be a Token - in that case, it's assumed to be AWS::AccountId.

Specified by:

getPrincipalAccount in interface IPrincipal

Overrides:

getPrincipalAccount in class PrincipalBase