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, IGrantable, IPrincipal, software.amazon.jsii.JsiiSerializable

@Generated(value="jsii-pacmak/1.50.0 (build d1830a4)",
           date="2022-01-04T15:39:10.044Z")
 @Stability(value=Experimental)
public class PrincipalWithConditions
extends PrincipalBase

(experimental) 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

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) (experimental) Add a condition to the principal.
void	addConditions(Map<String,Object> conditions) (experimental) Adds multiple conditions to the principal.
Boolean	addToPolicy(PolicyStatement statement) (experimental) Add to the policy of this principal.
AddToPrincipalPolicyResult	addToPrincipalPolicy(PolicyStatement statement) (experimental) Add to the policy of this principal.
String	getAssumeRoleAction() (experimental) When this Principal is used in an AssumeRole policy, the action to use.
Map<String,Object>	getConditions() (experimental) The conditions under which the policy is in effect.
PrincipalPolicyFragment	getPolicyFragment() (experimental) Return the policy fragment that identifies this principal in a Policy.
String	getPrincipalAccount() (experimental) The AWS account ID of this principal.
Map<String,List<String>>	toJSON() (experimental) JSON-ify the principal.
String	toString() (experimental) 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

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Detail

PrincipalWithConditions

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

PrincipalWithConditions

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

PrincipalWithConditions

@Stability(value=Experimental)
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=Experimental)
public void addCondition(@NotNull
                                                        String key,
                                                        @NotNull
                                                        Object value)

(experimental) Add a condition to the principal.

Parameters:

key - This parameter is required.

value - This parameter is required.

addConditions

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

(experimental) 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=Experimental)
 @NotNull
public Boolean addToPolicy(@NotNull
                                                                    PolicyStatement statement)

(experimental) Add to the policy of this principal.

Specified by:

addToPolicy in interface IPrincipal

Overrides:

addToPolicy in class PrincipalBase

Parameters:

statement - This parameter is required.

Returns:

true if the statement was added, false if the principal in question does not have a policy document to add the statement to.

addToPrincipalPolicy

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

(experimental) Add to the policy of this principal.

Specified by:

addToPrincipalPolicy in interface IPrincipal

Overrides:

addToPrincipalPolicy in class PrincipalBase

Parameters:

statement - This parameter is required.

toJSON

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

(experimental) JSON-ify the principal.

Used when JSON.stringify() is called

Overrides:

toJSON in class PrincipalBase

toString

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

(experimental) Returns a string representation of an object.

Overrides:

toString in class PrincipalBase

getAssumeRoleAction

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

(experimental) 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=Experimental)
 @NotNull
public Map<String,Object> getConditions()

(experimental) The conditions under which the policy is in effect.

See the IAM documentation.

getPolicyFragment

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

(experimental) 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=Experimental)
 @Nullable
public String getPrincipalAccount()

(experimental) 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