Package software.amazon.awscdk.services.cognito

Class BooleanAttribute.Builder

java.lang.Object

software.amazon.awscdk.services.cognito.BooleanAttribute.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<BooleanAttribute>

Enclosing class:

BooleanAttribute

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

A fluent builder for BooleanAttribute.

Method Summary

Modifier and Type	Method	Description
BooleanAttribute	build()
static BooleanAttribute.Builder	create()
BooleanAttribute.Builder	mutable(Boolean mutable)	Specifies whether the value of the attribute can be changed.

Methods inherited from class java.lang.Object

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

Method Details

create

@Stability(Stable)
public static BooleanAttribute.Builder create()

Returns:

a new instance of BooleanAttribute.Builder.

mutable

@Stability(Stable)
public BooleanAttribute.Builder mutable(Boolean mutable)

Specifies whether the value of the attribute can be changed.

For any user pool attribute that's mapped to an identity provider attribute, you must set this parameter 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.

Default: false

Parameters:

mutable - Specifies whether the value of the attribute can be changed. This parameter is required.

Returns:

this

build

@Stability(Stable)
public BooleanAttribute build()

Specified by:

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

Returns:

a newly built instance of BooleanAttribute.