software.amazon.awscdk.services.iam

Class PrincipalWithConditions

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.iam.PrincipalWithConditions

All Implemented Interfaces:

IGrantable, IPrincipal, software.amazon.jsii.JsiiSerializable

@Generated(value="jsii-pacmak/1.29.0 (build 41df200)",
           date="2021-06-02T09:55:31.426Z")
 @Stability(value=Experimental)
public class PrincipalWithConditions
extends software.amazon.jsii.JsiiObject
implements IPrincipal

(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

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.IPrincipal

IPrincipal.Jsii$Default, IPrincipal.Jsii$Proxy

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.
IPrincipal	getGrantPrincipal() (experimental) The principal to grant permissions to.
PrincipalPolicyFragment	getPolicyFragment() (experimental) Return the policy fragment that identifies this principal in a Policy.
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.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.awscdk.services.iam.IPrincipal

getPrincipalAccount

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.

Parameters:

statement - This parameter is required.

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

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

toString

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

(experimental) Returns a string representation of an object.

Overrides:

toString in class Object

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

getConditions

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

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

See the IAM documentation.

getGrantPrincipal

@Stability(value=Experimental)
 @NotNull
public IPrincipal getGrantPrincipal()

(experimental) The principal to grant permissions to.

Specified by:

getGrantPrincipal in interface IGrantable

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