Class: Aws::CognitoIdentityProvider::Types::AdminCreateUserConfigType
- Inherits:
-
Struct
- Object
- Struct
- Aws::CognitoIdentityProvider::Types::AdminCreateUserConfigType
- Defined in:
- gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb
Overview
The configuration for creating a new user profile.
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#allow_admin_create_user_only ⇒ Boolean
Set to
True
if only the administrator is allowed to create user profiles. -
#invite_message_template ⇒ Types::MessageTemplateType
The message template to be used for the welcome message to new users.
-
#unused_account_validity_days ⇒ Integer
The user account expiration limit, in days, after which a new account that hasn't signed in is no longer usable.
Instance Attribute Details
#allow_admin_create_user_only ⇒ Boolean
Set to True
if only the administrator is allowed to create user
profiles. Set to False
if users can sign themselves up via an app.
257 258 259 260 261 262 263 |
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 257 class AdminCreateUserConfigType < Struct.new( :allow_admin_create_user_only, :unused_account_validity_days, :invite_message_template) SENSITIVE = [] include Aws::Structure end |
#invite_message_template ⇒ Types::MessageTemplateType
The message template to be used for the welcome message to new users.
See also Customizing User Invitation Messages.
257 258 259 260 261 262 263 |
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 257 class AdminCreateUserConfigType < Struct.new( :allow_admin_create_user_only, :unused_account_validity_days, :invite_message_template) SENSITIVE = [] include Aws::Structure end |
#unused_account_validity_days ⇒ Integer
The user account expiration limit, in days, after which a new
account that hasn't signed in is no longer usable. To reset the
account after that time limit, you must call AdminCreateUser
again, specifying "RESEND"
for the MessageAction
parameter. The
default value for this parameter is 7.
TemporaryPasswordValidityDays
in
PasswordPolicy
, that value will be used, and
UnusedAccountValidityDays
will be no longer be an available
parameter for that user pool.
257 258 259 260 261 262 263 |
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 257 class AdminCreateUserConfigType < Struct.new( :allow_admin_create_user_only, :unused_account_validity_days, :invite_message_template) SENSITIVE = [] include Aws::Structure end |