user_stack_associations
Creates, updates, deletes, gets or lists a user_stack_associations resource.
Overview
| Name | user_stack_associations |
| Type | Resource |
| Id | aws.appstream.user_stack_associations |
Fields
The following fields are returned by SELECT queries:
- describe_user_stack_associations
| Name | Datatype | Description |
|---|---|---|
authentication_type | string | The authentication type for the user. (API, SAML, USERPOOL, AWS_AD) |
send_email_notification | boolean | Specifies whether a welcome email is sent to a user after the user is created in the user pool. |
stack_name | string | The name of the stack that is associated with the user. |
user_name | string | The email address of the user who is associated with the stack. Users' email addresses are case-sensitive. (pattern: <code>[\p{L}\p{M}\p{S}\p{N}\p{P}]+</code>) |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
describe_user_stack_associations | select | region | Retrieves a list that describes the UserStackAssociation objects. You must specify either or both of the following: The stack name The user name (email address of the user associated with the stack) and the authentication type for the user |
Parameters
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
region | string | AWS region (default: us-east-1) |
SELECT examples
- describe_user_stack_associations
Retrieves a list that describes the UserStackAssociation objects. You must specify either or both of the following: The stack name The user name (email address of the user associated with the stack) and the authentication type for the user
SELECT
authentication_type,
send_email_notification,
stack_name,
user_name
FROM aws.appstream.user_stack_associations
WHERE region = '{{ region }}' -- required
;