Class: AWSCDK::Cognito::StandardAttributesMask

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

Overview

This interface contains standard attributes recognized by Cognito from https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-attributes.html including built-in attributes email_verified and phone_number_verified.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(address: nil, birthdate: nil, email: nil, email_verified: 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, phone_number_verified: nil, preferred_username: nil, profile_page: nil, profile_picture: nil, timezone: nil, website: nil) ⇒ StandardAttributesMask

Returns a new instance of StandardAttributesMask.

Parameters:

  • address (Boolean, nil) (defaults to: nil) —

    The user's postal address.

  • birthdate (Boolean, nil) (defaults to: nil) —

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

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

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

  • email_verified (Boolean, nil) (defaults to: nil) —

    Whether the email address has been verified.

  • family_name (Boolean, nil) (defaults to: nil) —

    The surname or last name of the user.

  • fullname (Boolean, nil) (defaults to: nil) —

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

  • gender (Boolean, nil) (defaults to: nil) —

    The user's gender.

  • given_name (Boolean, nil) (defaults to: nil) —

    The user's first name or give name.

  • last_update_time (Boolean, nil) (defaults to: nil) —

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

  • locale (Boolean, nil) (defaults to: nil) —

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

  • middle_name (Boolean, nil) (defaults to: nil) —

    The user's middle name.

  • nickname (Boolean, nil) (defaults to: nil) —

    The user's nickname or casual name.

  • phone_number (Boolean, nil) (defaults to: nil) —

    The user's telephone number.

  • phone_number_verified (Boolean, nil) (defaults to: nil) —

    Whether the phone number has been verified.

  • preferred_username (Boolean, nil) (defaults to: nil) —

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

  • profile_page (Boolean, nil) (defaults to: nil) —

    The URL to the user's profile page.

  • profile_picture (Boolean, nil) (defaults to: nil) —

    The URL to the user's profile picture.

  • timezone (Boolean, nil) (defaults to: nil) —

    The user's time zone.

  • website (Boolean, nil) (defaults to: nil) —

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



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
62
63
64
65
 
# File 'cognito/standard_attributes_mask.rb', line 26

def initialize(address: nil, birthdate: nil, email: nil, email_verified: 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, phone_number_verified: nil, preferred_username: nil, profile_page: nil, profile_picture: nil, timezone: nil, website: nil)
  @address = address
  Jsii::Type.check_type(@address, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJib29sZWFuIn0=")), "address") unless @address.nil?
  @birthdate = birthdate
  Jsii::Type.check_type(@birthdate, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJib29sZWFuIn0=")), "birthdate") unless @birthdate.nil?
  @email = email
  Jsii::Type.check_type(@email, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJib29sZWFuIn0=")), "email") unless @email.nil?
  @email_verified = email_verified
  Jsii::Type.check_type(@email_verified, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJib29sZWFuIn0=")), "emailVerified") unless @email_verified.nil?
  @family_name = family_name
  Jsii::Type.check_type(@family_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJib29sZWFuIn0=")), "familyName") unless @family_name.nil?
  @fullname = fullname
  Jsii::Type.check_type(@fullname, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJib29sZWFuIn0=")), "fullname") unless @fullname.nil?
  @gender = gender
  Jsii::Type.check_type(@gender, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJib29sZWFuIn0=")), "gender") unless @gender.nil?
  @given_name = given_name
  Jsii::Type.check_type(@given_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJib29sZWFuIn0=")), "givenName") unless @given_name.nil?
  @last_update_time = last_update_time
  Jsii::Type.check_type(@last_update_time, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJib29sZWFuIn0=")), "lastUpdateTime") unless @last_update_time.nil?
  @locale = locale
  Jsii::Type.check_type(@locale, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJib29sZWFuIn0=")), "locale") unless @locale.nil?
  @middle_name = middle_name
  Jsii::Type.check_type(@middle_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJib29sZWFuIn0=")), "middleName") unless @middle_name.nil?
  @nickname = nickname
  Jsii::Type.check_type(@nickname, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJib29sZWFuIn0=")), "nickname") unless @nickname.nil?
  @phone_number = phone_number
  Jsii::Type.check_type(@phone_number, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJib29sZWFuIn0=")), "phoneNumber") unless @phone_number.nil?
  @phone_number_verified = phone_number_verified
  Jsii::Type.check_type(@phone_number_verified, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJib29sZWFuIn0=")), "phoneNumberVerified") unless @phone_number_verified.nil?
  @preferred_username = preferred_username
  Jsii::Type.check_type(@preferred_username, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJib29sZWFuIn0=")), "preferredUsername") unless @preferred_username.nil?
  @profile_page = profile_page
  Jsii::Type.check_type(@profile_page, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJib29sZWFuIn0=")), "profilePage") unless @profile_page.nil?
  @profile_picture = profile_picture
  Jsii::Type.check_type(@profile_picture, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJib29sZWFuIn0=")), "profilePicture") unless @profile_picture.nil?
  @timezone = timezone
  Jsii::Type.check_type(@timezone, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJib29sZWFuIn0=")), "timezone") unless @timezone.nil?
  @website = website
  Jsii::Type.check_type(@website, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJib29sZWFuIn0=")), "website") unless @website.nil?
end

Instance Attribute Details

#address ⇒ Boolean? (readonly)

Note:

Default: false

The user's postal address.

Returns:

  • (Boolean, nil) 


71
72
73
 
# File 'cognito/standard_attributes_mask.rb', line 71

def address
  @address
end

#birthdate ⇒ Boolean? (readonly)

Note:

Default: false

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

Returns:

  • (Boolean, nil) 


76
77
78
 
# File 'cognito/standard_attributes_mask.rb', line 76

def birthdate
  @birthdate
end

#email ⇒ Boolean? (readonly)

Note:

Default: false

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

Returns:

  • (Boolean, nil) 


81
82
83
 
# File 'cognito/standard_attributes_mask.rb', line 81

def email
  @email
end

#email_verified ⇒ Boolean? (readonly)

Note:

Default: false

Whether the email address has been verified.

Returns:

  • (Boolean, nil) 


86
87
88
 
# File 'cognito/standard_attributes_mask.rb', line 86

def email_verified
  @email_verified
end

#family_name ⇒ Boolean? (readonly)

Note:

Default: false

The surname or last name of the user.

Returns:

  • (Boolean, nil) 


91
92
93
 
# File 'cognito/standard_attributes_mask.rb', line 91

def family_name
  @family_name
end

#fullname ⇒ Boolean? (readonly)

Note:

Default: false

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

Returns:

  • (Boolean, nil) 


96
97
98
 
# File 'cognito/standard_attributes_mask.rb', line 96

def fullname
  @fullname
end

#gender ⇒ Boolean? (readonly)

Note:

Default: false

The user's gender.

Returns:

  • (Boolean, nil) 


101
102
103
 
# File 'cognito/standard_attributes_mask.rb', line 101

def gender
  @gender
end

#given_name ⇒ Boolean? (readonly)

Note:

Default: false

The user's first name or give name.

Returns:

  • (Boolean, nil) 


106
107
108
 
# File 'cognito/standard_attributes_mask.rb', line 106

def given_name
  @given_name
end

#last_update_time ⇒ Boolean? (readonly)

Note:

Default: false

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

Returns:

  • (Boolean, nil) 


111
112
113
 
# File 'cognito/standard_attributes_mask.rb', line 111

def last_update_time
  @last_update_time
end

#locale ⇒ Boolean? (readonly)

Note:

Default: false

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

Returns:

  • (Boolean, nil) 


116
117
118
 
# File 'cognito/standard_attributes_mask.rb', line 116

def locale
  @locale
end

#middle_name ⇒ Boolean? (readonly)

Note:

Default: false

The user's middle name.

Returns:

  • (Boolean, nil) 


121
122
123
 
# File 'cognito/standard_attributes_mask.rb', line 121

def middle_name
  @middle_name
end

#nickname ⇒ Boolean? (readonly)

Note:

Default: false

The user's nickname or casual name.

Returns:

  • (Boolean, nil) 


126
127
128
 
# File 'cognito/standard_attributes_mask.rb', line 126

def nickname
  @nickname
end

#phone_number ⇒ Boolean? (readonly)

Note:

Default: false

The user's telephone number.

Returns:

  • (Boolean, nil) 


131
132
133
 
# File 'cognito/standard_attributes_mask.rb', line 131

def phone_number
  @phone_number
end

#phone_number_verified ⇒ Boolean? (readonly)

Note:

Default: false

Whether the phone number has been verified.

Returns:

  • (Boolean, nil) 


136
137
138
 
# File 'cognito/standard_attributes_mask.rb', line 136

def phone_number_verified
  @phone_number_verified
end

#preferred_username ⇒ Boolean? (readonly)

Note:

Default: false

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

Returns:

  • (Boolean, nil) 


141
142
143
 
# File 'cognito/standard_attributes_mask.rb', line 141

def preferred_username
  @preferred_username
end

#profile_page ⇒ Boolean? (readonly)

Note:

Default: false

The URL to the user's profile page.

Returns:

  • (Boolean, nil) 


146
147
148
 
# File 'cognito/standard_attributes_mask.rb', line 146

def profile_page
  @profile_page
end

#profile_picture ⇒ Boolean? (readonly)

Note:

Default: false

The URL to the user's profile picture.

Returns:

  • (Boolean, nil) 


151
152
153
 
# File 'cognito/standard_attributes_mask.rb', line 151

def profile_picture
  @profile_picture
end

#timezone ⇒ Boolean? (readonly)

Note:

Default: false

The user's time zone.

Returns:

  • (Boolean, nil) 


156
157
158
 
# File 'cognito/standard_attributes_mask.rb', line 156

def timezone
  @timezone
end

#website ⇒ Boolean? (readonly)

Note:

Default: false

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

Returns:

  • (Boolean, nil) 


161
162
163
 
# File 'cognito/standard_attributes_mask.rb', line 161

def website
  @website
end

Class Method Details

.jsii_properties ⇒ Object 



163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
 
# File 'cognito/standard_attributes_mask.rb', line 163

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

Instance Method Details

#to_jsii ⇒ Object 



187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
 
# File 'cognito/standard_attributes_mask.rb', line 187

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