Package software.amazon.awscdk.services.identitystore

Class CfnUser

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.identitystore.CfnUser

All Implemented Interfaces:

IInspectable, IUserRef, IEnvironmentAware, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.139.0 (build 26a6b54)",
           date="2026-09-02T11:03:11.562Z")
@Stability(Stable)
public class CfnUser
extends CfnResource
implements IInspectable, IUserRef

Creates a user within the specified identity store.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.identitystore.*;
 CfnUser cfnUser = CfnUser.Builder.create(this, "MyCfnUser")
         .identityStoreId("identityStoreId")
         // the properties below are optional
         .addresses(List.of(AddressesItemsProperty.builder()
                 .country("country")
                 .formatted("formatted")
                 .locality("locality")
                 .postalCode("postalCode")
                 .primary(false)
                 .region("region")
                 .streetAddress("streetAddress")
                 .type("type")
                 .build()))
         .birthdate("birthdate")
         .displayName("displayName")
         .emails(List.of(EmailsItemsProperty.builder()
                 .primary(false)
                 .type("type")
                 .value("value")
                 .build()))
         .locale("locale")
         .name(NameProperty.builder()
                 .familyName("familyName")
                 .formatted("formatted")
                 .givenName("givenName")
                 .honorificPrefix("honorificPrefix")
                 .honorificSuffix("honorificSuffix")
                 .middleName("middleName")
                 .build())
         .nickName("nickName")
         .phoneNumbers(List.of(PhoneNumbersItemsProperty.builder()
                 .primary(false)
                 .type("type")
                 .value("value")
                 .build()))
         .photos(List.of(PhotosItemsProperty.builder()
                 .value("value")
                 // the properties below are optional
                 .display("display")
                 .primary(false)
                 .type("type")
                 .build()))
         .preferredLanguage("preferredLanguage")
         .profileUrl("profileUrl")
         .roles(List.of(RolesItemsProperty.builder()
                 .primary(false)
                 .type("type")
                 .value("value")
                 .build()))
         .timezone("timezone")
         .title("title")
         .userName("userName")
         .userType("userType")
         .website("website")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-identitystore-user.html

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CfnUser.AddressesItemsProperty	Example:
static final class	CfnUser.Builder	A fluent builder for CfnUser.
static interface	CfnUser.EmailsItemsProperty	Example:
static interface	CfnUser.NameProperty	The name of the user.
static interface	CfnUser.PhoneNumbersItemsProperty	Example:
static interface	CfnUser.PhotosItemsProperty	Example:
static interface	CfnUser.RolesItemsProperty	Example:

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.interfaces.identitystore.IUserRef

IUserRef.Jsii$Default, IUserRef.Jsii$Proxy

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CfnUser(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnUser(software.amazon.jsii.JsiiObjectRef objRef)
	CfnUser(software.constructs.Construct scope, String id, CfnUserProps props)	Create a new AWS::IdentityStore::User.

Method Summary

Modifier and Type	Method	Description
static String	arnForUser(IUserRef resource)
Object	getAddresses()	A list of addresses associated with the user.
String	getAttrArn()	The Amazon Resource Name (ARN) of the user.
String	getAttrCreatedAt()	The date and time the user was created.
String	getAttrCreatedBy()	The identifier of the user or system that created the user.
String	getAttrUpdatedAt()	The date and time the user was last updated.
String	getAttrUpdatedBy()	The identifier of the user or system that last updated the user.
String	getAttrUserId()	The identifier for a user in the identity store.
String	getAttrUserStatus()	The current status of the user account.
String	getBirthdate()	The user's birthdate in YYYY-MM-DD format.
protected Map<String,Object>	getCfnProperties()
protected Map<String,String>	getCfnPropertyNames()
String	getDisplayName()	A string containing the name of the user for display.
Object	getEmails()	A list of email addresses associated with the user.
String	getIdentityStoreId()	The globally unique identifier for the identity store.
String	getLocale()	The geographical region or location of the user.
Object	getName()	The name of the user.
String	getNickName()	An alternate name for the user.
Object	getPhoneNumbers()	A list of phone numbers associated with the user.
Object	getPhotos()	A list of photos associated with the user.
String	getPreferredLanguage()	The preferred language of the user.
String	getProfileUrl()	A URL associated with the user.
Object	getRoles()	A list of roles associated with the user.
String	getTimezone()	The time zone for the user.
String	getTitle()	The title of the user.
String	getUserName()	A unique string used to identify the user.
UserReference	getUserRef()	A reference to a User resource.
String	getUserType()	A string indicating the type of user.
String	getWebsite()	The user's personal website or blog URL.
void	inspect(TreeInspector inspector)	Examines the CloudFormation resource and discloses attributes.
static Boolean	isCfnUser(Object x)	Checks whether the given object is a CfnUser.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setAddresses(List<Object> value)	A list of addresses associated with the user.
void	setAddresses(IResolvable value)	A list of addresses associated with the user.
void	setBirthdate(String value)	The user's birthdate in YYYY-MM-DD format.
void	setDisplayName(String value)	A string containing the name of the user for display.
void	setEmails(List<Object> value)	A list of email addresses associated with the user.
void	setEmails(IResolvable value)	A list of email addresses associated with the user.
void	setIdentityStoreId(String value)	The globally unique identifier for the identity store.
void	setLocale(String value)	The geographical region or location of the user.
void	setName(IResolvable value)	The name of the user.
void	setName(CfnUser.NameProperty value)	The name of the user.
void	setNickName(String value)	An alternate name for the user.
void	setPhoneNumbers(List<Object> value)	A list of phone numbers associated with the user.
void	setPhoneNumbers(IResolvable value)	A list of phone numbers associated with the user.
void	setPhotos(List<Object> value)	A list of photos associated with the user.
void	setPhotos(IResolvable value)	A list of photos associated with the user.
void	setPreferredLanguage(String value)	The preferred language of the user.
void	setProfileUrl(String value)	A URL associated with the user.
void	setRoles(List<Object> value)	A list of roles associated with the user.
void	setRoles(IResolvable value)	A list of roles associated with the user.
void	setTimezone(String value)	The time zone for the user.
void	setTitle(String value)	The title of the user.
void	setUserName(String value)	A unique string used to identify the user.
void	setUserType(String value)	A string indicating the type of user.
void	setWebsite(String value)	The user's personal website or blog URL.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, addResourceDependency, addResourceDependency, applyCrossStackReferenceStrength, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, cfnPropertyName, getAtt, getAtt, getCfnOptions, getCfnResourceType, getEnv, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, removeDependency, removeResourceDependency, replaceDependency, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId, with

Methods inherited from class software.constructs.Construct

getNode, isConstruct

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.constructs.IConstruct

getNode, with

Methods inherited from interface software.amazon.awscdk.interfaces.IEnvironmentAware

getEnv

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Details

CFN_RESOURCE_TYPE_NAME

@Stability(Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Details

CfnUser

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

CfnUser

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

CfnUser

@Stability(Stable)
public CfnUser(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 CfnUserProps props)

Create a new AWS::IdentityStore::User.

Parameters:

scope - Scope in which this resource is defined. This parameter is required.

id - Construct identifier for this resource (unique in its scope). This parameter is required.

props - Resource properties. This parameter is required.

Method Details

arnForUser

@Stability(Stable)
@NotNull
public static String arnForUser(@NotNull
 IUserRef resource)

Parameters:

resource - This parameter is required.

isCfnUser

@Stability(Stable)
@NotNull
public static Boolean isCfnUser(@NotNull
 Object x)

Checks whether the given object is a CfnUser.

Parameters:

x - This parameter is required.

inspect

@Stability(Stable)
public void inspect(@NotNull
 TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(Stable)
@NotNull
protected Map<String,Object> renderProperties(@NotNull
 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrArn

@Stability(Stable)
@NotNull
public String getAttrArn()

The Amazon Resource Name (ARN) of the user.

getAttrCreatedAt

@Stability(Stable)
@NotNull
public String getAttrCreatedAt()

The date and time the user was created.

getAttrCreatedBy

@Stability(Stable)
@NotNull
public String getAttrCreatedBy()

The identifier of the user or system that created the user.

getAttrUpdatedAt

@Stability(Stable)
@NotNull
public String getAttrUpdatedAt()

The date and time the user was last updated.

getAttrUpdatedBy

@Stability(Stable)
@NotNull
public String getAttrUpdatedBy()

The identifier of the user or system that last updated the user.

getAttrUserId

@Stability(Stable)
@NotNull
public String getAttrUserId()

The identifier for a user in the identity store.

getAttrUserStatus

@Stability(Stable)
@NotNull
public String getAttrUserStatus()

The current status of the user account.

getCfnProperties

@Stability(Stable)
@NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getCfnPropertyNames

@Stability(Stable)
@NotNull
protected Map<String,String> getCfnPropertyNames()

Overrides:

getCfnPropertyNames in class CfnResource

getUserRef

@Stability(Stable)
@NotNull
public UserReference getUserRef()

A reference to a User resource.

Specified by:

getUserRef in interface IUserRef

getIdentityStoreId

@Stability(Stable)
@NotNull
public String getIdentityStoreId()

The globally unique identifier for the identity store.

setIdentityStoreId

@Stability(Stable)
public void setIdentityStoreId(@NotNull
 String value)

The globally unique identifier for the identity store.

getAddresses

@Stability(Stable)
@Nullable
public Object getAddresses()

A list of addresses associated with the user.

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnUser.AddressesItemsProperty>

setAddresses

@Stability(Stable)
public void setAddresses(@Nullable
 IResolvable value)

A list of addresses associated with the user.

setAddresses

@Stability(Stable)
public void setAddresses(@Nullable
 List<Object> value)

A list of addresses associated with the user.

getBirthdate

@Stability(Stable)
@Nullable
public String getBirthdate()

The user's birthdate in YYYY-MM-DD format.

setBirthdate

@Stability(Stable)
public void setBirthdate(@Nullable
 String value)

The user's birthdate in YYYY-MM-DD format.

getDisplayName

@Stability(Stable)
@Nullable
public String getDisplayName()

A string containing the name of the user for display.

setDisplayName

@Stability(Stable)
public void setDisplayName(@Nullable
 String value)

A string containing the name of the user for display.

getEmails

@Stability(Stable)
@Nullable
public Object getEmails()

A list of email addresses associated with the user.

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnUser.EmailsItemsProperty>

setEmails

@Stability(Stable)
public void setEmails(@Nullable
 IResolvable value)

A list of email addresses associated with the user.

setEmails

@Stability(Stable)
public void setEmails(@Nullable
 List<Object> value)

A list of email addresses associated with the user.

getLocale

@Stability(Stable)
@Nullable
public String getLocale()

The geographical region or location of the user.

setLocale

@Stability(Stable)
public void setLocale(@Nullable
 String value)

The geographical region or location of the user.

getName

@Stability(Stable)
@Nullable
public Object getName()

The name of the user.

Returns union: either IResolvable or CfnUser.NameProperty

setName

@Stability(Stable)
public void setName(@Nullable
 IResolvable value)

The name of the user.

setName

@Stability(Stable)
public void setName(@Nullable
 CfnUser.NameProperty value)

The name of the user.

getNickName

@Stability(Stable)
@Nullable
public String getNickName()

An alternate name for the user.

setNickName

@Stability(Stable)
public void setNickName(@Nullable
 String value)

An alternate name for the user.

getPhoneNumbers

@Stability(Stable)
@Nullable
public Object getPhoneNumbers()

A list of phone numbers associated with the user.

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnUser.PhoneNumbersItemsProperty>

setPhoneNumbers

@Stability(Stable)
public void setPhoneNumbers(@Nullable
 IResolvable value)

A list of phone numbers associated with the user.

setPhoneNumbers

@Stability(Stable)
public void setPhoneNumbers(@Nullable
 List<Object> value)

A list of phone numbers associated with the user.

getPhotos

@Stability(Stable)
@Nullable
public Object getPhotos()

A list of photos associated with the user.

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnUser.PhotosItemsProperty>

setPhotos

@Stability(Stable)
public void setPhotos(@Nullable
 IResolvable value)

A list of photos associated with the user.

setPhotos

@Stability(Stable)
public void setPhotos(@Nullable
 List<Object> value)

A list of photos associated with the user.

getPreferredLanguage

@Stability(Stable)
@Nullable
public String getPreferredLanguage()

The preferred language of the user.

setPreferredLanguage

@Stability(Stable)
public void setPreferredLanguage(@Nullable
 String value)

The preferred language of the user.

getProfileUrl

@Stability(Stable)
@Nullable
public String getProfileUrl()

A URL associated with the user.

setProfileUrl

@Stability(Stable)
public void setProfileUrl(@Nullable
 String value)

A URL associated with the user.

getRoles

@Stability(Stable)
@Nullable
public Object getRoles()

A list of roles associated with the user.

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnUser.RolesItemsProperty>

setRoles

@Stability(Stable)
public void setRoles(@Nullable
 IResolvable value)

A list of roles associated with the user.

setRoles

@Stability(Stable)
public void setRoles(@Nullable
 List<Object> value)

A list of roles associated with the user.

getTimezone

@Stability(Stable)
@Nullable
public String getTimezone()

The time zone for the user.

setTimezone

@Stability(Stable)
public void setTimezone(@Nullable
 String value)

The time zone for the user.

getTitle

@Stability(Stable)
@Nullable
public String getTitle()

The title of the user.

setTitle

@Stability(Stable)
public void setTitle(@Nullable
 String value)

The title of the user.

getUserName

@Stability(Stable)
@Nullable
public String getUserName()

A unique string used to identify the user.

setUserName

@Stability(Stable)
public void setUserName(@Nullable
 String value)

A unique string used to identify the user.

getUserType

@Stability(Stable)
@Nullable
public String getUserType()

A string indicating the type of user.

setUserType

@Stability(Stable)
public void setUserType(@Nullable
 String value)

A string indicating the type of user.

getWebsite

@Stability(Stable)
@Nullable
public String getWebsite()

The user's personal website or blog URL.

setWebsite

@Stability(Stable)
public void setWebsite(@Nullable
 String value)

The user's personal website or blog URL.