StandardAttribute¶
-
class
aws_cdk.aws_cognito.
StandardAttribute
(*, mutable=None, required=None)¶ Bases:
object
Standard attribute that can be marked as required or mutable.
- Parameters
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, this must be set totrue
. 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: truerequired (
Optional
[bool
]) – Specifies whether the attribute is required upon user registration. If the attribute is required and the user does not provide a value, registration or sign-in will fail. Default: false
- See
Attributes
-
mutable
¶ Specifies whether the value of the attribute can be changed.
For any user pool attribute that’s mapped to an identity provider attribute, this must be set 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
true
- Return type
Optional
[bool
]
-
required
¶ Specifies whether the attribute is required upon user registration.
If the attribute is required and the user does not provide a value, registration or sign-in will fail.
- Default
false
- Return type
Optional
[bool
]