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

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

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

Overview

Note:

When making an API call, you may pass AdminCreateUserConfigType data as a 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 configuration for creating a new user profile.

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)


301
302
303
304
305
306
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 301

class AdminCreateUserConfigType < Struct.new(
  :allow_admin_create_user_only,
  :unused_account_validity_days,
  :invite_message_template)
  include Aws::Structure
end

#invite_message_templateTypes::MessageTemplateType

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

See also Customizing User Invitation Messages.



301
302
303
304
305
306
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 301

class AdminCreateUserConfigType < Struct.new(
  :allow_admin_create_user_only,
  :unused_account_validity_days,
  :invite_message_template)
  include Aws::Structure
end

#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)


301
302
303
304
305
306
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 301

class AdminCreateUserConfigType < Struct.new(
  :allow_admin_create_user_only,
  :unused_account_validity_days,
  :invite_message_template)
  include Aws::Structure
end