AWS::GameLiftStreams::Application - Amazon CloudFormation
SyntaxPropertiesReturn valuesSee also
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

This is the new Amazon CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the Amazon CloudFormation User Guide.

AWS::GameLiftStreams::Application

The AWS::GameLiftStreams::Application resource defines an Amazon GameLift Streams application. An application specifies the content that you want to stream, such as a game or other software, and its runtime environment (Microsoft Windows, Ubuntu, or Proton).

Before you create an Amazon GameLift Streams application, upload your uncompressed game files (do not upload a .zip file) to an Amazon Simple Storage Service (Amazon S3) standard bucket.

Syntax

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

JSON

{
  "Type" : "AWS::GameLiftStreams::Application",
  "Properties" : {
      "ApplicationLogOutputUri" : String,
      "ApplicationLogPaths" : [ String, ... ],
      "ApplicationSourceUri" : String,
      "Description" : String,
      "ExecutablePath" : String,
      "RuntimeEnvironment" : RuntimeEnvironment,
      "Tags" : {Key: Value, ...}
    }
}

YAML

Type: AWS::GameLiftStreams::Application
Properties:
  ApplicationLogOutputUri: String
  ApplicationLogPaths: 
    - String
  ApplicationSourceUri: String
  Description: String
  ExecutablePath: String
  RuntimeEnvironment: 
    RuntimeEnvironment
  Tags: 
    Key: Value

Properties

ApplicationLogOutputUri

An Amazon S3 URI to a bucket where you would like Amazon GameLift Streams to save application logs. Required if you specify one or more ApplicationLogPaths.

Required: No

Type: String

Pattern: ^$|^s3://([a-zA-Z0-9][a-zA-Z0-9._-]{1,61}[a-zA-Z0-9])(/[a-zA-Z0-9._-]+)*/?$

Minimum: 0

Maximum: 1024

Update requires: No interruption

ApplicationLogPaths

Locations of log files that your content generates during a stream session. Enter path values that are relative to the ApplicationSourceUri location. You can specify up to 10 log paths. Amazon GameLift Streams uploads designated log files to the Amazon S3 bucket that you specify in ApplicationLogOutputUri at the end of a stream session. To retrieve stored log files, call GetStreamSession and get the LogFileLocationUri.

Required: No

Type: Array of String

Minimum: 0 | 0

Maximum: 1024 | 10

Update requires: No interruption

ApplicationSourceUri

The location of the content that you want to stream. Enter an Amazon S3 URI to a bucket that contains your game or other application. The location can have a multi-level prefix structure, but it must include all the files needed to run the content. Amazon GameLift Streams copies everything under the specified location.

This value is immutable. To designate a different content location, create a new application.

Note

The Amazon S3 bucket and the Amazon GameLift Streams application must be in the same Amazon Region.

Required: Yes

Type: String

Minimum: 1

Maximum: 1024

Update requires: Replacement

Description

A human-readable label for the application. You can update this value later.

Required: Yes

Type: String

Pattern: ^[a-zA-Z0-9-_.!+@/][a-zA-Z0-9-_.!+@/ ]*$

Minimum: 1

Maximum: 80

Update requires: No interruption

ExecutablePath

The relative path and file name of the executable file that Amazon GameLift Streams will stream. Specify a path relative to the location set in ApplicationSourceUri. The file must be contained within the application's root folder. For Windows applications, the file must be a valid Windows executable or batch file with a filename ending in .exe, .cmd, or .bat. For Linux applications, the file must be a valid Linux binary executable or a script that contains an initial interpreter line starting with a shebang ('#!').

Required: Yes

Type: String

Minimum: 1

Maximum: 1024

Update requires: Replacement

RuntimeEnvironment

A set of configuration settings to run the application on a stream group. This configures the operating system, and can include compatibility layers and other drivers.

Required: Yes

Type: RuntimeEnvironment

Update requires: Replacement

Tags

A list of labels to assign to the new application resource. Tags are developer-defined key-value pairs. Tagging Amazon resources is useful for resource management, access management and cost allocation. See Tagging Amazon Resources in the Amazon General Reference.

Required: No

Type: Object of String

Pattern: .+

Minimum: 0

Maximum: 256

Update requires: No interruption

Return values

Ref

When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns an Amazon Resource Name (ARN) that uniquely identifies the application resource across all Amazon Regions. For example:

arn:aws:gameliftstreams:us-west-2:123456789012:application/a-9ZY8X7Wv6

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

An Amazon Resource Name (ARN) that uniquely identifies the application resource across all Amazon Regions. For example:

arn:aws:gameliftstreams:us-west-2:123456789012:application/a-9ZY8X7Wv6.

Id

An ID that uniquely identifies the application resource. For example: a-9ZY8X7Wv6.

See also