Package software.amazon.awscdk.services.cognito

Class StandardAttribute.Builder

java.lang.Object

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

All Implemented Interfaces:

software.amazon.jsii.Builder<StandardAttribute>

Enclosing interface:

StandardAttribute

@Stability(Stable)
public static final class StandardAttribute.Builder
extends Object
implements software.amazon.jsii.Builder<StandardAttribute>

A builder for StandardAttribute

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
StandardAttribute	build()	Builds the configured instance.
StandardAttribute.Builder	mutable(Boolean mutable)	Sets the value of StandardAttribute.getMutable()
StandardAttribute.Builder	required(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 Details

Builder

public Builder()

Method Details

mutable

@Stability(Stable)
public StandardAttribute.Builder mutable(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

@Stability(Stable)
public StandardAttribute.Builder required(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

@Stability(Stable)
public StandardAttribute build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<StandardAttribute>

Returns:

a new instance of StandardAttribute

Throws:

NullPointerException - if any required attribute was not provided