software.amazon.awscdk.services.cognito

Class StandardAttribute.Builder

java.lang.Object

software.amazon.awscdk.services.cognito.StandardAttribute.Builder

Enclosing interface:

StandardAttribute

public static final class StandardAttribute.Builder
extends java.lang.Object

A builder for StandardAttribute

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
StandardAttribute	build() Builds the configured instance.
StandardAttribute.Builder	mutable(java.lang.Boolean mutable) Sets the value of StandardAttribute.getMutable()
StandardAttribute.Builder	required(java.lang.Boolean required) Sets the value of StandardAttribute.getRequired()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Builder

public Builder()

Method Detail

mutable

public StandardAttribute.Builder mutable(java.lang.Boolean mutable)

Sets the value of StandardAttribute.getMutable()

Parameters:

mutable - Specifies whether the value of the attribute can be changed. For any user pool attribute that's mapped to an identity provider attribute, this must be set 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:

this

required

public StandardAttribute.Builder required(java.lang.Boolean required)

Sets the value of StandardAttribute.getRequired()

Parameters:

required - Specifies whether the attribute is required upon user registration. If the attribute is required and the user does not provide a value, registration or sign-in will fail.

Returns:

this

build

public StandardAttribute build()

Builds the configured instance.

Returns:

a new instance of StandardAttribute

Throws:

java.lang.NullPointerException - if any required attribute was not provided