AWS::Connect::User UserIdentityInfo - Amazon CloudFormation
SyntaxProperties
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

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

AWS::Connect::User UserIdentityInfo

Contains information about the identity of a user.

Note

For Amazon Connect instances that are created with the EXISTING_DIRECTORY identity management type, FirstName, LastName, and Email cannot be updated from within Amazon Connect because they are managed by the directory.

Important

The FirstName and LastName length constraints below apply only to instances using SAML for identity management. If you are using Amazon Connect for identity management, the length constraints are 1-255 for FirstName, and 1-256 for LastName.

Syntax

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

JSON

{
  "Email" : String,
  "FirstName" : String,
  "LastName" : String,
  "Mobile" : String,
  "SecondaryEmail" : String
}

YAML

  Email: String
  FirstName: String
  LastName: String
  Mobile: String
  SecondaryEmail: String

Properties

Email

The email address. If you are using SAML for identity management and include this parameter, an error is returned.

Required: No

Type: String

Update requires: No interruption

FirstName

The first name. This is required if you are using Amazon Connect or SAML for identity management. Inputs must be in Unicode Normalization Form C (NFC). Text containing characters in a non-NFC form (for example, decomposed characters or combining marks) are not accepted.

Required: No

Type: String

Minimum: 0

Maximum: 255

Update requires: No interruption

LastName

The last name. This is required if you are using Amazon Connect or SAML for identity management. Inputs must be in Unicode Normalization Form C (NFC). Text containing characters in a non-NFC form (for example, decomposed characters or combining marks) are not accepted.

Required: No

Type: String

Minimum: 0

Maximum: 300

Update requires: No interruption

Mobile

The user's mobile number.

Required: No

Type: String

Pattern: ^\+[1-9]\d{1,14}$

Update requires: No interruption

SecondaryEmail

The user's secondary email address. If you provide a secondary email, the user receives email notifications -- other than password reset notifications -- to this email address instead of to their primary email address.

Pattern: (?=^.{0,265}$)[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2,63}

Required: No

Type: String

Pattern: (?=^.{0,265}$)[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2,63}

Update requires: No interruption