NumberAttribute

class aws_cdk.aws_cognito.NumberAttribute(*, max=None, min=None, mutable=None)

Bases: object

The Number custom attribute type.

ExampleMetadata:

infused

Example:

cognito.UserPool(self, "myuserpool",
    # ...
    standard_attributes=cognito.StandardAttributes(
        fullname=cognito.StandardAttribute(
            required=True,
            mutable=False
        ),
        address=cognito.StandardAttribute(
            required=False,
            mutable=True
        )
    ),
    custom_attributes={
        "myappid": cognito.StringAttribute(min_len=5, max_len=15, mutable=False),
        "callingcode": cognito.NumberAttribute(min=1, max=3, mutable=True),
        "isEmployee": cognito.BooleanAttribute(mutable=True),
        "joinedOn": cognito.DateTimeAttribute()
    }
)
Parameters:
  • max (Union[int, float, None]) – Maximum value of this attribute. Default: - no maximum value

  • min (Union[int, float, None]) – Minimum value of this attribute. Default: - no minimum value

  • 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

Methods

bind()

Bind this custom attribute type to the values as expected by CloudFormation.

Return type:

CustomAttributeConfig