Package 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, IUserRef, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.116.0 (build 0eddcff)",
           date="2025-10-24T13:34:31.309Z")
@Stability(Stable)
public class CfnUser
extends CfnResource
implements IInspectable, IUserRef

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();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-user.html

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final 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.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

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

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.appstream.IUserRef

IUserRef.Jsii$Default, IUserRef.Jsii$Proxy

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CfnUser(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnUser(software.amazon.jsii.JsiiObjectRef objRef)
	CfnUser(software.constructs.Construct scope, String id, CfnUserProps props)

Method Summary

Modifier and Type	Method	Description
String	getAttrId()
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.
UserReference	getUserRef()	A reference to a User resource.
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, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, 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.constructs.IConstruct

getNode

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

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
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 CfnUserProps props)

Parameters:

scope - Scope in which this resource is defined. This parameter is required.

id - Construct identifier for this resource (unique in its scope). 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.

getAttrId

@Stability(Stable)
@NotNull
public String getAttrId()

getCfnProperties

@Stability(Stable)
@NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getUserRef

@Stability(Stable)
@NotNull
public UserReference getUserRef()

A reference to a User resource.

Specified by:

getUserRef in interface IUserRef

getAuthenticationType

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

The authentication type for the user.

setAuthenticationType

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

The authentication type for the user.

getUserName

@Stability(Stable)
@NotNull
public String getUserName()

The email address of the user.

setUserName

@Stability(Stable)
public void setUserName(@NotNull
 String value)

The email address of the user.

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.

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.