Class: AWSCDK::Cognito::StandardAttributes

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
cognito/standard_attributes.rb

Overview

The set of standard attributes that can be marked as required or mutable.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(address: nil, birthdate: nil, email: nil, family_name: nil, fullname: nil, gender: nil, given_name: nil, last_update_time: nil, locale: nil, middle_name: nil, nickname: nil, phone_number: nil, preferred_username: nil, profile_page: nil, profile_picture: nil, timezone: nil, website: nil) ⇒ StandardAttributes

Returns a new instance of StandardAttributes.

Parameters:



26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
 
# File 'cognito/standard_attributes.rb', line 26

def initialize(address: nil, birthdate: nil, email: nil, family_name: nil, fullname: nil, gender: nil, given_name: nil, last_update_time: nil, locale: nil, middle_name: nil, nickname: nil, phone_number: nil, preferred_username: nil, profile_page: nil, profile_picture: nil, timezone: nil, website: nil)
  @address = address.is_a?(Hash) ? ::AWSCDK::Cognito::StandardAttribute.new(**address.transform_keys(&:to_sym)) : address
  Jsii::Type.check_type(@address, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY29nbml0by5TdGFuZGFyZEF0dHJpYnV0ZSJ9")), "address") unless @address.nil?
  @birthdate = birthdate.is_a?(Hash) ? ::AWSCDK::Cognito::StandardAttribute.new(**birthdate.transform_keys(&:to_sym)) : birthdate
  Jsii::Type.check_type(@birthdate, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY29nbml0by5TdGFuZGFyZEF0dHJpYnV0ZSJ9")), "birthdate") unless @birthdate.nil?
  @email = email.is_a?(Hash) ? ::AWSCDK::Cognito::StandardAttribute.new(**email.transform_keys(&:to_sym)) : email
  Jsii::Type.check_type(@email, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY29nbml0by5TdGFuZGFyZEF0dHJpYnV0ZSJ9")), "email") unless @email.nil?
  @family_name = family_name.is_a?(Hash) ? ::AWSCDK::Cognito::StandardAttribute.new(**family_name.transform_keys(&:to_sym)) : family_name
  Jsii::Type.check_type(@family_name, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY29nbml0by5TdGFuZGFyZEF0dHJpYnV0ZSJ9")), "familyName") unless @family_name.nil?
  @fullname = fullname.is_a?(Hash) ? ::AWSCDK::Cognito::StandardAttribute.new(**fullname.transform_keys(&:to_sym)) : fullname
  Jsii::Type.check_type(@fullname, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY29nbml0by5TdGFuZGFyZEF0dHJpYnV0ZSJ9")), "fullname") unless @fullname.nil?
  @gender = gender.is_a?(Hash) ? ::AWSCDK::Cognito::StandardAttribute.new(**gender.transform_keys(&:to_sym)) : gender
  Jsii::Type.check_type(@gender, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY29nbml0by5TdGFuZGFyZEF0dHJpYnV0ZSJ9")), "gender") unless @gender.nil?
  @given_name = given_name.is_a?(Hash) ? ::AWSCDK::Cognito::StandardAttribute.new(**given_name.transform_keys(&:to_sym)) : given_name
  Jsii::Type.check_type(@given_name, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY29nbml0by5TdGFuZGFyZEF0dHJpYnV0ZSJ9")), "givenName") unless @given_name.nil?
  @last_update_time = last_update_time.is_a?(Hash) ? ::AWSCDK::Cognito::StandardAttribute.new(**last_update_time.transform_keys(&:to_sym)) : last_update_time
  Jsii::Type.check_type(@last_update_time, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY29nbml0by5TdGFuZGFyZEF0dHJpYnV0ZSJ9")), "lastUpdateTime") unless @last_update_time.nil?
  @locale = locale.is_a?(Hash) ? ::AWSCDK::Cognito::StandardAttribute.new(**locale.transform_keys(&:to_sym)) : locale
  Jsii::Type.check_type(@locale, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY29nbml0by5TdGFuZGFyZEF0dHJpYnV0ZSJ9")), "locale") unless @locale.nil?
  @middle_name = middle_name.is_a?(Hash) ? ::AWSCDK::Cognito::StandardAttribute.new(**middle_name.transform_keys(&:to_sym)) : middle_name
  Jsii::Type.check_type(@middle_name, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY29nbml0by5TdGFuZGFyZEF0dHJpYnV0ZSJ9")), "middleName") unless @middle_name.nil?
  @nickname = nickname.is_a?(Hash) ? ::AWSCDK::Cognito::StandardAttribute.new(**nickname.transform_keys(&:to_sym)) : nickname
  Jsii::Type.check_type(@nickname, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY29nbml0by5TdGFuZGFyZEF0dHJpYnV0ZSJ9")), "nickname") unless @nickname.nil?
  @phone_number = phone_number.is_a?(Hash) ? ::AWSCDK::Cognito::StandardAttribute.new(**phone_number.transform_keys(&:to_sym)) : phone_number
  Jsii::Type.check_type(@phone_number, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY29nbml0by5TdGFuZGFyZEF0dHJpYnV0ZSJ9")), "phoneNumber") unless @phone_number.nil?
  @preferred_username = preferred_username.is_a?(Hash) ? ::AWSCDK::Cognito::StandardAttribute.new(**preferred_username.transform_keys(&:to_sym)) : preferred_username
  Jsii::Type.check_type(@preferred_username, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY29nbml0by5TdGFuZGFyZEF0dHJpYnV0ZSJ9")), "preferredUsername") unless @preferred_username.nil?
  @profile_page = profile_page.is_a?(Hash) ? ::AWSCDK::Cognito::StandardAttribute.new(**profile_page.transform_keys(&:to_sym)) : profile_page
  Jsii::Type.check_type(@profile_page, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY29nbml0by5TdGFuZGFyZEF0dHJpYnV0ZSJ9")), "profilePage") unless @profile_page.nil?
  @profile_picture = profile_picture.is_a?(Hash) ? ::AWSCDK::Cognito::StandardAttribute.new(**profile_picture.transform_keys(&:to_sym)) : profile_picture
  Jsii::Type.check_type(@profile_picture, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY29nbml0by5TdGFuZGFyZEF0dHJpYnV0ZSJ9")), "profilePicture") unless @profile_picture.nil?
  @timezone = timezone.is_a?(Hash) ? ::AWSCDK::Cognito::StandardAttribute.new(**timezone.transform_keys(&:to_sym)) : timezone
  Jsii::Type.check_type(@timezone, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY29nbml0by5TdGFuZGFyZEF0dHJpYnV0ZSJ9")), "timezone") unless @timezone.nil?
  @website = website.is_a?(Hash) ? ::AWSCDK::Cognito::StandardAttribute.new(**website.transform_keys(&:to_sym)) : website
  Jsii::Type.check_type(@website, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY29nbml0by5TdGFuZGFyZEF0dHJpYnV0ZSJ9")), "website") unless @website.nil?
end

Instance Attribute Details

#address ⇒ AWSCDK::Cognito::StandardAttribute? (readonly)

Note:

Default: - see the defaults under StandardAttribute

The user's postal address.

Returns:



67
68
69
 
# File 'cognito/standard_attributes.rb', line 67

def address
  @address
end

#birthdate ⇒ AWSCDK::Cognito::StandardAttribute? (readonly)

Note:

Default: - see the defaults under StandardAttribute

The user's birthday, represented as an ISO 8601:2004 format.

Returns:



72
73
74
 
# File 'cognito/standard_attributes.rb', line 72

def birthdate
  @birthdate
end

#email ⇒ AWSCDK::Cognito::StandardAttribute? (readonly)

Note:

Default: - see the defaults under StandardAttribute

The user's e-mail address, represented as an RFC 5322 [RFC5322] addr-spec.

Returns:



77
78
79
 
# File 'cognito/standard_attributes.rb', line 77

def email
  @email
end

#family_name ⇒ AWSCDK::Cognito::StandardAttribute? (readonly)

Note:

Default: - see the defaults under StandardAttribute

The surname or last name of the user.

Returns:



82
83
84
 
# File 'cognito/standard_attributes.rb', line 82

def family_name
  @family_name
end

#fullname ⇒ AWSCDK::Cognito::StandardAttribute? (readonly)

Note:

Default: - see the defaults under StandardAttribute

The user's full name in displayable form, including all name parts, titles and suffixes.

Returns:



87
88
89
 
# File 'cognito/standard_attributes.rb', line 87

def fullname
  @fullname
end

#gender ⇒ AWSCDK::Cognito::StandardAttribute? (readonly)

Note:

Default: - see the defaults under StandardAttribute

The user's gender.

Returns:



92
93
94
 
# File 'cognito/standard_attributes.rb', line 92

def gender
  @gender
end

#given_name ⇒ AWSCDK::Cognito::StandardAttribute? (readonly)

Note:

Default: - see the defaults under StandardAttribute

The user's first name or give name.

Returns:



97
98
99
 
# File 'cognito/standard_attributes.rb', line 97

def given_name
  @given_name
end

#last_update_time ⇒ AWSCDK::Cognito::StandardAttribute? (readonly)

Note:

Default: - see the defaults under StandardAttribute

The time, the user's information was last updated.

Returns:



102
103
104
 
# File 'cognito/standard_attributes.rb', line 102

def last_update_time
  @last_update_time
end

#locale ⇒ AWSCDK::Cognito::StandardAttribute? (readonly)

Note:

Default: - see the defaults under StandardAttribute

The user's locale, represented as a BCP47 [RFC5646] language tag.

Returns:



107
108
109
 
# File 'cognito/standard_attributes.rb', line 107

def locale
  @locale
end

#middle_name ⇒ AWSCDK::Cognito::StandardAttribute? (readonly)

Note:

Default: - see the defaults under StandardAttribute

The user's middle name.

Returns:



112
113
114
 
# File 'cognito/standard_attributes.rb', line 112

def middle_name
  @middle_name
end

#nickname ⇒ AWSCDK::Cognito::StandardAttribute? (readonly)

Note:

Default: - see the defaults under StandardAttribute

The user's nickname or casual name.

Returns:



117
118
119
 
# File 'cognito/standard_attributes.rb', line 117

def nickname
  @nickname
end

#phone_number ⇒ AWSCDK::Cognito::StandardAttribute? (readonly)

Note:

Default: - see the defaults under StandardAttribute

The user's telephone number.

Returns:



122
123
124
 
# File 'cognito/standard_attributes.rb', line 122

def phone_number
  @phone_number
end

#preferred_username ⇒ AWSCDK::Cognito::StandardAttribute? (readonly)

Note:

Default: - see the defaults under StandardAttribute

The user's preferred username, different from the immutable user name.

Returns:



127
128
129
 
# File 'cognito/standard_attributes.rb', line 127

def preferred_username
  @preferred_username
end

#profile_page ⇒ AWSCDK::Cognito::StandardAttribute? (readonly)

Note:

Default: - see the defaults under StandardAttribute

The URL to the user's profile page.

Returns:



132
133
134
 
# File 'cognito/standard_attributes.rb', line 132

def profile_page
  @profile_page
end

#profile_picture ⇒ AWSCDK::Cognito::StandardAttribute? (readonly)

Note:

Default: - see the defaults under StandardAttribute

The URL to the user's profile picture.

Returns:



137
138
139
 
# File 'cognito/standard_attributes.rb', line 137

def profile_picture
  @profile_picture
end

#timezone ⇒ AWSCDK::Cognito::StandardAttribute? (readonly)

Note:

Default: - see the defaults under StandardAttribute

The user's time zone.

Returns:



142
143
144
 
# File 'cognito/standard_attributes.rb', line 142

def timezone
  @timezone
end

#website ⇒ AWSCDK::Cognito::StandardAttribute? (readonly)

Note:

Default: - see the defaults under StandardAttribute

The URL to the user's web page or blog.

Returns:



147
148
149
 
# File 'cognito/standard_attributes.rb', line 147

def website
  @website
end

Class Method Details

.jsii_properties ⇒ Object 



149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
 
# File 'cognito/standard_attributes.rb', line 149

def self.jsii_properties
  {
    :address => "address",
    :birthdate => "birthdate",
    :email => "email",
    :family_name => "familyName",
    :fullname => "fullname",
    :gender => "gender",
    :given_name => "givenName",
    :last_update_time => "lastUpdateTime",
    :locale => "locale",
    :middle_name => "middleName",
    :nickname => "nickname",
    :phone_number => "phoneNumber",
    :preferred_username => "preferredUsername",
    :profile_page => "profilePage",
    :profile_picture => "profilePicture",
    :timezone => "timezone",
    :website => "website",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
 
# File 'cognito/standard_attributes.rb', line 171

def to_jsii
  result = {}
  result.merge!({
    "address" => @address,
    "birthdate" => @birthdate,
    "email" => @email,
    "familyName" => @family_name,
    "fullname" => @fullname,
    "gender" => @gender,
    "givenName" => @given_name,
    "lastUpdateTime" => @last_update_time,
    "locale" => @locale,
    "middleName" => @middle_name,
    "nickname" => @nickname,
    "phoneNumber" => @phone_number,
    "preferredUsername" => @preferred_username,
    "profilePage" => @profile_page,
    "profilePicture" => @profile_picture,
    "timezone" => @timezone,
    "website" => @website,
  })
  result.compact
end