AWS::AppStream::StackUserAssociation
The AWS::AppStream::StackUserAssociation
resource associates the specified users with the specified stacks for Amazon AppStream 2.0. Users in an AppStream 2.0 user pool cannot be assigned to stacks with fleets that are joined to an Active Directory domain.
Syntax
To declare this entity in your AWS CloudFormation template, use the following syntax:
JSON
{ "Type" : "AWS::AppStream::StackUserAssociation", "Properties" : { "AuthenticationType" :
String
, "SendEmailNotification" :Boolean
, "StackName" :String
, "UserName" :String
} }
YAML
Type: AWS::AppStream::StackUserAssociation Properties: AuthenticationType:
String
SendEmailNotification:Boolean
StackName:String
UserName:String
Properties
AuthenticationType
-
The authentication type for the user who is associated with the stack. You must specify USERPOOL.
Required: Yes
Type: String
Allowed values:
API | SAML | USERPOOL | AWS_AD
Update requires: Replacement
SendEmailNotification
-
Specifies whether a welcome email is sent to a user after the user is created in the user pool.
Required: No
Type: Boolean
Update requires: Replacement
StackName
-
The name of the stack that is associated with the user.
Required: Yes
Type: String
Minimum:
1
Update requires: Replacement
UserName
-
The email address of the user who is associated with the stack.
Note
Users' email addresses are case-sensitive.
Required: Yes
Type: String
Pattern:
[\p{L}\p{M}\p{S}\p{N}\p{P}]+
Minimum:
1
Maximum:
128
Update requires: Replacement
See also
-
BatchAssociateUserStack in the Amazon AppStream 2.0 API Reference