applications

Creates, updates, deletes or gets an application resource or lists applications in a region

Overview

Name	applications
Type	Resource
Description	Resource Type definition for AWS::AppStream::Application
Id	awscc.appstream.applications

Fields

Name	Datatype	Description
name	string
display_name	string
description	string
launch_path	string
launch_parameters	string
working_directory	string
instance_families	array
▶icon_s3_location	object
arn	string
platforms	array
▶tags	array
attributes_to_delete	array
created_time	string
region	string	AWS region.

For more information, see AWS::AppStream::Application.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	Name, IconS3Location, LaunchPath, Platforms, InstanceFamilies, AppBlockArn, region
delete_resource	DELETE	Identifier, region
update_resource	UPDATE	Identifier, PatchDocument, region
get_resource	SELECT	Identifier, region

SELECT examples

Gets all properties from an individual application.

SELECT
  region,
  name,
  display_name,
  description,
  launch_path,
  launch_parameters,
  working_directory,
  instance_families,
  icon_s3_location,
  arn,
  app_block_arn,
  platforms,
  tags,
  attributes_to_delete,
  created_time
FROM awscc.appstream.applications
WHERE
  region = 'us-east-1' AND
  Identifier = '{{ arn }}';

INSERT example

Use the following StackQL query and manifest file to create a new application resource, using stack-deploy.

Required Properties

/*+ create */
INSERT INTO awscc.appstream.applications (
  Name,
  LaunchPath,
  InstanceFamilies,
  IconS3Location,
  AppBlockArn,
  Platforms,
  region
)
SELECT
  '{{ name }}',
  '{{ launch_path }}',
  '{{ instance_families }}',
  '{{ icon_s3_location }}',
  '{{ app_block_arn }}',
  '{{ platforms }}',
  '{{ region }}';

All Properties

/*+ create */
INSERT INTO awscc.appstream.applications (
  Name,
  DisplayName,
  Description,
  LaunchPath,
  LaunchParameters,
  WorkingDirectory,
  InstanceFamilies,
  IconS3Location,
  AppBlockArn,
  Platforms,
  Tags,
  AttributesToDelete,
  region
)
SELECT
  '{{ name }}',
  '{{ display_name }}',
  '{{ description }}',
  '{{ launch_path }}',
  '{{ launch_parameters }}',
  '{{ working_directory }}',
  '{{ instance_families }}',
  '{{ icon_s3_location }}',
  '{{ app_block_arn }}',
  '{{ platforms }}',
  '{{ tags }}',
  '{{ attributes_to_delete }}',
  '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: application
    props:
      - name: name
        value: '{{ name }}'
      - name: display_name
        value: '{{ display_name }}'
      - name: description
        value: '{{ description }}'
      - name: launch_path
        value: '{{ launch_path }}'
      - name: launch_parameters
        value: '{{ launch_parameters }}'
      - name: working_directory
        value: '{{ working_directory }}'
      - name: instance_families
        value:
          - '{{ instance_families[0] }}'
      - name: icon_s3_location
        value:
          s3_bucket: '{{ s3_bucket }}'
          s3_key: '{{ s3_key }}'
      - name: app_block_arn
        value: '{{ app_block_arn }}'
      - name: platforms
        value:
          - '{{ platforms[0] }}'
      - name: tags
        value:
          - value: '{{ value }}'
            key: '{{ key }}'
      - name: attributes_to_delete
        value:
          - '{{ attributes_to_delete[0] }}'

UPDATE example

Use the following StackQL query and manifest file to update a application resource, using stack-deploy.

/*+ update */
UPDATE awscc.appstream.applications
SET PatchDocument = string('{{ {
    "DisplayName": display_name,
    "Description": description,
    "LaunchPath": launch_path,
    "LaunchParameters": launch_parameters,
    "WorkingDirectory": working_directory,
    "IconS3Location": icon_s3_location,
    "AppBlockArn": app_block_arn,
    "Tags": tags,
    "AttributesToDelete": attributes_to_delete
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ arn }}';

DELETE example

/*+ delete */
DELETE FROM awscc.appstream.applications
WHERE
  Identifier = '{{ arn }}' AND
  region = 'us-east-1';

Permissions

To operate on the applications resource, the following permissions are required:

Create

s3:GetObject,
appstream:CreateApplication,
appstream:TagResource

Read

appstream:DescribeApplications,
appstream:ListTagsForResource

Update

appstream:UpdateApplication,
appstream:DescribeApplications,
appstream:TagResource,
appstream:UntagResource,
s3:GetObject

Delete

appstream:DeleteApplication,
appstream:DescribeApplications