Package software.amazon.awscdk.services.appstream

Class CfnUser

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.core.Construct
software.amazon.awscdk.core.CfnElement
software.amazon.awscdk.core.CfnRefElement
software.amazon.awscdk.core.CfnResource
software.amazon.awscdk.services.appstream.CfnUser
All Implemented Interfaces:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:29:55.748Z") @Stability(Stable) public class CfnUser extends CfnResource implements IInspectable
A CloudFormation AWS::AppStream::User.

The AWS::AppStream::User resource creates a new user in the AppStream 2.0 user pool.

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.appstream.*;
 CfnUser cfnUser = CfnUser.Builder.create(this, "MyCfnUser")
         .authenticationType("authenticationType")
         .userName("userName")
         // the properties below are optional
         .firstName("firstName")
         .lastName("lastName")
         .messageAction("messageAction")
         .build();

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnUser

      protected CfnUser(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnUser

      protected CfnUser(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnUser

      @Stability(Stable) public CfnUser(@NotNull Construct scope, @NotNull String id, @NotNull CfnUserProps props)
      Create a new AWS::AppStream::User.

      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      This parameter is required.
      props -
      • resource properties.
      This parameter is required.

  • Method Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector -
      • tree inspector to collect and process attributes.
      This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getAuthenticationType

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

      You must specify USERPOOL.

    • setAuthenticationType

      @Stability(Stable) public void setAuthenticationType(@NotNull String value)
      The authentication type for the user.

      You must specify USERPOOL.

    • getUserName

      @Stability(Stable) @NotNull public 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.

    • setUserName

      @Stability(Stable) public void setUserName(@NotNull String value)
      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 public String getFirstName()
      The first name, or given name, of the user.

    • setFirstName

      @Stability(Stable) public void setFirstName(@Nullable String value)
      The first name, or given name, of the user.

    • getLastName

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

    • setLastName

      @Stability(Stable) public void setLastName(@Nullable String value)
      The last name, or surname, of the user.

    • getMessageAction

      @Stability(Stable) @Nullable public 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.

    • setMessageAction

      @Stability(Stable) public void setMessageAction(@Nullable String value)
      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.