# User

Define a new IAM user.

Extends: Construct › Resource › User
Implements: IResource, IGrantable, IIdentity, IPrincipal, IUser, IEnvironmentAware, IUserRef, IConstruct, IDependable

- CloudFormation: [`AWS::IAM::User`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/aws-resource-iam-user.html)
- L1 type: [`CfnUser`](/cdk/api/v2/docs/aws-cdk-lib.aws_iam.CfnUser.html)
- Source: [`aws-iam/lib/user.ts`](https://github.com/aws/aws-cdk/blob/v2.275.0/packages/aws-cdk-lib/aws-iam/lib/user.ts#L146)
- Type last changed: v2.224.0 · 13 Nov 2025

## Example

```ts
const user = new iam.User(this, 'MyUser');

declare const definition: sfn.IChainable;
const stateMachine = new sfn.StateMachine(this, 'StateMachine', {
  definitionBody: sfn.DefinitionBody.fromChainable(definition),
});

//give user permission to send task success to the state machine
stateMachine.grant(user, 'states:SendTaskSuccess');
```

## Initializer

```ts
new User(scope: Construct, id: string, props?: UserProps)
```

## Construct Props

- `groups`: [IGroup](/cdk/api/v2/docs/aws-cdk-lib.aws_iam.IGroup.html)[] — Groups to add this user to.

  **Default:** No groups.

  You can also use `addToGroup` to add this
  user to a group.

- `managedPolicies`: [IManagedPolicy](/cdk/api/v2/docs/aws-cdk-lib.aws_iam.IManagedPolicy.html)[] — A list of managed policies associated with this role.

  **Default:** No managed policies.

  You can add managed policies later using
  `addManagedPolicy(ManagedPolicy.fromAwsManagedPolicyName(policyName))`.

- `password`: [SecretValue](/cdk/api/v2/docs/aws-cdk-lib.SecretValue.html) — The password for the user. This is required so the user can access the AWS Management Console.

  **Default:** User won't be able to access the management console without a password.

  You can use `SecretValue.unsafePlainText` to specify a password in plain text or
  use `secretsmanager.Secret.fromSecretAttributes` to reference a secret in
  Secrets Manager.

- `passwordResetRequired`: boolean = false — Specifies whether the user is required to set a new password the next time the user logs in to the AWS Management Console.

  If this is set to 'true', you must also specify "initialPassword".

- `path`: string = / — The path for the user name.

  For more information about paths, see IAM
  Identifiers in the IAM User Guide.

- `permissionsBoundary`: [IManagedPolicy](/cdk/api/v2/docs/aws-cdk-lib.aws_iam.IManagedPolicy.html) — AWS supports permissions boundaries for IAM entities (users or roles).

  **Default:** No permissions boundary.

  A permissions boundary is an advanced feature for using a managed policy
  to set the maximum permissions that an identity-based policy can grant to
  an IAM entity. An entity's permissions boundary allows it to perform only
  the actions that are allowed by both its identity-based policies and its
  permissions boundaries.

- `userName`: string — A name for the IAM user.

  **Default:** Generated by CloudFormation (recommended)

  For valid values, see the UserName parameter for
  the CreateUser action in the IAM API Reference. If you don't specify a
  name, AWS CloudFormation generates a unique physical ID and uses that ID
  for the user name.

  If you specify a name, you cannot perform updates that require
  replacement of this resource. You can perform updates that require no or
  some interruption. If you must replace the resource, specify a new name.

  If you specify a name, you must specify the CAPABILITY_NAMED_IAM value to
  acknowledge your template's capabilities. For more information, see
  Acknowledging IAM Resources in AWS CloudFormation Templates.

## Properties

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

- `env`: [ResourceEnvironment](/cdk/api/v2/docs/aws-cdk-lib.interfaces.ResourceEnvironment.html) — The environment this resource belongs to.

  For resources that are created and managed in a Stack (those created by
  creating new class instances like `new Role()`, `new Bucket()`, etc.), this
  is always the same as the environment of the stack they belong to.

  For referenced resources (those obtained from referencing methods like
  `Role.fromRoleArn()`, `Bucket.fromBucketName()`, etc.), they might be
  different than the stack they were imported into.

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

- `node`: [Node](/cdk/api/v2/docs/constructs.Node.html) — The tree node.

- `permissionsBoundary`: [IManagedPolicy](/cdk/api/v2/docs/aws-cdk-lib.aws_iam.IManagedPolicy.html) — Returns the permissions boundary attached to this user.

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

- `PROPERTY_INJECTION_ID`: string (static) — Uniquely identifies this class.

- `stack`: [Stack](/cdk/api/v2/docs/aws-cdk-lib.Stack.html) — The stack in which this resource is defined.

- `userArn`: string — An attribute that represents the user's ARN.

- `userName`: string — An attribute that represents the user name.

- `userRef`: [UserReference](/cdk/api/v2/docs/aws-cdk-lib.interfaces.aws_iam.UserReference.html) — A reference to a User resource.

## Methods

- `addManagedPolicy(policy: IManagedPolicy): void` — Attaches a managed policy to the user.

  **Parameters**

  - `policy` — The managed policy to attach.

- `addToGroup(group: IGroup): void` — Adds this user to a group.

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

- `addToPrincipalPolicy(statement: PolicyStatement): AddToPrincipalPolicyResult` — Adds an IAM statement to the default policy.

  **Returns:** true

- `applyCrossStackReferenceStrength(strength: ReferenceStrength): void` — Override the cross-stack reference strength for this resource.

  When set, any cross-stack reference to this resource will use the specified
  mechanism instead of the global default determined by the
  `@aws-cdk/core:defaultCrossStackReferences` context key. This is useful for
  selectively weakening specific references to avoid the "deadly embrace" problem
  without changing the app-wide default.

  **Parameters**

  - `strength` — - The reference strength to use for this resource.

- `applyRemovalPolicy(policy: RemovalPolicy): void` — Apply the given removal policy to this resource.

  The Removal Policy controls what happens to this resource when it stops
  being managed by CloudFormation, either because you've removed it from the
  CDK application or because you've made a change that requires the resource
  to be replaced.

  The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS
  account for data recovery and cleanup later (`RemovalPolicy.RETAIN`).

- `attachInlinePolicy(policy: Policy): void` — Attaches a policy to this user.

- `fromUserArn(scope: Construct, id: string, userArn: string): IUser` (static) — Import an existing user given a user ARN.

  If the ARN comes from a Token, the User cannot have a path; if so, any attempt
  to reference its username will fail.

  **Parameters**

  - `scope` — construct scope.
  - `id` — construct id.
  - `userArn` — the ARN of an existing user to import.

- `fromUserAttributes(scope: Construct, id: string, attrs: UserAttributes): IUser` (static) — Import an existing user given user attributes.

  If the ARN comes from a Token, the User cannot have a path; if so, any attempt
  to reference its username will fail.

  **Parameters**

  - `scope` — construct scope.
  - `id` — construct id.
  - `attrs` — the attributes of the user to import.

- `fromUserName(scope: Construct, id: string, userName: string): IUser` (static) — Import an existing user given a username.

  **Parameters**

  - `scope` — construct scope.
  - `id` — construct id.
  - `userName` — the username of the existing user to import.

- `isConstruct(x: any): boolean` (static) — Checks if `x` is a construct.

  Use this method instead of `instanceof` to properly detect `Construct`
  instances, even when the construct library is symlinked.

  Explanation: in JavaScript, multiple copies of the `constructs` library on
  disk are seen as independent, completely different libraries. As a
  consequence, the class `Construct` in each copy of the `constructs` library
  is seen as a different class, and an instance of one class will not test as
  `instanceof` the other class. `npm install` will not create installations
  like this, but users may manually symlink construct libraries together or
  use a monorepo tool: in those cases, multiple copies of the `constructs`
  library can be accidentally installed, and `instanceof` will behave
  unpredictably. It is safest to avoid using `instanceof`, and using
  this type-testing method instead.

  **Parameters**

  - `x` — Any object.

  **Returns:** true if `x` is an object created from a class which extends `Construct`.

- `isOwnedResource(construct: IConstruct): boolean` (static) — Returns true if the construct was created by CDK, and false otherwise.

- `isResource(construct: IConstruct): boolean` (static) — Check whether the given construct is a Resource.

- `toString(): string` — Returns a string representation of this construct.

- `with(...mixins: IMixin[]): IConstruct` — Applies one or more mixins to this construct.

  Mixins are applied in order. The list of constructs is captured at the
  start of the call, so constructs added by a mixin will not be visited.
  Use multiple `with()` calls if subsequent mixins should apply to added
  constructs.