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	aws.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
app_block_arn	string
platforms	array
tags	array
attributes_to_delete	array
created_time	string
region	string	AWS region.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	Name, IconS3Location, LaunchPath, Platforms, InstanceFamilies, AppBlockArn, region
delete_resource	DELETE	data__Identifier, region
update_resource	UPDATE	data__Identifier, data__PatchDocument, region
get_resource	SELECT	data__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 aws.appstream.applications
WHERE region = 'us-east-1' AND data__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 aws.appstream.applications (
 Name,
 LaunchPath,
 InstanceFamilies,
 IconS3Location,
 AppBlockArn,
 Platforms,
 region
)
SELECT 
'{{ Name }}',
 '{{ LaunchPath }}',
 '{{ InstanceFamilies }}',
 '{{ IconS3Location }}',
 '{{ AppBlockArn }}',
 '{{ Platforms }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.appstream.applications (
 Name,
 DisplayName,
 Description,
 LaunchPath,
 LaunchParameters,
 WorkingDirectory,
 InstanceFamilies,
 IconS3Location,
 AppBlockArn,
 Platforms,
 Tags,
 AttributesToDelete,
 region
)
SELECT 
 '{{ Name }}',
 '{{ DisplayName }}',
 '{{ Description }}',
 '{{ LaunchPath }}',
 '{{ LaunchParameters }}',
 '{{ WorkingDirectory }}',
 '{{ InstanceFamilies }}',
 '{{ IconS3Location }}',
 '{{ AppBlockArn }}',
 '{{ Platforms }}',
 '{{ Tags }}',
 '{{ AttributesToDelete }}',
 '{{ 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: DisplayName
        value: '{{ DisplayName }}'
      - name: Description
        value: '{{ Description }}'
      - name: LaunchPath
        value: '{{ LaunchPath }}'
      - name: LaunchParameters
        value: '{{ LaunchParameters }}'
      - name: WorkingDirectory
        value: '{{ WorkingDirectory }}'
      - name: InstanceFamilies
        value:
          - '{{ InstanceFamilies[0] }}'
      - name: IconS3Location
        value:
          S3Bucket: '{{ S3Bucket }}'
          S3Key: '{{ S3Key }}'
      - name: AppBlockArn
        value: '{{ AppBlockArn }}'
      - name: Platforms
        value:
          - '{{ Platforms[0] }}'
      - name: Tags
        value:
          - Value: '{{ Value }}'
            Key: '{{ Key }}'
      - name: AttributesToDelete
        value:
          - '{{ AttributesToDelete[0] }}'

DELETE example

/*+ delete */
DELETE FROM aws.appstream.applications
WHERE data__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

Update

appstream:UpdateApplication,
s3:GetObject

Delete

appstream:DeleteApplication