@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)", date="2023-03-22T19:35:35.473Z") public class CfnUser extends CfnResource implements IInspectable
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();
Modifier and Type | Class and Description |
---|---|
static class |
CfnUser.Builder
A fluent builder for
CfnUser . |
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
IConstruct.Jsii$Default
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
|
Modifier | Constructor and Description |
---|---|
|
CfnUser(Construct scope,
java.lang.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) |
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getAuthenticationType()
The authentication type for the user.
|
protected java.util.Map<java.lang.String,java.lang.Object> |
getCfnProperties() |
java.lang.String |
getFirstName()
The first name, or given name, of the user.
|
java.lang.String |
getLastName()
The last name, or surname, of the user.
|
java.lang.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.
|
java.lang.String |
getUserName()
The email address of the user.
|
void |
inspect(TreeInspector inspector)
Examines the CloudFormation resource and discloses attributes.
|
protected java.util.Map<java.lang.String,java.lang.Object> |
renderProperties(java.util.Map<java.lang.String,java.lang.Object> props) |
void |
setAuthenticationType(java.lang.String value)
The authentication type for the user.
|
void |
setFirstName(java.lang.String value)
The first name, or given name, of the user.
|
void |
setLastName(java.lang.String value)
The last name, or surname, of the user.
|
void |
setMessageAction(java.lang.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(java.lang.String value)
The email address of the user.
|
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties
getRef
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId
getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate
public static final java.lang.String CFN_RESOURCE_TYPE_NAME
protected CfnUser(software.amazon.jsii.JsiiObjectRef objRef)
protected CfnUser(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
public CfnUser(Construct scope, java.lang.String id, CfnUserProps props)
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.public void inspect(TreeInspector inspector)
inspect
in interface IInspectable
inspector
- - tree inspector to collect and process attributes. This parameter is required.protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
renderProperties
in class CfnResource
props
- This parameter is required.protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()
getCfnProperties
in class CfnResource
public java.lang.String getAuthenticationType()
You must specify USERPOOL.
public void setAuthenticationType(java.lang.String value)
You must specify USERPOOL.
public java.lang.String getUserName()
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.
public void setUserName(java.lang.String value)
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.
public java.lang.String getFirstName()
public void setFirstName(java.lang.String value)
public java.lang.String getLastName()
public void setLastName(java.lang.String value)
public java.lang.String getMessageAction()
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.
public void setMessageAction(java.lang.String value)
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.