Package software.amazon.awscdk.cfnpropertymixins.services.appstream

Class CfnUserPropsMixin.Builder

java.lang.Object

software.amazon.awscdk.cfnpropertymixins.services.appstream.CfnUserPropsMixin.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnUserPropsMixin>

Enclosing class:

CfnUserPropsMixin

@Stability(Stable)
public static final class CfnUserPropsMixin.Builder
extends Object
implements software.amazon.jsii.Builder<CfnUserPropsMixin>

A fluent builder for CfnUserPropsMixin.

Method Summary

Modifier and Type	Method	Description
CfnUserPropsMixin.Builder	authenticationType(String authenticationType)	The authentication type for the user.
CfnUserPropsMixin	build()
static CfnUserPropsMixin.Builder	create()
static CfnUserPropsMixin.Builder	create(CfnPropertyMixinOptions options)
CfnUserPropsMixin.Builder	firstName(String firstName)	The first name, or given name, of the user.
CfnUserPropsMixin.Builder	lastName(String lastName)	The last name, or surname, of the user.
CfnUserPropsMixin.Builder	messageAction(String messageAction)	The action to take for the welcome email that is sent to a user after the user is created in the user pool.
CfnUserPropsMixin.Builder	userName(String userName)	The email address of the user.

Methods inherited from class java.lang.Object

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

Method Details

create

@Stability(Stable)
public static CfnUserPropsMixin.Builder create(CfnPropertyMixinOptions options)

Parameters:

options - Mixin options.

Returns:

a new instance of CfnUserPropsMixin.Builder.

create

@Stability(Stable)
public static CfnUserPropsMixin.Builder create()

Returns:

a new instance of CfnUserPropsMixin.Builder.

authenticationType

@Stability(Stable)
public CfnUserPropsMixin.Builder authenticationType(String authenticationType)

The authentication type for the user.

You must specify USERPOOL.

Parameters:

authenticationType - The authentication type for the user. This parameter is required.

Returns:

this

See Also:

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

firstName

@Stability(Stable)
public CfnUserPropsMixin.Builder firstName(String firstName)

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

Parameters:

firstName - The first name, or given name, of the user. This parameter is required.

Returns:

this

See Also:

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

lastName

@Stability(Stable)
public CfnUserPropsMixin.Builder lastName(String lastName)

The last name, or surname, of the user.

Parameters:

lastName - The last name, or surname, of the user. This parameter is required.

Returns:

this

See Also:

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

messageAction

@Stability(Stable)
public CfnUserPropsMixin.Builder messageAction(String messageAction)

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.

Parameters:

messageAction - The action to take for the welcome email that is sent to a user after the user is created in the user pool. This parameter is required.

Returns:

this

See Also:

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

userName

@Stability(Stable)
public CfnUserPropsMixin.Builder userName(String userName)

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.

Parameters:

userName - The email address of the user. This parameter is required.

Returns:

this

See Also:

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

build

@Stability(Stable)
public CfnUserPropsMixin build()

Specified by:

build in interface software.amazon.jsii.Builder<CfnUserPropsMixin>

Returns:

a newly built instance of CfnUserPropsMixin.