Package software.amazon.awscdk.services.cognito

Class NumberAttribute.Builder

java.lang.Object

software.amazon.awscdk.services.cognito.NumberAttribute.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<NumberAttribute>

Enclosing class:

NumberAttribute

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

A fluent builder for NumberAttribute.

Method Summary

Modifier and Type	Method	Description
NumberAttribute	build()
static NumberAttribute.Builder	create()
NumberAttribute.Builder	max(Number max)	Maximum value of this attribute.
NumberAttribute.Builder	min(Number min)	Minimum value of this attribute.
NumberAttribute.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 NumberAttribute.Builder create()

Returns:

a new instance of NumberAttribute.Builder.

max

@Stability(Stable)
public NumberAttribute.Builder max(Number max)

Maximum value of this attribute.

Default: - no maximum value

Parameters:

max - Maximum value of this attribute. This parameter is required.

Returns:

this

min

@Stability(Stable)
public NumberAttribute.Builder min(Number min)

Minimum value of this attribute.

Default: - no minimum value

Parameters:

min - Minimum value of this attribute. This parameter is required.

Returns:

this

mutable

@Stability(Stable)
public NumberAttribute.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 NumberAttribute build()

Specified by:

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

Returns:

a newly built instance of NumberAttribute.