# ArnPrincipal

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

Extends: PrincipalBase › ArnPrincipal
Implements: IAssumeRolePrincipal, IComparablePrincipal, IGrantable, IPrincipal
Superclass of: AccountPrincipal, AccountRootPrincipal, AnyPrincipal

- 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#L441)
- Type last changed: v2.26.0 · 30 May 2022

## Example

```ts
// Option 2: create your custom mastersRole with scoped assumeBy arn as the Cluster prop. Switch to this role from the AWS console.
import { KubectlV36Layer } from '@aws-cdk/lambda-layer-kubectl-v36';
declare const vpc: ec2.Vpc;

const mastersRole = new iam.Role(this, 'MastersRole', {
  assumedBy: new iam.ArnPrincipal('arn_for_trusted_principal'),
});

const cluster = new eks.Cluster(this, 'EksCluster', {
  vpc,
  version: eks.KubernetesVersion.V1_36,
  kubectlLayer: new KubectlV36Layer(this, 'KubectlLayer'),
  mastersRole,
});

mastersRole.addToPolicy(new iam.PolicyStatement({
  actions: [
    'eks:AccessKubernetesApi',
    'eks:Describe*',
    'eks:List*',
],
  resources: [ cluster.clusterArn ],
}));
```

## Initializer

```ts
new ArnPrincipal(arn: string)
```

## Properties

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

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

- `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.

- `inOrganization(organizationId: string): PrincipalBase` — A convenience method for adding a condition that the principal is part of the specified AWS Organization.

- `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.