AWS::AppStream::Application - AWS CloudFormation (original) (raw)

This resource creates an application. Applications store the details about how to launch applications on streaming instances. This is only supported for Elastic fleets.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{
  "Type" : "AWS::AppStream::Application",
  "Properties" : {
      "AppBlockArn" : String,
      "AttributesToDelete" : [ String, ... ],
      "Description" : String,
      "DisplayName" : String,
      "IconS3Location" : S3Location,
      "InstanceFamilies" : [ String, ... ],
      "LaunchParameters" : String,
      "LaunchPath" : String,
      "Name" : String,
      "Platforms" : [ String, ... ],
      "Tags" : [ Tag, ... ],
      "WorkingDirectory" : String
    }
}

YAML

Type: AWS::AppStream::Application
Properties:
  AppBlockArn: String
  AttributesToDelete: 
    - String
  Description: String
  DisplayName: String
  IconS3Location: 
    S3Location
  InstanceFamilies: 
    - String
  LaunchParameters: String
  LaunchPath: String
  Name: String
  Platforms: 
    - String
  Tags: 
    - Tag
  WorkingDirectory: String

Properties

AppBlockArn

The app block ARN with which the application should be associated.

Required: Yes

Type: String

Pattern: ^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}$

Update requires: No interruption

AttributesToDelete

A list of attributes to delete from an application.

Required: No

Type: Array of String

Update requires: No interruption

Description

The description of the application.

Required: No

Type: String

Minimum: 1

Update requires: No interruption

DisplayName

The display name of the application. This name is visible to users in the application catalog.

Required: No

Type: String

Minimum: 1

Update requires: No interruption

IconS3Location

The icon S3 location of the application.

Required: Yes

Type: S3Location

Update requires: No interruption

InstanceFamilies

The instance families the application supports.

Allowed Values: GENERAL_PURPOSE | GRAPHICS_G4

Required: Yes

Type: Array of String

Update requires: Replacement

LaunchParameters

The launch parameters of the application.

Required: No

Type: String

Minimum: 1

Update requires: No interruption

LaunchPath

The launch path of the application.

Required: Yes

Type: String

Minimum: 1

Update requires: No interruption

Name

The name of the application. This name is visible to users when a name is not specified in the DisplayName property.

Pattern: ^[a-zA-Z0-9][a-zA-Z0-9_.-]{0,100}$

Required: Yes

Type: String

Minimum: 1

Update requires: Replacement

Platforms

The platforms the application supports.

Allowed Values: WINDOWS_SERVER_2019 | AMAZON_LINUX2

Required: Yes

Type: Array of String

Maximum: 4

Update requires: Replacement

Tags

The tags of the application.

Required: No

Type: Array of Tag

Update requires: No interruption

WorkingDirectory

The working directory of the application.

Required: No

Type: String

Minimum: 1

Update requires: No interruption

Return values

Ref

When you pass the logical ID of this resource to the intrinsic Ref function,Ref returns the Arn of the application, such asarn:aws:appstream:us-west-2:123456789123:application/abcdefg.

For more information about using the Ref function, see Ref.

Fn::GetAtt

The Fn::GetAtt intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.

For more information about using the Fn::GetAtt intrinsic function, see Fn::GetAtt.

Arn

The ARN of the application.

CreatedTime

The time when the application was created.