Class CfnUserPool.AdminCreateUserConfigProperty

The settings for administrator creation of users in a user pool.

Inheritance

object

CfnUserPool.AdminCreateUserConfigProperty

Implements

CfnUserPool.IAdminCreateUserConfigProperty

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.AWS.Cognito

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnUserPool.AdminCreateUserConfigProperty : CfnUserPool.IAdminCreateUserConfigProperty

Syntax (vb)

Public Class CfnUserPool.AdminCreateUserConfigProperty Implements CfnUserPool.IAdminCreateUserConfigProperty

Remarks

Contains settings for allowing user sign-up, customizing invitation messages to new users, and the amount of time before temporary passwords expire.

See: 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()

The settings for administrator creation of users in a user pool.

Properties

AllowAdminCreateUserOnly	The setting for allowing self-service sign-up.
InviteMessageTemplate	The template for the welcome message to new users.
UnusedAccountValidityDays	This parameter is no longer in use.

Constructors

AdminCreateUserConfigProperty()

The settings for administrator creation of users in a user pool.

public AdminCreateUserConfigProperty()

Remarks

Contains settings for allowing user sign-up, customizing invitation messages to new users, and the amount of time before temporary passwords expire.

See: 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
             };

Properties

AllowAdminCreateUserOnly

The setting for allowing self-service sign-up.

public object? AllowAdminCreateUserOnly { get; set; }

Property Value

object

Remarks

When true , only administrators can create new user profiles. When false , users can register themselves and create a new user profile with the SignUp operation.

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

Type union: either bool or IResolvable

InviteMessageTemplate

The template for the welcome message to new users.

public object? InviteMessageTemplate { get; set; }

Property Value

object

Remarks

This template must include the {####} temporary password placeholder if you are creating users with passwords. If your users don't have passwords, you can omit the placeholder.

See also Customizing User Invitation Messages .

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

Type union: either IResolvable or CfnUserPool.IInviteMessageTemplateProperty

UnusedAccountValidityDays

This parameter is no longer in use.

public double? UnusedAccountValidityDays { get; set; }

Property Value

double?

Remarks

The password expiration limit in days for administrator-created users. When this time expires, the user can't sign in with their temporary password. 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.

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

Implements

CfnUserPool.IAdminCreateUserConfigProperty