software.amazon.awscdk.services.iam

Class PrincipalPolicyFragment

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.iam.PrincipalPolicyFragment

@Generated(value="jsii-pacmak/1.52.1 (build 5ccc8f6)",
           date="2022-01-28T22:52:16.961Z")
public class PrincipalPolicyFragment
extends software.amazon.jsii.JsiiObject

A collection of the fields in a PolicyStatement that can be used to identify a principal.

This consists of the JSON used in the "Principal" field, and optionally a set of "Condition"s that need to be applied to the policy.

Generally, a principal looks like:

  { '<TYPE>': ['ID', 'ID', ...] }
 

And this is also the type of the field principalJson. However, there is a special type of principal that is just the string '*', which is treated differently by some services. To represent that principal, principalJson should contain { 'LiteralString': ['*'] }.

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;
 PrincipalPolicyFragment principalPolicyFragment = new PrincipalPolicyFragment(Map.of(
         "principalJsonKey", List.of("principalJson")), Map.of(
         "conditionsKey", conditions));
 

Constructor Summary

Constructors

Modifier	Constructor and Description
	PrincipalPolicyFragment(java.util.Map<java.lang.String,java.util.List<java.lang.String>> principalJson, java.util.Map<java.lang.String,java.lang.Object> conditions)
protected	PrincipalPolicyFragment(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	PrincipalPolicyFragment(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
java.util.Map<java.lang.String,java.lang.Object>	getConditions() The conditions under which the policy is in effect.
java.util.Map<java.lang.String,java.util.List<java.lang.String>>	getPrincipalJson() JSON of the "Principal" section in a policy statement.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PrincipalPolicyFragment

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

PrincipalPolicyFragment

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

PrincipalPolicyFragment

public PrincipalPolicyFragment(java.util.Map<java.lang.String,java.util.List<java.lang.String>> principalJson,
                               java.util.Map<java.lang.String,java.lang.Object> conditions)

Parameters:

principalJson - JSON of the "Principal" section in a policy statement. This parameter is required.

conditions - The conditions under which the policy is in effect.

Method Detail

getConditions

public java.util.Map<java.lang.String,java.lang.Object> getConditions()

The conditions under which the policy is in effect.

See the IAM documentation. conditions that need to be applied to this policy

getPrincipalJson

public java.util.Map<java.lang.String,java.util.List<java.lang.String>> getPrincipalJson()

JSON of the "Principal" section in a policy statement.