CfnUserProps

class aws_cdk.aws_appstream.CfnUserProps(*, authentication_type, user_name, first_name=None, last_name=None, message_action=None)

Bases: object

Properties for defining a CfnUser.

Parameters
  • authentication_type (str) – The authentication type for the user. You must specify USERPOOL.

  • user_name (str) – 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.

  • first_name (Optional[str]) – The first name, or given name, of the user.

  • last_name (Optional[str]) – The last name, or surname, of the user.

  • message_action (Optional[str]) – 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. .. epigraph:: 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.

Link

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

ExampleMetadata

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_appstream as appstream

cfn_user_props = appstream.CfnUserProps(
    authentication_type="authenticationType",
    user_name="userName",

    # the properties below are optional
    first_name="firstName",
    last_name="lastName",
    message_action="messageAction"
)

Attributes

authentication_type

The authentication type for the user.

You must specify USERPOOL.

Link

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

Return type

str

first_name

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

Link

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

Return type

Optional[str]

last_name

The last name, or surname, of the user.

Link

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

Return type

Optional[str]

message_action

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. .. epigraph:

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.
Link

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

Return type

Optional[str]

user_name

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.

Link

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

Return type

str