public static interface CfnUserPool.SchemaAttributeProperty
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import software.amazon.awscdk.services.cognito.*; SchemaAttributeProperty schemaAttributeProperty = SchemaAttributeProperty.builder() .attributeDataType("attributeDataType") .developerOnlyAttribute(false) .mutable(false) .name("name") .numberAttributeConstraints(NumberAttributeConstraintsProperty.builder() .maxValue("maxValue") .minValue("minValue") .build()) .required(false) .stringAttributeConstraints(StringAttributeConstraintsProperty.builder() .maxLength("maxLength") .minLength("minLength") .build()) .build();
Modifier and Type | Interface and Description |
---|---|
static class |
CfnUserPool.SchemaAttributeProperty.Builder
A builder for
CfnUserPool.SchemaAttributeProperty |
static class |
CfnUserPool.SchemaAttributeProperty.Jsii$Proxy
An implementation for
CfnUserPool.SchemaAttributeProperty |
Modifier and Type | Method and Description |
---|---|
static CfnUserPool.SchemaAttributeProperty.Builder |
builder() |
default java.lang.String |
getAttributeDataType()
The attribute data type.
|
default java.lang.Object |
getDeveloperOnlyAttribute()
> We recommend that you use [WriteAttributes](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UserPoolClientType.html#CognitoUserPools-Type-UserPoolClientType-WriteAttributes) in the user pool client to control how attributes can be mutated for new use cases instead of using `DeveloperOnlyAttribute` .
|
default java.lang.Object |
getMutable()
Specifies whether the value of the attribute can be changed.
|
default java.lang.String |
getName()
A schema attribute of the name type.
|
default java.lang.Object |
getNumberAttributeConstraints()
Specifies the constraints for an attribute of the number type.
|
default java.lang.Object |
getRequired()
Specifies whether a user pool attribute is required.
|
default java.lang.Object |
getStringAttributeConstraints()
Specifies the constraints for an attribute of the string type.
|
default java.lang.String getAttributeDataType()
default java.lang.Object getDeveloperOnlyAttribute()
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.
default java.lang.Object getMutable()
For any user pool attribute that is mapped to an IdP attribute, you must set this parameter to 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 .
default java.lang.String getName()
default java.lang.Object getNumberAttributeConstraints()
default java.lang.Object getRequired()
If the attribute is required and the user doesn't provide a value, registration or sign-in will fail.
default java.lang.Object getStringAttributeConstraints()
static CfnUserPool.SchemaAttributeProperty.Builder builder()