Interface CfnUserProps

All Superinterfaces:
All Known Implementing Classes:

@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:29:55.750Z") @Stability(Stable) public interface CfnUserProps extends
Properties for defining a CfnUser.


 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 CfnUserProps cfnUserProps = CfnUserProps.builder()
         // the properties below are optional
  • Method Details

    • getAuthenticationType

      @Stability(Stable) @NotNull String getAuthenticationType()
      The authentication type for the user.

      You must specify USERPOOL.

    • getUserName

      @Stability(Stable) @NotNull String getUserName()
      The email address of the user.

      Users' email addresses are case-sensitive. During login, if they specify an email address that doesn't use the same capitalization as the email address specified when their user pool account was created, a "user does not exist" error message displays.

    • getFirstName

      @Stability(Stable) @Nullable default String getFirstName()
      The first name, or given name, of the user.
    • getLastName

      @Stability(Stable) @Nullable default String getLastName()
      The last name, or surname, of the user.
    • getMessageAction

      @Stability(Stable) @Nullable default String getMessageAction()
      The action to take for the welcome email that is sent to a user after the user is created in the user pool.

      If you specify SUPPRESS, no email is sent. If you specify RESEND, do not specify the first name or last name of the user. If the value is null, the email is sent.

      The temporary password in the welcome email is valid for only 7 days. If users don’t set their passwords within 7 days, you must send them a new welcome email.

    • builder

      @Stability(Stable) static CfnUserProps.Builder builder()
      a CfnUserProps.Builder of CfnUserProps