software.amazon.awscdk.services.iam

Class PrincipalBase

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.iam.PrincipalBase

All Implemented Interfaces:

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

Direct Known Subclasses:

ArnPrincipal, CanonicalUserPrincipal, CompositePrincipal, FederatedPrincipal, OrganizationPrincipal, PrincipalWithConditions, ServicePrincipal, SessionTagsPrincipal, StarPrincipal, ViaServicePrincipal

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:39.783Z")
 @Stability(value=Stable)
public abstract class PrincipalBase
extends software.amazon.jsii.JsiiObject
implements IAssumeRolePrincipal, IComparablePrincipal

Base class for policy principals.

Example:

 // Example automatically generated from non-compiling source. May contain errors.
 CfnParameter tagParam = new CfnParameter(this, "TagName");
 CfnJson stringEquals = CfnJson.Builder.create(this, "ConditionJson")
         .value(Map.of(
                 String.format("aws:PrincipalTag/%s", tagParam.getValueAsString()), true))
         .build();
 PrincipalBase principal = new AccountRootPrincipal().withConditions(Map.of(
         "StringEquals", stringEquals));
 Role.Builder.create(this, "MyRole").assumedBy(principal).build();
 

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
protected	PrincipalBase()
protected	PrincipalBase(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	PrincipalBase(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
void	addToAssumeRolePolicy(PolicyDocument document) Add the princpial to the AssumeRolePolicyDocument.
Boolean	addToPolicy(PolicyStatement statement) Add to the policy of this principal.
AddToPrincipalPolicyResult	addToPrincipalPolicy(PolicyStatement _statement) Add to the policy of this principal.
abstract 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.
IPrincipal	getGrantPrincipal() The principal to grant permissions to.
abstract 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.
PrincipalBase	withConditions(Map<String,Object> conditions) Returns a new PrincipalWithConditions using this principal as the base, with the passed conditions added.
PrincipalBase	withSessionTags() Returns a new principal using this principal as the base, with session tags enabled.

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

PrincipalBase

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

PrincipalBase

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

PrincipalBase

@Stability(value=Stable)
protected PrincipalBase()

Method Detail

addToAssumeRolePolicy

@Stability(value=Stable)
public void addToAssumeRolePolicy(@NotNull
                                                           PolicyDocument document)

Add the princpial to the AssumeRolePolicyDocument.

Add the statements to the AssumeRolePolicyDocument necessary to give this principal permissions to assume the given role.

Specified by:

addToAssumeRolePolicy in interface IAssumeRolePrincipal

Parameters:

document - This parameter is required.

addToPolicy

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

Add to the policy of this principal.

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

Parameters:

_statement - This parameter is required.

dedupeString

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

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

Specified by:

dedupeString in interface IComparablePrincipal

toJSON

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

JSON-ify the principal.

Used when JSON.stringify() is called

toString

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

Returns a string representation of an object.

Overrides:

toString in class Object

withConditions

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

Returns a new PrincipalWithConditions using this principal as the base, with the passed conditions added.

When there is a value for the same operator and key in both the principal and the conditions parameter, the value from the conditions parameter will be used.

Parameters:

conditions - This parameter is required.

Returns:

a new PrincipalWithConditions object.

withSessionTags

@Stability(value=Stable)
 @NotNull
public PrincipalBase withSessionTags()

Returns a new principal using this principal as the base, with session tags enabled.

Returns:

a new SessionTagsPrincipal object.

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

getGrantPrincipal

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

The principal to grant permissions to.

Specified by:

getGrantPrincipal in interface IGrantable

getPolicyFragment

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

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

Specified by:

getPolicyFragment in interface IPrincipal

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