Class CfnUserPool.SchemaAttributeProperty.Jsii$Proxy
- All Implemented Interfaces:
CfnUserPool.SchemaAttributeProperty
,software.amazon.jsii.JsiiSerializable
- Enclosing interface:
CfnUserPool.SchemaAttributeProperty
CfnUserPool.SchemaAttributeProperty
-
Nested Class Summary
Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject
software.amazon.jsii.JsiiObject.InitializationMode
Nested classes/interfaces inherited from interface software.amazon.awscdk.services.cognito.CfnUserPool.SchemaAttributeProperty
CfnUserPool.SchemaAttributeProperty.Builder, CfnUserPool.SchemaAttributeProperty.Jsii$Proxy
-
Constructor Summary
ConstructorsModifierConstructorDescriptionprotected
Constructor that initializes the object based on literal property values passed by theCfnUserPool.SchemaAttributeProperty.Builder
.protected
Jsii$Proxy
(software.amazon.jsii.JsiiObjectRef objRef) Constructor that initializes the object based on values retrieved from the JsiiObject. -
Method Summary
Modifier and TypeMethodDescriptioncom.fasterxml.jackson.databind.JsonNode
final boolean
final String
The data format of the values for your attribute.final Object
final Object
Specifies whether the value of the attribute can be changed.final String
getName()
The name of your user pool attribute.final Object
Specifies the constraints for an attribute of the number type.final Object
Specifies whether a user pool attribute is required.final Object
Specifies the constraints for an attribute of the string type.final int
hashCode()
Methods inherited from class software.amazon.jsii.JsiiObject
jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet
-
Constructor Details
-
Jsii$Proxy
protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef) Constructor that initializes the object based on values retrieved from the JsiiObject.- Parameters:
objRef
- Reference to the JSII managed object.
-
Jsii$Proxy
Constructor that initializes the object based on literal property values passed by theCfnUserPool.SchemaAttributeProperty.Builder
.
-
-
Method Details
-
getAttributeDataType
Description copied from interface:CfnUserPool.SchemaAttributeProperty
The data format of the values for your attribute.When you choose an
AttributeDataType
, Amazon Cognito validates the input against the data type. A custom attribute value in your user's ID token is always a string, for example"custom:isMember" : "true"
or"custom:YearsAsMember" : "12"
.- Specified by:
getAttributeDataType
in interfaceCfnUserPool.SchemaAttributeProperty
- See Also:
-
getDeveloperOnlyAttribute
Description copied from interface:CfnUserPool.SchemaAttributeProperty
We recommend that you use WriteAttributes in the user pool client to control how attributes can be mutated for new use cases instead of using
DeveloperOnlyAttribute
.Specifies whether the attribute type is developer only. This attribute can only be modified by an administrator. Users will not be able to modify this attribute using their access token.
- Specified by:
getDeveloperOnlyAttribute
in interfaceCfnUserPool.SchemaAttributeProperty
- See Also:
-
getMutable
Description copied from interface:CfnUserPool.SchemaAttributeProperty
Specifies whether the value of the attribute can be changed.Any user pool attribute whose value you map from an IdP attribute must be mutable, with a parameter value of
true
. Amazon Cognito updates mapped attributes when users sign in to your application through an IdP. If an attribute is immutable, Amazon Cognito throws an error when it attempts to update the attribute. For more information, see Specifying Identity Provider Attribute Mappings for Your User Pool .- Specified by:
getMutable
in interfaceCfnUserPool.SchemaAttributeProperty
- See Also:
-
getName
Description copied from interface:CfnUserPool.SchemaAttributeProperty
The name of your user pool attribute.When you create or update a user pool, adding a schema attribute creates a custom or developer-only attribute. When you add an attribute with a
Name
value ofMyAttribute
, Amazon Cognito creates the custom attributecustom:MyAttribute
. WhenDeveloperOnlyAttribute
istrue
, Amazon Cognito creates your attribute asdev:MyAttribute
. In an operation that describes a user pool, Amazon Cognito returns this value asvalue
for standard attributes,custom:value
for custom attributes, anddev:value
for developer-only attributes..- Specified by:
getName
in interfaceCfnUserPool.SchemaAttributeProperty
- See Also:
-
getNumberAttributeConstraints
Description copied from interface:CfnUserPool.SchemaAttributeProperty
Specifies the constraints for an attribute of the number type.- Specified by:
getNumberAttributeConstraints
in interfaceCfnUserPool.SchemaAttributeProperty
- See Also:
-
getRequired
Description copied from interface:CfnUserPool.SchemaAttributeProperty
Specifies whether a user pool attribute is required.If the attribute is required and the user doesn't provide a value, registration or sign-in will fail.
- Specified by:
getRequired
in interfaceCfnUserPool.SchemaAttributeProperty
- See Also:
-
getStringAttributeConstraints
Description copied from interface:CfnUserPool.SchemaAttributeProperty
Specifies the constraints for an attribute of the string type.- Specified by:
getStringAttributeConstraints
in interfaceCfnUserPool.SchemaAttributeProperty
- See Also:
-
$jsii$toJson
@Internal public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()- Specified by:
$jsii$toJson
in interfacesoftware.amazon.jsii.JsiiSerializable
-
equals
-
hashCode
public final int hashCode()
-