Package software.amazon.awscdk.services.identitystore

Interface CfnUserProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnUserProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.139.0 (build 26a6b54)",
           date="2026-09-02T11:03:11.567Z")
@Stability(Stable)
public interface CfnUserProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnUser.

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.*;
 CfnUserProps cfnUserProps = CfnUserProps.builder()
         .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	Interface	Description
static final class	CfnUserProps.Builder	A builder for CfnUserProps
static final class	CfnUserProps.Jsii$Proxy	An implementation for CfnUserProps

Method Summary

Modifier and Type	Method	Description
static CfnUserProps.Builder	builder()
default Object	getAddresses()	A list of addresses associated with the user.
default String	getBirthdate()	The user's birthdate in YYYY-MM-DD format.
default String	getDisplayName()	A string containing the name of the user for display.
default Object	getEmails()	A list of email addresses associated with the user.
String	getIdentityStoreId()	The globally unique identifier for the identity store.
default String	getLocale()	The geographical region or location of the user.
default Object	getName()	The name of the user.
default String	getNickName()	An alternate name for the user.
default Object	getPhoneNumbers()	A list of phone numbers associated with the user.
default Object	getPhotos()	A list of photos associated with the user.
default String	getPreferredLanguage()	The preferred language of the user.
default String	getProfileUrl()	A URL associated with the user.
default Object	getRoles()	A list of roles associated with the user.
default String	getTimezone()	The time zone for the user.
default String	getTitle()	The title of the user.
default String	getUserName()	A unique string used to identify the user.
default String	getUserType()	A string indicating the type of user.
default String	getWebsite()	The user's personal website or blog URL.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getIdentityStoreId

@Stability(Stable)
@NotNull
String getIdentityStoreId()

The globally unique identifier for the identity store.

See Also:

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

getAddresses

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

A list of addresses associated with the user.

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

See Also:

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

getBirthdate

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

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

See Also:

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

getDisplayName

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

A string containing the name of the user for display.

See Also:

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

getEmails

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

A list of email addresses associated with the user.

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

See Also:

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

getLocale

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

The geographical region or location of the user.

See Also:

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

getName

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

The name of the user.

Returns union: either IResolvable or CfnUser.NameProperty

See Also:

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

getNickName

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

An alternate name for the user.

See Also:

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

getPhoneNumbers

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

A list of phone numbers associated with the user.

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

See Also:

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

getPhotos

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

A list of photos associated with the user.

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

See Also:

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

getPreferredLanguage

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

The preferred language of the user.

See Also:

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

getProfileUrl

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

A URL associated with the user.

See Also:

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

getRoles

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

A list of roles associated with the user.

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

See Also:

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

getTimezone

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

The time zone for the user.

See Also:

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

getTitle

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

The title of the user.

See Also:

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

getUserName

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

A unique string used to identify the user.

See Also:

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

getUserType

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

A string indicating the type of user.

See Also:

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

getWebsite

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

The user's personal website or blog URL.

See Also:

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

builder

@Stability(Stable)
static CfnUserProps.Builder builder()

Returns:

a CfnUserProps.Builder of CfnUserProps