aws-cdk-lib.aws_cognito.CfnUserPool.AdminCreateUserConfigProperty

interface AdminCreateUserConfigProperty

LanguageType name
.NETAmazon.CDK.AWS.Cognito.CfnUserPool.AdminCreateUserConfigProperty
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awscognito#CfnUserPool_AdminCreateUserConfigProperty
Javasoftware.amazon.awscdk.services.cognito.CfnUserPool.AdminCreateUserConfigProperty
Pythonaws_cdk.aws_cognito.CfnUserPool.AdminCreateUserConfigProperty
TypeScript aws-cdk-lib » aws_cognito » CfnUserPool » AdminCreateUserConfigProperty

The configuration for AdminCreateUser requests.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_cognito as cognito } from 'aws-cdk-lib';
const adminCreateUserConfigProperty: cognito.CfnUserPool.AdminCreateUserConfigProperty = {
  allowAdminCreateUserOnly: false,
  inviteMessageTemplate: {
    emailMessage: 'emailMessage',
    emailSubject: 'emailSubject',
    smsMessage: 'smsMessage',
  },
  unusedAccountValidityDays: 123,
};

Properties

NameTypeDescription
allowAdminCreateUserOnly?boolean | IResolvableSet to True if only the administrator is allowed to create user profiles.
inviteMessageTemplate?IResolvable | InviteMessageTemplatePropertyThe message template to be used for the welcome message to new users.
unusedAccountValidityDays?numberThe user account expiration limit, in days, after which a new account that hasn't signed in is no longer usable.

allowAdminCreateUserOnly?

Type: boolean | IResolvable (optional)

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.


inviteMessageTemplate?

Type: IResolvable | InviteMessageTemplateProperty (optional)

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

See also Customizing User Invitation Messages .


unusedAccountValidityDays?

Type: number (optional)

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.

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.