applications

Creates, updates, deletes, gets or lists an applications resource.

Overview

Name	applications
Type	Resource
Id	aws.appstream.applications

Fields

The following fields are returned by SELECT queries:

describe_applications

Name	Datatype	Description
applications	array	The applications in the list.
next_token	string	The pagination token used to retrieve the next page of results for this operation.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_applications	select	region		Retrieves a list that describes one or more applications.
create_application	insert	region, Name, IconS3Location, LaunchPath, Platforms, InstanceFamilies, AppBlockArn		Creates an application. Applications are a WorkSpaces Applications resource that stores the details about how to launch applications on Elastic fleet streaming instances. An application consists of the launch details, icon, and display name. Applications are associated with an app block that contains the application binaries and other files. The applications assigned to an Elastic fleet are the applications users can launch. This is only supported for Elastic fleets.
update_application	update	region, Name		Updates the specified application.
delete_application	delete	region		Deletes an application.

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_applications

Retrieves a list that describes one or more applications.

SELECT
applications,
next_token
FROM aws.appstream.applications
WHERE region = '{{ region }}' -- required
;

INSERT examples

create_application

Creates an application. Applications are a WorkSpaces Applications resource that stores the details about how to launch applications on Elastic fleet streaming instances. An application consists of the launch details, icon, and display name. Applications are associated with an app block that contains the application binaries and other files. The applications assigned to an Elastic fleet are the applications users can launch. This is only supported for Elastic fleets.

INSERT INTO aws.appstream.applications (
Name,
DisplayName,
Description,
IconS3Location,
LaunchPath,
WorkingDirectory,
LaunchParameters,
Platforms,
InstanceFamilies,
AppBlockArn,
Tags,
region
)
SELECT 
'{{ Name }}' /* required */,
'{{ DisplayName }}',
'{{ Description }}',
'{{ IconS3Location }}' /* required */,
'{{ LaunchPath }}' /* required */,
'{{ WorkingDirectory }}',
'{{ LaunchParameters }}',
'{{ Platforms }}' /* required */,
'{{ InstanceFamilies }}' /* required */,
'{{ AppBlockArn }}' /* required */,
'{{ Tags }}',
'{{ region }}'
RETURNING
application
;

Manifest

# Description fields are for documentation purposes
- name: applications
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the applications resource.
  - name: Name
    value: "{{ Name }}"
    description: |
      The name of the application. This name is visible to users when display name is not specified.
  - name: DisplayName
    value: "{{ DisplayName }}"
    description: |
      The display name of the application. This name is visible to users in the application catalog.
  - name: Description
    value: "{{ Description }}"
    description: |
      The description of the application.
  - name: IconS3Location
    description: |
      The location in S3 of the application icon.
    value:
      S3Bucket: "{{ S3Bucket }}"
      S3Key: "{{ S3Key }}"
  - name: LaunchPath
    value: "{{ LaunchPath }}"
    description: |
      The launch path of the application.
  - name: WorkingDirectory
    value: "{{ WorkingDirectory }}"
    description: |
      The working directory of the application.
  - name: LaunchParameters
    value: "{{ LaunchParameters }}"
    description: |
      The launch parameters of the application.
  - name: Platforms
    value:
      - "{{ Platforms }}"
    description: |
      The platforms the application supports. WINDOWS_SERVER_2019, AMAZON_LINUX2 and UBUNTU_PRO_2404 are supported for Elastic fleets.
  - name: InstanceFamilies
    value:
      - "{{ InstanceFamilies }}"
    description: |
      The instance families the application supports. Valid values are GENERAL_PURPOSE and GRAPHICS_G4.
  - name: AppBlockArn
    value: "{{ AppBlockArn }}"
    description: |
      The app block ARN to which the application should be associated
  - name: Tags
    value: "{{ Tags }}"
    description: |
      The tags assigned to the application.

UPDATE examples

update_application

Updates the specified application.

UPDATE aws.appstream.applications
SET 
Name = '{{ Name }}',
DisplayName = '{{ DisplayName }}',
Description = '{{ Description }}',
IconS3Location = '{{ IconS3Location }}',
LaunchPath = '{{ LaunchPath }}',
WorkingDirectory = '{{ WorkingDirectory }}',
LaunchParameters = '{{ LaunchParameters }}',
AppBlockArn = '{{ AppBlockArn }}',
AttributesToDelete = '{{ AttributesToDelete }}'
WHERE 
region = '{{ region }}' --required
AND Name = '{{ Name }}' --required
RETURNING
application;

DELETE examples

delete_application

Deletes an application.

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