View a markdown version of this page

AWS::IdentityStore::User - AWS CloudFormation
SyntaxPropertiesReturn values

This is the new CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the AWS CloudFormation User Guide.

AWS::IdentityStore::User

A user object that contains the metadata and attributes for a specified user.

Syntax

To declare this entity in your CloudFormation template, use the following syntax:

JSON

{
  "Type" : "AWS::IdentityStore::User",
  "Properties" : {
      "Addresses" : [ AddressesItems, ... ],
      "Birthdate" : String,
      "DisplayName" : String,
      "Emails" : [ EmailsItems, ... ],
      "IdentityStoreId" : String,
      "Locale" : String,
      "Name" : Name,
      "NickName" : String,
      "PhoneNumbers" : [ PhoneNumbersItems, ... ],
      "Photos" : [ PhotosItems, ... ],
      "PreferredLanguage" : String,
      "ProfileUrl" : String,
      "Roles" : [ RolesItems, ... ],
      "Timezone" : String,
      "Title" : String,
      "UserName" : String,
      "UserType" : String,
      "Website" : String
    }
}

YAML

Type: AWS::IdentityStore::User
Properties:
  Addresses: 
    - AddressesItems
  Birthdate: String
  DisplayName: String
  Emails: 
    - EmailsItems
  IdentityStoreId: String
  Locale: String
  Name: 
    Name
  NickName: String
  PhoneNumbers: 
    - PhoneNumbersItems
  Photos: 
    - PhotosItems
  PreferredLanguage: String
  ProfileUrl: String
  Roles: 
    - RolesItems
  Timezone: String
  Title: String
  UserName: String
  UserType: String
  Website: String

Properties

Addresses

A list of Address objects containing addresses associated with the user.

Required: No

Type: Array of AddressesItems

Maximum: 1

Update requires: Replacement

Birthdate

The user's birthdate in YYYY-MM-DD format. This field stores personal birthdate information for the user.

Required: No

Type: String

Minimum: 1

Maximum: 1024

Update requires: No interruption

DisplayName

A string containing the name of the user that is formatted for display when the user is referenced. For example, "John Doe."

Prefix search supports a maximum of 1,000 characters for the string.

Required: No

Type: String

Minimum: 1

Maximum: 1024

Update requires: No interruption

Emails

A list of Email objects containing email addresses associated with the user.

Required: No

Type: Array of EmailsItems

Maximum: 1

Update requires: Replacement

IdentityStoreId

The globally unique identifier for the identity store.

Required: Yes

Type: String

Pattern: ^d-[0-9a-f]{10}$|^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

Minimum: 1

Maximum: 36

Update requires: Replacement

Locale

A string containing the geographical region or location of the user.

Required: No

Type: String

Minimum: 1

Maximum: 1024

Update requires: No interruption

Name

An object containing the name of the user.

Required: No

Type: Name

Update requires: No interruption

NickName

A string containing an alternate name for the user.

Required: No

Type: String

Minimum: 1

Maximum: 1024

Update requires: No interruption

PhoneNumbers

A list of PhoneNumber objects containing phone numbers associated with the user.

Required: No

Type: Array of PhoneNumbersItems

Maximum: 1

Update requires: Replacement

Photos

A list of photos associated with the user. Users can have up to 3 photos with metadata including type, display name, and primary designation.

Required: No

Type: Array of PhotosItems

Maximum: 3

Update requires: Replacement

PreferredLanguage

A string containing the preferred language of the user. For example, "American English" or "en-us."

Required: No

Type: String

Minimum: 1

Maximum: 1024

Update requires: No interruption

ProfileUrl

A string containing a URL that might be associated with the user.

Required: No

Type: String

Minimum: 1

Maximum: 1024

Update requires: No interruption

Roles

A list of Role objects containing roles associated with the user.

Required: No

Type: Array of RolesItems

Minimum: 1

Maximum: 1

Update requires: Replacement

Timezone

A string containing the time zone of the user.

Required: No

Type: String

Minimum: 1

Maximum: 1024

Update requires: No interruption

Title

A string containing the title of the user. Possible values are left unspecified. The value can vary based on your specific use case.

Required: No

Type: String

Minimum: 1

Maximum: 1024

Update requires: No interruption

UserName

A unique string used to identify the user. The length limit is 128 characters. This value can consist of letters, accented characters, symbols, numbers, and punctuation. This value is specified at the time the user is created and stored as an attribute of the user object in the identity store.

Required: No

Type: String

Pattern: ^[\p{L}\p{M}\p{S}\p{N}\p{P}]+$

Minimum: 1

Maximum: 128

Update requires: Replacement

UserType

A string indicating the type of user. Possible values are left unspecified. The value can vary based on your specific use case.

Required: No

Type: String

Minimum: 1

Maximum: 1024

Update requires: No interruption

Website

The user's personal website or blog URL. This field stores website information for personal or professional use.

Required: No

Type: String

Minimum: 1

Maximum: 1024

Update requires: No interruption

Return values

Ref

Fn::GetAtt

Arn

Property description not available.

CreatedAt

The date and time the user was created.

CreatedBy

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

UpdatedAt

The date and time the user was last updated.

UpdatedBy

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

UserId

The identifier for a user in the identity store.

UserStatus

The current status of the user account.