Class StringAttribute.Builder

java.lang.Object
software.amazon.awscdk.services.cognito.StringAttribute.Builder
All Implemented Interfaces:
software.amazon.jsii.Builder<StringAttribute>
Enclosing class:
StringAttribute

@Stability(Stable) public static final class StringAttribute.Builder extends Object implements software.amazon.jsii.Builder<StringAttribute>
A fluent builder for StringAttribute.
  • Method Details

    • create

      @Stability(Stable) public static StringAttribute.Builder create()
      Returns:
      a new instance of StringAttribute.Builder.
    • maxLen

      @Stability(Stable) public StringAttribute.Builder maxLen(Number maxLen)
      Maximum length of this attribute.

      Default: 2048

      Parameters:
      maxLen - Maximum length of this attribute. This parameter is required.
      Returns:
      this
    • minLen

      @Stability(Stable) public StringAttribute.Builder minLen(Number minLen)
      Minimum length of this attribute.

      Default: 0

      Parameters:
      minLen - Minimum length of this attribute. This parameter is required.
      Returns:
      this
    • mutable

      @Stability(Stable) public StringAttribute.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 StringAttribute build()
      Specified by:
      build in interface software.amazon.jsii.Builder<StringAttribute>
      Returns:
      a newly built instance of StringAttribute.