software.amazon.awscdk.services.iam

Class CanonicalUserPrincipal

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.iam.PrincipalBase

software.amazon.awscdk.services.iam.CanonicalUserPrincipal

All Implemented Interfaces:

IGrantable, IPrincipal, software.amazon.jsii.JsiiSerializable

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

(experimental) A policy principal for canonicalUserIds - useful for S3 bucket policies that use Origin Access identities.

See https://docs.aws.amazon.com/general/latest/gr/acct-identifiers.html

and

https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/private-content-restricting-access-to-s3.html

for more details.

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

Method Summary

Modifier and Type	Method and Description
String	getCanonicalUserId() (experimental) unique identifier assigned by AWS for every account.
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

CanonicalUserPrincipal

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

CanonicalUserPrincipal

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

CanonicalUserPrincipal

@Stability(value=Experimental)
public CanonicalUserPrincipal(@NotNull
                                                             String canonicalUserId)

Parameters:

canonicalUserId - unique identifier assigned by AWS for every account. 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

getCanonicalUserId

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

(experimental) unique identifier assigned by AWS for every account.

root user and IAM users for an account all see the same ID. (i.e. 79a59df900b949e55d96a1e698fbacedfd6e09d98eacf8f8d5218e7cd47ef2be)

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