software.amazon.awscdk.services.iam

Class ArnPrincipal

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.iam.PrincipalBase

software.amazon.awscdk.services.iam.ArnPrincipal

All Implemented Interfaces:

IGrantable, IPrincipal, software.amazon.jsii.JsiiSerializable

Direct Known Subclasses:

AccountPrincipal, AnyPrincipal

@Generated(value="jsii-pacmak/1.29.0 (build 41df200)",
           date="2021-06-02T09:55:31.395Z")
 @Stability(value=Experimental)
public class ArnPrincipal
extends PrincipalBase

(experimental) Specify a principal by the Amazon Resource Name (ARN).

You can specify AWS accounts, IAM users, Federated SAML users, IAM roles, and specific assumed-role sessions. You cannot specify IAM groups or instance profiles as principals

See Also:

https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements_principal.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

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ArnPrincipal(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	ArnPrincipal(software.amazon.jsii.JsiiObjectRef objRef)
	ArnPrincipal(String arn)

Method Summary

Modifier and Type	Method and Description
String	getArn() (experimental) Amazon Resource Name (ARN) of the principal entity (i.e.
PrincipalPolicyFragment	getPolicyFragment() (experimental) Return the policy fragment that identifies this principal in a Policy.
String	toString() (experimental) Returns a string representation of an object.

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

addToPolicy, addToPrincipalPolicy, getAssumeRoleAction, getGrantPrincipal, getPrincipalAccount, toJSON, withConditions

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.jsii.JsiiSerializable

$jsii$toJson

Constructor Detail

ArnPrincipal

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

ArnPrincipal

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

ArnPrincipal

@Stability(value=Experimental)
public ArnPrincipal(@NotNull
                                                   String arn)

Parameters:

arn - Amazon Resource Name (ARN) of the principal entity (i.e. arn:aws:iam::123456789012:user/user-name). This parameter is required.

Method Detail

toString

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

(experimental) Returns a string representation of an object.

Overrides:

toString in class PrincipalBase

getArn

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

(experimental) Amazon Resource Name (ARN) of the principal entity (i.e. arn:aws:iam::123456789012:user/user-name).

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

Specified by:

getPolicyFragment in class PrincipalBase