Class: Aws::CognitoIdentityProvider::Types::AdminCreateUserConfigType

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-cognitoidentityprovider/types.rb

Overview

The configuration for creating a new user profile.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

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.

Returns:

  • (Boolean) 


257
258
259
260
261
262
263
 
# File '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].

[1]: docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pool-settings-message-customizations.html#cognito-user-pool-settings-user-invitation-message-customization

Returns:



257
258
259
260
261
262
263
 
# File '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.

<note markdown=“1”> If you set a value for ‘TemporaryPasswordValidityDays` in `PasswordPolicy`, that value will be used, and `UnusedAccountValidityDays` will be no longer be an available parameter for that user pool.

</note>

Returns:

  • (Integer) 


257
258
259
260
261
262
263
 
# File '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