Class: AWSCDK::Cognito::CustomAttributeProps

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

Overview

Constraints that can be applied to a custom attribute of any type.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(mutable: nil) ⇒ CustomAttributeProps

Returns a new instance of CustomAttributeProps.

Parameters:

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

    Specifies whether the value of the attribute can be changed.



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

def initialize(mutable: nil)
  @mutable = mutable
  Jsii::Type.check_type(@mutable, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJib29sZWFuIn0=")), "mutable") unless @mutable.nil?
end

Instance Attribute Details

#mutable ⇒ Boolean? (readonly)

Note:

Default: false

Specifies whether the value of the attribute can be changed.

For any user pool attribute that's mapped to an identity provider attribute, you must set this parameter to true. Amazon Cognito updates mapped attributes when users sign in to your application through an identity provider. If an attribute is immutable, Amazon Cognito throws an error when it attempts to update the attribute.

Returns:

  • (Boolean, nil) 


21
22
23
 
# File 'cognito/custom_attribute_props.rb', line 21

def mutable
  @mutable
end

Class Method Details

.jsii_properties ⇒ Object 



23
24
25
26
27
 
# File 'cognito/custom_attribute_props.rb', line 23

def self.jsii_properties
  {
    :mutable => "mutable",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



29
30
31
32
33
34
35
 
# File 'cognito/custom_attribute_props.rb', line 29

def to_jsii
  result = {}
  result.merge!({
    "mutable" => @mutable,
  })
  result.compact
end