# CanonicalUserPrincipal

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.

Extends: PrincipalBase › CanonicalUserPrincipal
Implements: IAssumeRolePrincipal, IComparablePrincipal, IGrantable, IPrincipal

- Source: [`aws-iam/lib/principals.ts`](https://github.com/aws/aws-cdk/blob/v2.275.0/packages/aws-cdk-lib/aws-iam/lib/principals.ts#L660)
- Type last changed: v2.26.0 · 30 May 2022

## Example

```ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_iam as iam } from 'aws-cdk-lib';
const canonicalUserPrincipal = new iam.CanonicalUserPrincipal('canonicalUserId');
```

## Initializer

```ts
new CanonicalUserPrincipal(canonicalUserId: string)
```

## Properties

- `assumeRoleAction`: string — When this Principal is used in an AssumeRole policy, the action to use.

- `canonicalUserId`: string — unique identifier assigned by AWS for every account.

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

- `grantPrincipal`: [IPrincipal](/cdk/api/v2/docs/aws-cdk-lib.aws_iam.IPrincipal.html) — The principal to grant permissions to.

- `policyFragment`: [PrincipalPolicyFragment](/cdk/api/v2/docs/aws-cdk-lib.aws_iam.PrincipalPolicyFragment.html) — Return the policy fragment that identifies this principal in a Policy.

- `principalAccount`: string — 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.

## Methods

- `addToAssumeRolePolicy(document: PolicyDocument): void` — Add the principal to the AssumeRolePolicyDocument.

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

- `addToPolicy(statement: PolicyStatement): boolean` — Add to the policy of this principal.

- `addToPrincipalPolicy(_statement: PolicyStatement): AddToPrincipalPolicyResult` — Add to the policy of this principal.

- `dedupeString(): string` — Return whether or not this principal is equal to the given principal.

- `toJSON(): { [key: string]: string[] }` — JSON-ify the principal.

  Used when JSON.stringify() is called

- `toString(): string` — Returns a string representation of an object.

- `withConditions(conditions: { [key: string]: any }): PrincipalBase` — 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.

  **Returns:** a new PrincipalWithConditions object.

- `withSessionTags(): PrincipalBase` — Returns a new principal using this principal as the base, with session tags enabled.

  **Returns:** a new SessionTagsPrincipal object.