Package software.amazon.awscdk.services.iam

Interface IUser

All Superinterfaces:

software.constructs.IConstruct, software.constructs.IDependable, IEnvironmentAware, IGrantable, IIdentity, IPrincipal, IResource, IUserRef, software.amazon.jsii.JsiiSerializable

All Known Subinterfaces:

IUser.Jsii$Default

All Known Implementing Classes:

IUser.Jsii$Proxy, User

@Generated(value="jsii-pacmak/1.118.0 (build 02eec31)",
           date="2025-11-04T09:27:42.952Z")
@Stability(Stable)
public interface IUser
extends software.amazon.jsii.JsiiSerializable, IIdentity, IUserRef

Represents an IAM user.

See Also:

• https://docs.aws.amazon.com/IAM/latest/UserGuide/id_users.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	IUser.Jsii$Default	Internal default implementation for IUser.
static final class	IUser.Jsii$Proxy	A proxy class which represents a concrete javascript instance of this type.

Method Summary

Modifier and Type	Method	Description
void	addToGroup(IGroup group)	Adds this user to a group.
ResourceEnvironment	getEnv()	The environment this resource belongs to.
software.constructs.Node	getNode()	The tree node.
String	getUserArn()	The user's ARN.
String	getUserName()	The user's name.

Methods inherited from interface software.amazon.awscdk.services.iam.IGrantable

getGrantPrincipal

Methods inherited from interface software.amazon.awscdk.services.iam.IIdentity

addManagedPolicy, attachInlinePolicy

Methods inherited from interface software.amazon.awscdk.services.iam.IPrincipal

addToPrincipalPolicy, getAssumeRoleAction, getPolicyFragment, getPrincipalAccount

Methods inherited from interface software.amazon.awscdk.IResource

applyRemovalPolicy, getStack

Methods inherited from interface software.amazon.awscdk.services.iam.IUserRef

getUserRef

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getUserArn

@Stability(Stable)
@NotNull
String getUserArn()

The user's ARN.

getUserName

@Stability(Stable)
@NotNull
String getUserName()

The user's name.

addToGroup

@Stability(Stable)
void addToGroup(@NotNull
 IGroup group)

Adds this user to a group.

Parameters:

group - This parameter is required.

getNode

@Stability(Stable)
@NotNull
software.constructs.Node getNode()

The tree node.

Specified by:

getNode in interface software.constructs.IConstruct

getEnv

@Stability(Stable)
@NotNull
ResourceEnvironment getEnv()

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.

Specified by:

getEnv in interface IEnvironmentAware