Package software.amazon.awscdk.services.connect

Interface CfnUser.UserIdentityInfoProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnUser.UserIdentityInfoProperty.Jsii$Proxy

Enclosing class:

CfnUser

@Stability(Stable)
public static interface CfnUser.UserIdentityInfoProperty
extends software.amazon.jsii.JsiiSerializable

Contains information about the identity of a user.

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

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.connect.*;
 UserIdentityInfoProperty userIdentityInfoProperty = UserIdentityInfoProperty.builder()
         .email("email")
         .firstName("firstName")
         .lastName("lastName")
         .mobile("mobile")
         .secondaryEmail("secondaryEmail")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-user-useridentityinfo.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnUser.UserIdentityInfoProperty.Builder	A builder for CfnUser.UserIdentityInfoProperty
static final class	CfnUser.UserIdentityInfoProperty.Jsii$Proxy	An implementation for CfnUser.UserIdentityInfoProperty

Method Summary

Modifier and Type	Method	Description
static CfnUser.UserIdentityInfoProperty.Builder	builder()
default String	getEmail()	The email address.
default String	getFirstName()	The first name.
default String	getLastName()	The last name.
default String	getMobile()	The user's mobile number.
default String	getSecondaryEmail()	The user's secondary email address.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getEmail

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

The email address.

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-user-useridentityinfo.html#cfn-connect-user-useridentityinfo-email

getFirstName

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

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-user-useridentityinfo.html#cfn-connect-user-useridentityinfo-firstname

getLastName

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

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-user-useridentityinfo.html#cfn-connect-user-useridentityinfo-lastname

getMobile

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

The user's mobile number.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-user-useridentityinfo.html#cfn-connect-user-useridentityinfo-mobile

getSecondaryEmail

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

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}

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-user-useridentityinfo.html#cfn-connect-user-useridentityinfo-secondaryemail

builder

@Stability(Stable)
static CfnUser.UserIdentityInfoProperty.Builder builder()

Returns:

a CfnUser.UserIdentityInfoProperty.Builder of CfnUser.UserIdentityInfoProperty