stacks

Creates, updates, deletes, gets or lists a stacks resource.

Overview

Name	stacks
Type	Resource
Id	aws.appstream.stacks

Fields

The following fields are returned by SELECT queries:

describe_stacks

Name	Datatype	Description
access_endpoints	array	The list of virtual private cloud (VPC) interface endpoint objects. Users of the stack can connect to WorkSpaces Applications only through the specified endpoints.
agent_access_config	object	The agent access configuration of the stack, if agent access is enabled.
application_settings	object	The persistent application settings for users of the stack.
arn	string	The ARN of the stack. (pattern: <code>^arn:aws(?:-cn|-iso-b|-iso|-us-gov)?:[A-Za-z0-9][A-Za-z0-9_/.-]{0,62}:[A-Za-z0-9_/.-]{0,63}:[A-Za-z0-9_/.-]{0,63}:[A-Za-z0-9][A-Za-z0-9:_/+=,@.\-]{0,1023}$</code>)
content_redirection	object	Configuration for bidirectional URL redirection between the streaming session and the local client. Use HostToClient to redirect URLs from the remote desktop to the local browser.
created_time	string (date-time)	The time the stack was created.
description	string	The description to display.
display_name	string	The stack name to display.
embed_host_domains	array	The domains where WorkSpaces Applications streaming sessions can be embedded in an iframe. You must approve the domains that you want to host embedded WorkSpaces Applications streaming sessions.
feedback_url	string	The URL that users are redirected to after they click the Send Feedback link. If no URL is specified, no Send Feedback link is displayed.
name	string	The name of the stack.
redirect_url	string	The URL that users are redirected to after their streaming session ends.
stack_errors	array	The errors for the stack.
storage_connectors	array	The storage connectors to enable.
streaming_experience_settings	object	The streaming protocol you want your stack to prefer. This can be UDP or TCP. Currently, UDP is only supported in the Windows native client.
user_settings	array	The actions that are enabled or disabled for users during their streaming sessions. By default these actions are enabled.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_stacks	select	region		Retrieves a list that describes one or more specified stacks, if the stack names are provided. Otherwise, all stacks in the account are described.
create_stack	insert	region		Creates a stack to start streaming applications to users. A stack consists of an associated fleet, user access policies, and storage configurations.
update_stack	update	region		Updates the specified fields for the specified stack.
delete_stack	delete	region		Deletes the specified stack. After the stack is deleted, the application streaming environment provided by the stack is no longer available to users. Also, any reservations made for application streaming sessions for the stack are released.

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_stacks

Retrieves a list that describes one or more specified stacks, if the stack names are provided. Otherwise, all stacks in the account are described.

SELECT
access_endpoints,
agent_access_config,
application_settings,
arn,
content_redirection,
created_time,
description,
display_name,
embed_host_domains,
feedback_url,
name,
redirect_url,
stack_errors,
storage_connectors,
streaming_experience_settings,
user_settings
FROM aws.appstream.stacks
WHERE region = '{{ region }}' -- required
;

INSERT examples

create_stack

Creates a stack to start streaming applications to users. A stack consists of an associated fleet, user access policies, and storage configurations.

INSERT INTO aws.appstream.stacks (
Name,
Description,
DisplayName,
StorageConnectors,
RedirectURL,
FeedbackURL,
UserSettings,
ApplicationSettings,
Tags,
AccessEndpoints,
EmbedHostDomains,
StreamingExperienceSettings,
ContentRedirection,
AgentAccessConfig,
region
)
SELECT 
'{{ Name }}',
'{{ Description }}',
'{{ DisplayName }}',
'{{ StorageConnectors }}',
'{{ RedirectURL }}',
'{{ FeedbackURL }}',
'{{ UserSettings }}',
'{{ ApplicationSettings }}',
'{{ Tags }}',
'{{ AccessEndpoints }}',
'{{ EmbedHostDomains }}',
'{{ StreamingExperienceSettings }}',
'{{ ContentRedirection }}',
'{{ AgentAccessConfig }}',
'{{ region }}'
RETURNING
stack
;

Manifest

# Description fields are for documentation purposes
- name: stacks
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the stacks resource.
  - name: Name
    value: "{{ Name }}"
    description: |
      The name of the stack.
  - name: Description
    value: "{{ Description }}"
    description: |
      The description to display.
  - name: DisplayName
    value: "{{ DisplayName }}"
    description: |
      The stack name to display.
  - name: StorageConnectors
    description: |
      The storage connectors to enable.
    value:
      - ConnectorType: "{{ ConnectorType }}"
        ResourceIdentifier: "{{ ResourceIdentifier }}"
        Domains: "{{ Domains }}"
        DomainsRequireAdminConsent: "{{ DomainsRequireAdminConsent }}"
  - name: RedirectURL
    value: "{{ RedirectURL }}"
    description: |
      The URL that users are redirected to after their streaming session ends.
  - name: FeedbackURL
    value: "{{ FeedbackURL }}"
    description: |
      The URL that users are redirected to after they click the Send Feedback link. If no URL is specified, no Send Feedback link is displayed.
  - name: UserSettings
    description: |
      The actions that are enabled or disabled for users during their streaming sessions. By default, these actions are enabled.
    value:
      - Action: "{{ Action }}"
        Permission: "{{ Permission }}"
        MaximumLength: {{ MaximumLength }}
  - name: ApplicationSettings
    description: |
      The persistent application settings for users of a stack. When these settings are enabled, changes that users make to applications and Windows settings are automatically saved after each session and applied to the next session.
    value:
      Enabled: {{ Enabled }}
      SettingsGroup: "{{ SettingsGroup }}"
  - name: Tags
    value: "{{ Tags }}"
    description: |
      The tags to associate with the stack. A tag is a key-value pair, and the value is optional. For example, Environment=Test. If you do not specify a value, Environment=. If you do not specify a value, the value is set to an empty string. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following special characters: _ . : / = +  - @ For more information about tags, see Tagging Your Resources in the Amazon WorkSpaces Applications Administration Guide.
  - name: AccessEndpoints
    description: |
      The list of interface VPC endpoint (interface endpoint) objects. Users of the stack can connect to WorkSpaces Applications only through the specified endpoints.
    value:
      - EndpointType: "{{ EndpointType }}"
        VpceId: "{{ VpceId }}"
  - name: EmbedHostDomains
    value:
      - "{{ EmbedHostDomains }}"
    description: |
      The domains where WorkSpaces Applications streaming sessions can be embedded in an iframe. You must approve the domains that you want to host embedded WorkSpaces Applications streaming sessions.
  - name: StreamingExperienceSettings
    description: |
      The streaming protocol you want your stack to prefer. This can be UDP or TCP. Currently, UDP is only supported in the Windows native client.
    value:
      PreferredProtocol: "{{ PreferredProtocol }}"
  - name: ContentRedirection
    description: |
      Configuration for bidirectional URL redirection between the streaming session and the local client. Use HostToClient to redirect URLs from the remote desktop to the local browser.
    value:
      HostToClient:
        Enabled: {{ Enabled }}
        AllowedUrls:
          - "{{ AllowedUrls }}"
        DeniedUrls:
          - "{{ DeniedUrls }}"
  - name: AgentAccessConfig
    description: |
      The configuration for agent access on the stack. If specified, agent access is enabled for the stack.
    value:
      Settings:
        - AgentAction: "{{ AgentAction }}"
          Permission: "{{ Permission }}"
      S3BucketArn: "{{ S3BucketArn }}"
      ScreenshotsUploadEnabled: {{ ScreenshotsUploadEnabled }}
      ScreenResolution: "{{ ScreenResolution }}"
      ScreenImageFormat: "{{ ScreenImageFormat }}"
      UserControlMode: "{{ UserControlMode }}"

UPDATE examples

update_stack

Updates the specified fields for the specified stack.

UPDATE aws.appstream.stacks
SET 
DisplayName = '{{ DisplayName }}',
Description = '{{ Description }}',
Name = '{{ Name }}',
StorageConnectors = '{{ StorageConnectors }}',
DeleteStorageConnectors = {{ DeleteStorageConnectors }},
RedirectURL = '{{ RedirectURL }}',
FeedbackURL = '{{ FeedbackURL }}',
AttributesToDelete = '{{ AttributesToDelete }}',
UserSettings = '{{ UserSettings }}',
ApplicationSettings = '{{ ApplicationSettings }}',
AccessEndpoints = '{{ AccessEndpoints }}',
EmbedHostDomains = '{{ EmbedHostDomains }}',
StreamingExperienceSettings = '{{ StreamingExperienceSettings }}',
ContentRedirection = '{{ ContentRedirection }}',
AgentAccessConfig = '{{ AgentAccessConfig }}'
WHERE 
region = '{{ region }}' --required
RETURNING
stack;

DELETE examples

delete_stack

Deletes the specified stack. After the stack is deleted, the application streaming environment provided by the stack is no longer available to users. Also, any reservations made for application streaming sessions for the stack are released.

DELETE FROM aws.appstream.stacks
WHERE region = '{{ region }}' --required
;