Class CfnUserPool.AdminCreateUserConfigProperty

The configuration for AdminCreateUser requests.

Inheritance
System.Object
CfnUserPool.AdminCreateUserConfigProperty
Namespace: Amazon.CDK.AWS.Cognito
Assembly: Amazon.CDK.AWS.Cognito.dll
Syntax (csharp)
public class AdminCreateUserConfigProperty : Object, CfnUserPool.IAdminCreateUserConfigProperty
Syntax (vb)
Public Class AdminCreateUserConfigProperty
    Inherits Object
    Implements CfnUserPool.IAdminCreateUserConfigProperty
Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-admincreateuserconfig.html

ExampleMetadata: fixture=_generated

Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.Cognito;

var adminCreateUserConfigProperty = new AdminCreateUserConfigProperty {
    AllowAdminCreateUserOnly = false,
    InviteMessageTemplate = new InviteMessageTemplateProperty {
        EmailMessage = "emailMessage",
        EmailSubject = "emailSubject",
        SmsMessage = "smsMessage"
    },
    UnusedAccountValidityDays = 123
};

Synopsis

Constructors

AdminCreateUserConfigProperty()

Properties

AllowAdminCreateUserOnly

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

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

The user account expiration limit, in days, after which a new account that hasn't signed in is no longer usable.

Constructors

AdminCreateUserConfigProperty()

public AdminCreateUserConfigProperty()

Properties

AllowAdminCreateUserOnly

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

public object AllowAdminCreateUserOnly { get; set; }
Property Value

System.Object

Remarks

Set to False if users can sign themselves up via an app.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-admincreateuserconfig.html#cfn-cognito-userpool-admincreateuserconfig-allowadmincreateuseronly

InviteMessageTemplate

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

public object InviteMessageTemplate { get; set; }
Property Value

System.Object

Remarks

See also Customizing User Invitation Messages .

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-admincreateuserconfig.html#cfn-cognito-userpool-admincreateuserconfig-invitemessagetemplate

UnusedAccountValidityDays

The user account expiration limit, in days, after which a new account that hasn't signed in is no longer usable.

public Nullable<double> UnusedAccountValidityDays { get; set; }
Property Value

System.Nullable<System.Double>

Remarks

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.

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.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-admincreateuserconfig.html#cfn-cognito-userpool-admincreateuserconfig-unusedaccountvaliditydays

Implements