Class: AWSCDK::Cognito::ProviderAttribute

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

Overview

An attribute available from a third party identity provider.

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(*args) ⇒ ProviderAttribute

Returns a new instance of ProviderAttribute.

Raises:

  • (NoMethodError)


8
9
10
# File 'cognito/provider_attribute.rb', line 8

def initialize(*args)
  raise NoMethodError, "aws-cdk-lib.aws_cognito.ProviderAttribute does not have a visible constructor; use the provided factory methods"
end

Class Method Details

.AMAZON_EMAILAWSCDK::Cognito::ProviderAttribute

The email attribute provided by Amazon.

Returns:

  • (AWSCDK::Cognito::ProviderAttribute)


30
31
32
# File 'cognito/provider_attribute.rb', line 30

def self.AMAZON_EMAIL()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_cognito.ProviderAttribute", "AMAZON_EMAIL")
end

.AMAZON_NAMEAWSCDK::Cognito::ProviderAttribute

The name attribute provided by Amazon.

Returns:

  • (AWSCDK::Cognito::ProviderAttribute)


37
38
39
# File 'cognito/provider_attribute.rb', line 37

def self.AMAZON_NAME()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_cognito.ProviderAttribute", "AMAZON_NAME")
end

.AMAZON_POSTAL_CODEAWSCDK::Cognito::ProviderAttribute

The postal code attribute provided by Amazon.

Returns:

  • (AWSCDK::Cognito::ProviderAttribute)


44
45
46
# File 'cognito/provider_attribute.rb', line 44

def self.AMAZON_POSTAL_CODE()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_cognito.ProviderAttribute", "AMAZON_POSTAL_CODE")
end

.AMAZON_USER_IDAWSCDK::Cognito::ProviderAttribute

The user id attribute provided by Amazon.

Returns:

  • (AWSCDK::Cognito::ProviderAttribute)


51
52
53
# File 'cognito/provider_attribute.rb', line 51

def self.AMAZON_USER_ID()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_cognito.ProviderAttribute", "AMAZON_USER_ID")
end

.APPLE_EMAILAWSCDK::Cognito::ProviderAttribute

The email attribute provided by Apple.

Returns:

  • (AWSCDK::Cognito::ProviderAttribute)


58
59
60
# File 'cognito/provider_attribute.rb', line 58

def self.APPLE_EMAIL()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_cognito.ProviderAttribute", "APPLE_EMAIL")
end

.APPLE_EMAIL_VERIFIEDAWSCDK::Cognito::ProviderAttribute

The email verified attribute provided by Apple.

Returns:

  • (AWSCDK::Cognito::ProviderAttribute)


65
66
67
# File 'cognito/provider_attribute.rb', line 65

def self.APPLE_EMAIL_VERIFIED()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_cognito.ProviderAttribute", "APPLE_EMAIL_VERIFIED")
end

.APPLE_FIRST_NAMEAWSCDK::Cognito::ProviderAttribute

The first name attribute provided by Apple.

Returns:

  • (AWSCDK::Cognito::ProviderAttribute)


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

def self.APPLE_FIRST_NAME()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_cognito.ProviderAttribute", "APPLE_FIRST_NAME")
end

.APPLE_LAST_NAMEAWSCDK::Cognito::ProviderAttribute

The last name attribute provided by Apple.

Returns:

  • (AWSCDK::Cognito::ProviderAttribute)


79
80
81
# File 'cognito/provider_attribute.rb', line 79

def self.APPLE_LAST_NAME()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_cognito.ProviderAttribute", "APPLE_LAST_NAME")
end

.APPLE_NAMEAWSCDK::Cognito::ProviderAttribute

The name attribute provided by Apple.

Returns:

  • (AWSCDK::Cognito::ProviderAttribute)


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

def self.APPLE_NAME()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_cognito.ProviderAttribute", "APPLE_NAME")
end

.FACEBOOK_BIRTHDAYAWSCDK::Cognito::ProviderAttribute

The birthday attribute provided by Facebook.

Returns:

  • (AWSCDK::Cognito::ProviderAttribute)


93
94
95
# File 'cognito/provider_attribute.rb', line 93

def self.FACEBOOK_BIRTHDAY()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_cognito.ProviderAttribute", "FACEBOOK_BIRTHDAY")
end

.FACEBOOK_EMAILAWSCDK::Cognito::ProviderAttribute

The email attribute provided by Facebook.

Returns:

  • (AWSCDK::Cognito::ProviderAttribute)


100
101
102
# File 'cognito/provider_attribute.rb', line 100

def self.FACEBOOK_EMAIL()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_cognito.ProviderAttribute", "FACEBOOK_EMAIL")
end

.FACEBOOK_FIRST_NAMEAWSCDK::Cognito::ProviderAttribute

The first name attribute provided by Facebook.

Returns:

  • (AWSCDK::Cognito::ProviderAttribute)


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

def self.FACEBOOK_FIRST_NAME()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_cognito.ProviderAttribute", "FACEBOOK_FIRST_NAME")
end

.FACEBOOK_GENDERAWSCDK::Cognito::ProviderAttribute

The gender attribute provided by Facebook.

Returns:

  • (AWSCDK::Cognito::ProviderAttribute)


114
115
116
# File 'cognito/provider_attribute.rb', line 114

def self.FACEBOOK_GENDER()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_cognito.ProviderAttribute", "FACEBOOK_GENDER")
end

.FACEBOOK_IDAWSCDK::Cognito::ProviderAttribute

The user id attribute provided by Facebook.

Returns:

  • (AWSCDK::Cognito::ProviderAttribute)


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

def self.FACEBOOK_ID()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_cognito.ProviderAttribute", "FACEBOOK_ID")
end

.FACEBOOK_LAST_NAMEAWSCDK::Cognito::ProviderAttribute

The last name attribute provided by Facebook.

Returns:

  • (AWSCDK::Cognito::ProviderAttribute)


128
129
130
# File 'cognito/provider_attribute.rb', line 128

def self.FACEBOOK_LAST_NAME()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_cognito.ProviderAttribute", "FACEBOOK_LAST_NAME")
end

.FACEBOOK_LOCALEAWSCDK::Cognito::ProviderAttribute

The locale attribute provided by Facebook.

Returns:

  • (AWSCDK::Cognito::ProviderAttribute)


135
136
137
# File 'cognito/provider_attribute.rb', line 135

def self.FACEBOOK_LOCALE()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_cognito.ProviderAttribute", "FACEBOOK_LOCALE")
end

.FACEBOOK_MIDDLE_NAMEAWSCDK::Cognito::ProviderAttribute

The middle name attribute provided by Facebook.

Returns:

  • (AWSCDK::Cognito::ProviderAttribute)


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

def self.FACEBOOK_MIDDLE_NAME()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_cognito.ProviderAttribute", "FACEBOOK_MIDDLE_NAME")
end

.FACEBOOK_NAMEAWSCDK::Cognito::ProviderAttribute

The name attribute provided by Facebook.

Returns:

  • (AWSCDK::Cognito::ProviderAttribute)


149
150
151
# File 'cognito/provider_attribute.rb', line 149

def self.FACEBOOK_NAME()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_cognito.ProviderAttribute", "FACEBOOK_NAME")
end

.GOOGLE_BIRTHDAYSAWSCDK::Cognito::ProviderAttribute

The birthday attribute provided by Google.

Returns:

  • (AWSCDK::Cognito::ProviderAttribute)


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

def self.GOOGLE_BIRTHDAYS()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_cognito.ProviderAttribute", "GOOGLE_BIRTHDAYS")
end

.GOOGLE_EMAILAWSCDK::Cognito::ProviderAttribute

The email attribute provided by Google.

Returns:

  • (AWSCDK::Cognito::ProviderAttribute)


163
164
165
# File 'cognito/provider_attribute.rb', line 163

def self.GOOGLE_EMAIL()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_cognito.ProviderAttribute", "GOOGLE_EMAIL")
end

.GOOGLE_EMAIL_VERIFIEDAWSCDK::Cognito::ProviderAttribute

The email verified attribute provided by Google.

Returns:

  • (AWSCDK::Cognito::ProviderAttribute)


170
171
172
# File 'cognito/provider_attribute.rb', line 170

def self.GOOGLE_EMAIL_VERIFIED()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_cognito.ProviderAttribute", "GOOGLE_EMAIL_VERIFIED")
end

.GOOGLE_FAMILY_NAMEAWSCDK::Cognito::ProviderAttribute

The family name attribute provided by Google.

Returns:

  • (AWSCDK::Cognito::ProviderAttribute)


177
178
179
# File 'cognito/provider_attribute.rb', line 177

def self.GOOGLE_FAMILY_NAME()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_cognito.ProviderAttribute", "GOOGLE_FAMILY_NAME")
end

.GOOGLE_GENDERAWSCDK::Cognito::ProviderAttribute

The gender attribute provided by Google.

Returns:

  • (AWSCDK::Cognito::ProviderAttribute)


184
185
186
# File 'cognito/provider_attribute.rb', line 184

def self.GOOGLE_GENDER()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_cognito.ProviderAttribute", "GOOGLE_GENDER")
end

.GOOGLE_GIVEN_NAMEAWSCDK::Cognito::ProviderAttribute

The given name attribute provided by Google.

Returns:

  • (AWSCDK::Cognito::ProviderAttribute)


191
192
193
# File 'cognito/provider_attribute.rb', line 191

def self.GOOGLE_GIVEN_NAME()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_cognito.ProviderAttribute", "GOOGLE_GIVEN_NAME")
end

.GOOGLE_NAMEAWSCDK::Cognito::ProviderAttribute

The name attribute provided by Google.

Returns:

  • (AWSCDK::Cognito::ProviderAttribute)


198
199
200
# File 'cognito/provider_attribute.rb', line 198

def self.GOOGLE_NAME()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_cognito.ProviderAttribute", "GOOGLE_NAME")
end

.GOOGLE_NAMESAWSCDK::Cognito::ProviderAttribute

The name attribute provided by Google.

Returns:

  • (AWSCDK::Cognito::ProviderAttribute)


205
206
207
# File 'cognito/provider_attribute.rb', line 205

def self.GOOGLE_NAMES()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_cognito.ProviderAttribute", "GOOGLE_NAMES")
end

.GOOGLE_PHONE_NUMBERSAWSCDK::Cognito::ProviderAttribute

The phone number attribute provided by Google.

Returns:

  • (AWSCDK::Cognito::ProviderAttribute)


212
213
214
# File 'cognito/provider_attribute.rb', line 212

def self.GOOGLE_PHONE_NUMBERS()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_cognito.ProviderAttribute", "GOOGLE_PHONE_NUMBERS")
end

.GOOGLE_PICTUREAWSCDK::Cognito::ProviderAttribute

The picture attribute provided by Google.

Returns:

  • (AWSCDK::Cognito::ProviderAttribute)


219
220
221
# File 'cognito/provider_attribute.rb', line 219

def self.GOOGLE_PICTURE()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_cognito.ProviderAttribute", "GOOGLE_PICTURE")
end

.jsii_overridable_methodsObject



12
13
14
15
16
# File 'cognito/provider_attribute.rb', line 12

def self.jsii_overridable_methods
  {
    :attribute_name => { kind: :property, name: "attributeName", is_optional: false },
  }
end

.other(attribute_name) ⇒ AWSCDK::Cognito::ProviderAttribute

Use this to specify an attribute from the identity provider that is not pre-defined in the CDK.

Parameters:

  • attribute_name (String)

    the attribute value string as recognized by the provider.

Returns:

  • (AWSCDK::Cognito::ProviderAttribute)


22
23
24
25
# File 'cognito/provider_attribute.rb', line 22

def self.other(attribute_name)
  Jsii::Type.check_type(attribute_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "attributeName")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_cognito.ProviderAttribute", "other", [attribute_name])
end

Instance Method Details

#attribute_nameString

The attribute value string as recognized by the provider.

Returns:

  • (String)


226
227
228
# File 'cognito/provider_attribute.rb', line 226

def attribute_name()
  jsii_get_property("attributeName")
end