StringAttributeProps

class aws_cdk.aws_cognito.StringAttributeProps(*, max_len=None, min_len=None, mutable=None)

Bases: aws_cdk.aws_cognito.StringAttributeConstraints, aws_cdk.aws_cognito.CustomAttributeProps

__init__(*, max_len=None, min_len=None, mutable=None)

Props for constructing a StringAttr.

Parameters
  • max_len (Union[int, float, None]) – Maximum length of this attribute. Default: 2048

  • min_len (Union[int, float, None]) – Minimum length of this attribute. Default: 0

  • mutable (Optional[bool]) – 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

stability :stability: experimental

Return type

None

Attributes

max_len

Maximum length of this attribute.

default :default: 2048

stability :stability: experimental

Return type

Union[int, float, None]

min_len

Minimum length of this attribute.

default :default: 0

stability :stability: experimental

Return type

Union[int, float, None]

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 :default: false

stability :stability: experimental

Return type

Optional[bool]