Class: AWSCDK::Connect::CfnUser::UserIdentityInfoProperty

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
connect/cfn_user.rb

Overview

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 .

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(email: nil, first_name: nil, last_name: nil, mobile: nil, secondary_email: nil) ⇒ UserIdentityInfoProperty

Returns a new instance of UserIdentityInfoProperty.

Parameters:

  • email (String, nil) (defaults to: nil) —

    The email address.

  • first_name (String, nil) (defaults to: nil) —

    The first name.

  • last_name (String, nil) (defaults to: nil) —

    The last name.

  • mobile (String, nil) (defaults to: nil) —

    The user's mobile number.

  • secondary_email (String, nil) (defaults to: nil) —

    The user's secondary email address.



957
958
959
960
961
962
963
964
965
966
967
968
 
# File 'connect/cfn_user.rb', line 957

def initialize(email: nil, first_name: nil, last_name: nil, mobile: nil, secondary_email: nil)
  @email = email
  Jsii::Type.check_type(@email, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "email") unless @email.nil?
  @first_name = first_name
  Jsii::Type.check_type(@first_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "firstName") unless @first_name.nil?
  @last_name = last_name
  Jsii::Type.check_type(@last_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "lastName") unless @last_name.nil?
  @mobile = mobile
  Jsii::Type.check_type(@mobile, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "mobile") unless @mobile.nil?
  @secondary_email = secondary_email
  Jsii::Type.check_type(@secondary_email, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "secondaryEmail") unless @secondary_email.nil?
end

Instance Attribute Details

#email ⇒ String? (readonly)

The email address.

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

Returns:

  • (String, nil)

See Also:



976
977
978
 
# File 'connect/cfn_user.rb', line 976

def email
  @email
end

#first_name ⇒ String? (readonly)

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.

Returns:

  • (String, nil)

See Also:



983
984
985
 
# File 'connect/cfn_user.rb', line 983

def first_name
  @first_name
end

#last_name ⇒ String? (readonly)

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.

Returns:

  • (String, nil)

See Also:



990
991
992
 
# File 'connect/cfn_user.rb', line 990

def last_name
  @last_name
end

#mobile ⇒ String? (readonly)

The user's mobile number.

Returns:

  • (String, nil)

See Also:



995
996
997
 
# File 'connect/cfn_user.rb', line 995

def mobile
  @mobile
end

#secondary_email ⇒ String? (readonly)

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}

Returns:

  • (String, nil)

See Also:



1004
1005
1006
 
# File 'connect/cfn_user.rb', line 1004

def secondary_email
  @secondary_email
end

Class Method Details

.jsii_properties ⇒ Object 



1006
1007
1008
1009
1010
1011
1012
1013
1014
 
# File 'connect/cfn_user.rb', line 1006

def self.jsii_properties
  {
    :email => "email",
    :first_name => "firstName",
    :last_name => "lastName",
    :mobile => "mobile",
    :secondary_email => "secondaryEmail",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
 
# File 'connect/cfn_user.rb', line 1016

def to_jsii
  result = {}
  result.merge!({
    "email" => @email,
    "firstName" => @first_name,
    "lastName" => @last_name,
    "mobile" => @mobile,
    "secondaryEmail" => @secondary_email,
  })
  result.compact
end