software.amazon.awscdk.services.iam

Class UnknownPrincipal

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.iam.UnknownPrincipal

All Implemented Interfaces:

IGrantable, IPrincipal

@Generated(value="jsii-pacmak/1.71.0 (build f1f58ae)",
           date="2022-11-29T04:32:15.384Z")
public class UnknownPrincipal
extends software.amazon.jsii.JsiiObject
implements IPrincipal

A principal for use in resources that need to have a role but it's unknown.

Some resources have roles associated with them which they assume, such as Lambda Functions, CodeBuild projects, StepFunctions machines, etc.

When those resources are imported, their actual roles are not always imported with them. When that happens, we use an instance of this class instead, which will add user warnings when statements are attempted to be added to it.

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.*;
 import software.constructs.*;
 Construct construct;
 UnknownPrincipal unknownPrincipal = UnknownPrincipal.Builder.create()
         .resource(construct)
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	UnknownPrincipal.Builder A fluent builder for UnknownPrincipal.

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

Method Summary

Modifier and Type	Method and Description
java.lang.Boolean	addToPolicy(PolicyStatement statement) Add to the policy of this principal.
AddToPrincipalPolicyResult	addToPrincipalPolicy(PolicyStatement statement) Add to the policy of this principal.
java.lang.String	getAssumeRoleAction() When this Principal is used in an AssumeRole policy, the action to use.
IPrincipal	getGrantPrincipal() The principal to grant permissions to.
PrincipalPolicyFragment	getPolicyFragment() Return the policy fragment that identifies this principal in a Policy.

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.awscdk.services.iam.IPrincipal

getPrincipalAccount

Constructor Detail

UnknownPrincipal

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

UnknownPrincipal

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

Method Detail

addToPolicy

public java.lang.Boolean addToPolicy(PolicyStatement statement)

Add to the policy of this principal.

Specified by:

addToPolicy in interface IPrincipal

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

public AddToPrincipalPolicyResult addToPrincipalPolicy(PolicyStatement statement)

Add to the policy of this principal.

Specified by:

addToPrincipalPolicy in interface IPrincipal

Parameters:

statement - This parameter is required.

getAssumeRoleAction

public java.lang.String getAssumeRoleAction()

When this Principal is used in an AssumeRole policy, the action to use.

Specified by:

getAssumeRoleAction in interface IPrincipal

getGrantPrincipal

public IPrincipal getGrantPrincipal()

The principal to grant permissions to.

Specified by:

getGrantPrincipal in interface IGrantable

getPolicyFragment

public PrincipalPolicyFragment getPolicyFragment()

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

Specified by:

getPolicyFragment in interface IPrincipal