Class CfnUserPoolPropsMixin.SchemaAttributeProperty.Builder
java.lang.Object
software.amazon.awscdk.cfnpropertymixins.services.cognito.CfnUserPoolPropsMixin.SchemaAttributeProperty.Builder
- All Implemented Interfaces:
software.amazon.jsii.Builder<CfnUserPoolPropsMixin.SchemaAttributeProperty>
- Enclosing interface:
CfnUserPoolPropsMixin.SchemaAttributeProperty
@Stability(Stable)
public static final class CfnUserPoolPropsMixin.SchemaAttributeProperty.Builder
extends Object
implements software.amazon.jsii.Builder<CfnUserPoolPropsMixin.SchemaAttributeProperty>
A builder for
CfnUserPoolPropsMixin.SchemaAttributeProperty-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionattributeDataType(String attributeDataType) Sets the value ofCfnUserPoolPropsMixin.SchemaAttributeProperty.getAttributeDataType()build()Builds the configured instance.developerOnlyAttribute(Boolean developerOnlyAttribute) developerOnlyAttribute(IResolvable developerOnlyAttribute) Sets the value ofCfnUserPoolPropsMixin.SchemaAttributeProperty.getMutable()mutable(IResolvable mutable) Sets the value ofCfnUserPoolPropsMixin.SchemaAttributeProperty.getMutable()Sets the value ofCfnUserPoolPropsMixin.SchemaAttributeProperty.getName()numberAttributeConstraints(CfnUserPoolPropsMixin.NumberAttributeConstraintsProperty numberAttributeConstraints) numberAttributeConstraints(IResolvable numberAttributeConstraints) Sets the value ofCfnUserPoolPropsMixin.SchemaAttributeProperty.getRequired()required(IResolvable required) Sets the value ofCfnUserPoolPropsMixin.SchemaAttributeProperty.getRequired()stringAttributeConstraints(CfnUserPoolPropsMixin.StringAttributeConstraintsProperty stringAttributeConstraints) stringAttributeConstraints(IResolvable stringAttributeConstraints)
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
attributeDataType
@Stability(Stable) public CfnUserPoolPropsMixin.SchemaAttributeProperty.Builder attributeDataType(String attributeDataType) Sets the value ofCfnUserPoolPropsMixin.SchemaAttributeProperty.getAttributeDataType()- Parameters:
attributeDataType- The data format of the values for your attribute. When you choose anAttributeDataType, 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".- Returns:
this
-
developerOnlyAttribute
@Stability(Stable) public CfnUserPoolPropsMixin.SchemaAttributeProperty.Builder developerOnlyAttribute(Boolean developerOnlyAttribute) - Parameters:
developerOnlyAttribute-
Specifies whether the attribute type is developer only. This attribute can only be modified by an administrator. Users won't be able to modify this attribute using their access token. For example,You should use WriteAttributes in the user pool client to control how attributes can be mutated for new use cases instead of using
DeveloperOnlyAttribute.DeveloperOnlyAttributecan be modified using AdminUpdateUserAttributes but can't be updated using UpdateUserAttributes.- Returns:
this
-
developerOnlyAttribute
@Stability(Stable) public CfnUserPoolPropsMixin.SchemaAttributeProperty.Builder developerOnlyAttribute(IResolvable developerOnlyAttribute) - Parameters:
developerOnlyAttribute-
Specifies whether the attribute type is developer only. This attribute can only be modified by an administrator. Users won't be able to modify this attribute using their access token. For example,You should use WriteAttributes in the user pool client to control how attributes can be mutated for new use cases instead of using
DeveloperOnlyAttribute.DeveloperOnlyAttributecan be modified using AdminUpdateUserAttributes but can't be updated using UpdateUserAttributes.- Returns:
this
-
mutable
@Stability(Stable) public CfnUserPoolPropsMixin.SchemaAttributeProperty.Builder mutable(Boolean mutable) Sets the value ofCfnUserPoolPropsMixin.SchemaAttributeProperty.getMutable()- Parameters:
mutable- 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 oftrue. 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 .- Returns:
this
-
mutable
@Stability(Stable) public CfnUserPoolPropsMixin.SchemaAttributeProperty.Builder mutable(IResolvable mutable) Sets the value ofCfnUserPoolPropsMixin.SchemaAttributeProperty.getMutable()- Parameters:
mutable- 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 oftrue. 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 .- Returns:
this
-
name
Sets the value ofCfnUserPoolPropsMixin.SchemaAttributeProperty.getName()- Parameters:
name- 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 aNamevalue ofMyAttribute, Amazon Cognito creates the custom attributecustom:MyAttribute. WhenDeveloperOnlyAttributeistrue, Amazon Cognito creates your attribute asdev:MyAttribute. In an operation that describes a user pool, Amazon Cognito returns this value asvaluefor standard attributes,custom:valuefor custom attributes, anddev:valuefor developer-only attributes..- Returns:
this
-
numberAttributeConstraints
@Stability(Stable) public CfnUserPoolPropsMixin.SchemaAttributeProperty.Builder numberAttributeConstraints(IResolvable numberAttributeConstraints) - Parameters:
numberAttributeConstraints- Specifies the constraints for an attribute of the number type.- Returns:
this
-
numberAttributeConstraints
@Stability(Stable) public CfnUserPoolPropsMixin.SchemaAttributeProperty.Builder numberAttributeConstraints(CfnUserPoolPropsMixin.NumberAttributeConstraintsProperty numberAttributeConstraints) - Parameters:
numberAttributeConstraints- Specifies the constraints for an attribute of the number type.- Returns:
this
-
required
@Stability(Stable) public CfnUserPoolPropsMixin.SchemaAttributeProperty.Builder required(Boolean required) Sets the value ofCfnUserPoolPropsMixin.SchemaAttributeProperty.getRequired()- Parameters:
required- 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.- Returns:
this
-
required
@Stability(Stable) public CfnUserPoolPropsMixin.SchemaAttributeProperty.Builder required(IResolvable required) Sets the value ofCfnUserPoolPropsMixin.SchemaAttributeProperty.getRequired()- Parameters:
required- 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.- Returns:
this
-
stringAttributeConstraints
@Stability(Stable) public CfnUserPoolPropsMixin.SchemaAttributeProperty.Builder stringAttributeConstraints(IResolvable stringAttributeConstraints) - Parameters:
stringAttributeConstraints- Specifies the constraints for an attribute of the string type.- Returns:
this
-
stringAttributeConstraints
@Stability(Stable) public CfnUserPoolPropsMixin.SchemaAttributeProperty.Builder stringAttributeConstraints(CfnUserPoolPropsMixin.StringAttributeConstraintsProperty stringAttributeConstraints) - Parameters:
stringAttributeConstraints- Specifies the constraints for an attribute of the string type.- Returns:
this
-
build
Builds the configured instance.- Specified by:
buildin interfacesoftware.amazon.jsii.Builder<CfnUserPoolPropsMixin.SchemaAttributeProperty>- Returns:
- a new instance of
CfnUserPoolPropsMixin.SchemaAttributeProperty - Throws:
NullPointerException- if any required attribute was not provided
-