theme_for_stacks

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

Overview

Name	theme_for_stacks
Type	Resource
Id	aws.appstream.theme_for_stacks

Fields

The following fields are returned by SELECT queries:

describe_theme_for_stack

Name	Datatype	Description
created_time	string (date-time)	The time the theme was created.
stack_name	string	The stack that has the custom branding theme. (pattern: <code>^[a-zA-Z0-9][a-zA-Z0-9_.-]{0,100}$</code>)
state	string	The state of the theme. (ENABLED, DISABLED)
theme_favicon_url	string	The URL of the icon that displays at the top of a user's browser tab during streaming sessions.
theme_footer_links	array	The website links that display in the catalog page footer.
theme_organization_logo_url	string	The URL of the logo that displays in the catalog page header.
theme_styling	string	The color that is used for the website links, text, buttons, and catalog page background. (LIGHT_BLUE, BLUE, PINK, RED)
theme_title_text	string	The browser tab page title. (pattern: <code>^[-@./#&+\w\s]*$</code>)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_theme_for_stack	select	region		Retrieves a list that describes the theme for a specified stack. A theme is custom branding that customizes the appearance of the streaming application catalog page.
create_theme_for_stack	insert	region, StackName, TitleText, ThemeStyling, OrganizationLogoS3Location, FaviconS3Location		Creates custom branding that customizes the appearance of the streaming application catalog page.
update_theme_for_stack	update	region, StackName		Updates custom branding that customizes the appearance of the streaming application catalog page.
delete_theme_for_stack	delete	region		Deletes custom branding that customizes the appearance of the streaming application catalog page.

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_theme_for_stack

Retrieves a list that describes the theme for a specified stack. A theme is custom branding that customizes the appearance of the streaming application catalog page.

SELECT
created_time,
stack_name,
state,
theme_favicon_url,
theme_footer_links,
theme_organization_logo_url,
theme_styling,
theme_title_text
FROM aws.appstream.theme_for_stacks
WHERE region = '{{ region }}' -- required
;

INSERT examples

create_theme_for_stack

Creates custom branding that customizes the appearance of the streaming application catalog page.

INSERT INTO aws.appstream.theme_for_stacks (
StackName,
FooterLinks,
TitleText,
ThemeStyling,
OrganizationLogoS3Location,
FaviconS3Location,
region
)
SELECT 
'{{ StackName }}' /* required */,
'{{ FooterLinks }}',
'{{ TitleText }}' /* required */,
'{{ ThemeStyling }}' /* required */,
'{{ OrganizationLogoS3Location }}' /* required */,
'{{ FaviconS3Location }}' /* required */,
'{{ region }}'
RETURNING
theme
;

Manifest

# Description fields are for documentation purposes
- name: theme_for_stacks
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the theme_for_stacks resource.
  - name: StackName
    value: "{{ StackName }}"
    description: |
      The name of the stack for the theme.
  - name: FooterLinks
    description: |
      The links that are displayed in the footer of the streaming application catalog page. These links are helpful resources for users, such as the organization's IT support and product marketing sites.
    value:
      - DisplayName: "{{ DisplayName }}"
        FooterLinkURL: "{{ FooterLinkURL }}"
  - name: TitleText
    value: "{{ TitleText }}"
    description: |
      The title that is displayed at the top of the browser tab during users' application streaming sessions.
  - name: ThemeStyling
    value: "{{ ThemeStyling }}"
    description: |
      The color theme that is applied to website links, text, and buttons. These colors are also applied as accents in the background for the streaming application catalog page.
    valid_values: ['LIGHT_BLUE', 'BLUE', 'PINK', 'RED']
  - name: OrganizationLogoS3Location
    description: |
      The organization logo that appears on the streaming application catalog page.
    value:
      S3Bucket: "{{ S3Bucket }}"
      S3Key: "{{ S3Key }}"
  - name: FaviconS3Location
    description: |
      The S3 location of the favicon. The favicon enables users to recognize their application streaming site in a browser full of tabs or bookmarks. It is displayed at the top of the browser tab for the application streaming site during users' streaming sessions.
    value:
      S3Bucket: "{{ S3Bucket }}"
      S3Key: "{{ S3Key }}"

UPDATE examples

update_theme_for_stack

Updates custom branding that customizes the appearance of the streaming application catalog page.

UPDATE aws.appstream.theme_for_stacks
SET 
StackName = '{{ StackName }}',
FooterLinks = '{{ FooterLinks }}',
TitleText = '{{ TitleText }}',
ThemeStyling = '{{ ThemeStyling }}',
OrganizationLogoS3Location = '{{ OrganizationLogoS3Location }}',
FaviconS3Location = '{{ FaviconS3Location }}',
State = '{{ State }}',
AttributesToDelete = '{{ AttributesToDelete }}'
WHERE 
region = '{{ region }}' --required
AND StackName = '{{ StackName }}' --required
RETURNING
theme;

DELETE examples

delete_theme_for_stack

Deletes custom branding that customizes the appearance of the streaming application catalog page.

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