software.amazon.awscdk.services.appstream

Class CfnUser

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.appstream.CfnUser

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:36.651Z")
 @Stability(value=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();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnUser.Builder A fluent builder for CfnUser.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnUser(software.constructs.Construct scope, String id, CfnUserProps props) Create a new `AWS::AppStream::User`.
protected	CfnUser(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnUser(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
String	getAuthenticationType() The authentication type for the user.
protected Map<String,Object>	getCfnProperties()
String	getFirstName() The first name, or given name, of the user.
String	getLastName() The last name, or surname, of the user.
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.
String	getUserName() The email address of the user.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setAuthenticationType(String value) The authentication type for the user.
void	setFirstName(String value) The first name, or given name, of the user.
void	setLastName(String value) The last name, or surname, of the user.
void	setMessageAction(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.
void	setUserName(String value) The email address of the user.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnUser

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

CfnUser

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

CfnUser

@Stability(value=Stable)
public CfnUser(@NotNull
                                        software.constructs.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 Detail

inspect

@Stability(value=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(value=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(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getAuthenticationType

@Stability(value=Stable)
 @NotNull
public String getAuthenticationType()

The authentication type for the user.

You must specify USERPOOL.

setAuthenticationType

@Stability(value=Stable)
public void setAuthenticationType(@NotNull
                                                           String value)

The authentication type for the user.

You must specify USERPOOL.

getUserName

@Stability(value=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(value=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(value=Stable)
 @Nullable
public String getFirstName()

The first name, or given name, of the user.

setFirstName

@Stability(value=Stable)
public void setFirstName(@Nullable
                                                  String value)

The first name, or given name, of the user.

getLastName

@Stability(value=Stable)
 @Nullable
public String getLastName()

The last name, or surname, of the user.

setLastName

@Stability(value=Stable)
public void setLastName(@Nullable
                                                 String value)

The last name, or surname, of the user.

getMessageAction

@Stability(value=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(value=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.