software.amazon.awscdk.services.iam

Class CompositePrincipal

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.iam.PrincipalBase

software.amazon.awscdk.services.iam.CompositePrincipal

All Implemented Interfaces:

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

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:39.754Z")
 @Stability(value=Stable)
public class CompositePrincipal
extends PrincipalBase

Represents a principal that has multiple types of principals.

A composite principal cannot have conditions. i.e. multiple ServicePrincipals that form a composite principal

Example:

 Role role = Role.Builder.create(this, "MyRole")
         .assumedBy(new CompositePrincipal(
         new ServicePrincipal("ec2.amazonaws.com"),
         new AccountPrincipal("1818188181818187272")))
         .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
	CompositePrincipal(IPrincipal... principals)
protected	CompositePrincipal(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CompositePrincipal(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
CompositePrincipal	addPrincipals(IPrincipal... principals) Adds IAM principals to the composite principal.
void	addToAssumeRolePolicy(PolicyDocument doc) Add the princpial to the AssumeRolePolicyDocument.
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.
PrincipalPolicyFragment	getPolicyFragment() Return the policy fragment that identifies this principal in a Policy.
String	toString() Returns a string representation of an object.

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

addToPolicy, addToPrincipalPolicy, getGrantPrincipal, getPrincipalAccount, toJSON, 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

CompositePrincipal

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

CompositePrincipal

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

CompositePrincipal

@Stability(value=Stable)
public CompositePrincipal(@NotNull
                                                   IPrincipal... principals)

Parameters:

principals - This parameter is required.

Method Detail

addPrincipals

@Stability(value=Stable)
 @NotNull
public CompositePrincipal addPrincipals(@NotNull
                                                                           IPrincipal... principals)

Adds IAM principals to the composite principal.

Composite principals cannot have conditions.

Parameters:

principals - IAM principals that will be added to the composite principal. This parameter is required.

addToAssumeRolePolicy

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

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

Overrides:

addToAssumeRolePolicy in class PrincipalBase

Parameters:

doc - 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

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

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