You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

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

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing AdminCreateUserConfigType as input to an Aws::Client method, you can use a vanilla Hash:

{
  allow_admin_create_user_only: false,
  unused_account_validity_days: 1,
  invite_message_template: {
    sms_message: "SmsVerificationMessageType",
    email_message: "EmailVerificationMessageType",
    email_subject: "EmailVerificationSubjectType",
  },
}

The type of configuration for creating a new user profile.

Returned by:

Instance Attribute Summary collapse

Instance Attribute Details

#allow_admin_create_user_onlyBoolean

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)

    Set to True if only the administrator is allowed to create user profiles.

#invite_message_templateTypes::MessageTemplateType

The message template to be used for the welcome message to new users.

Returns:

#unused_account_validity_daysInteger

The user account expiration limit, in days, after which the account 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.

Returns:

  • (Integer)

    The user account expiration limit, in days, after which the account is no longer usable.