Class: Aws::GameLiftStreams::Types::CreateApplicationInput

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-gameliftstreams/lib/aws-sdk-gameliftstreams/types.rb

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#application_log_output_uri ⇒ String

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.

The log bucket must have permissions that give Amazon GameLift Streams access to write the log files. For more information, see Application log bucket permission policy in the Amazon GameLift Streams Developer Guide.

Returns:

  • (String) 


414
415
416
417
418
419
420
421
422
423
424
425
 
# File 'gems/aws-sdk-gameliftstreams/lib/aws-sdk-gameliftstreams/types.rb', line 414

class CreateApplicationInput < Struct.new(
  :description,
  :runtime_environment,
  :executable_path,
  :application_source_uri,
  :application_log_paths,
  :application_log_output_uri,
  :tags,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#application_log_paths ⇒ Array<String>

Locations of log files that your content generates during a stream session. Enter path values that are relative to the ApplicationSourceUri location, or relative to the user's home directory when using a supported path variable. You can specify up to 10 log paths. Each individual log file cannot exceed 50 MB in size.

Each path can be a directory or an exact file path. When you specify a directory, Amazon GameLift Streams collects only files with the following extensions: .txt, .log, and .utrace. To collect files with other extensions, specify the exact file path. The copy operation is not performed recursively in subfolders.

The following path variables are recognized when they appear as the first component of a path: %USERPROFILE% (Windows and Proton), $HOME or ~ (Linux). Use a path variable when your application writes logs outside of the application directory.

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.

Returns:

  • (Array<String>) 


414
415
416
417
418
419
420
421
422
423
424
425
 
# File 'gems/aws-sdk-gameliftstreams/lib/aws-sdk-gameliftstreams/types.rb', line 414

class CreateApplicationInput < Struct.new(
  :description,
  :runtime_environment,
  :executable_path,
  :application_source_uri,
  :application_log_paths,
  :application_log_output_uri,
  :tags,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#application_source_uri ⇒ String

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.

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

Returns:

  • (String) 


414
415
416
417
418
419
420
421
422
423
424
425
 
# File 'gems/aws-sdk-gameliftstreams/lib/aws-sdk-gameliftstreams/types.rb', line 414

class CreateApplicationInput < Struct.new(
  :description,
  :runtime_environment,
  :executable_path,
  :application_source_uri,
  :application_log_paths,
  :application_log_output_uri,
  :tags,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#client_token ⇒ String

A unique identifier that represents a client request. The request is idempotent, which ensures that an API request completes only once. When users send a request, Amazon GameLift Streams automatically populates this field.

A suitable default value is auto-generated. You should normally not need to pass this option.

Returns:

  • (String) 


414
415
416
417
418
419
420
421
422
423
424
425
 
# File 'gems/aws-sdk-gameliftstreams/lib/aws-sdk-gameliftstreams/types.rb', line 414

class CreateApplicationInput < Struct.new(
  :description,
  :runtime_environment,
  :executable_path,
  :application_source_uri,
  :application_log_paths,
  :application_log_output_uri,
  :tags,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ String

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

Returns:

  • (String) 


414
415
416
417
418
419
420
421
422
423
424
425
 
# File 'gems/aws-sdk-gameliftstreams/lib/aws-sdk-gameliftstreams/types.rb', line 414

class CreateApplicationInput < Struct.new(
  :description,
  :runtime_environment,
  :executable_path,
  :application_source_uri,
  :application_log_paths,
  :application_log_output_uri,
  :tags,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#executable_path ⇒ String

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 ('#!').

Returns:

  • (String) 


414
415
416
417
418
419
420
421
422
423
424
425
 
# File 'gems/aws-sdk-gameliftstreams/lib/aws-sdk-gameliftstreams/types.rb', line 414

class CreateApplicationInput < Struct.new(
  :description,
  :runtime_environment,
  :executable_path,
  :application_source_uri,
  :application_log_paths,
  :application_log_output_uri,
  :tags,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#runtime_environment ⇒ Types::RuntimeEnvironment

Configuration settings that identify the operating system for an application resource. This can also include a compatibility layer and other drivers.

A runtime environment can be one of the following:

  • For Linux applications

    • Ubuntu 22.04 LTS (Type=UBUNTU, Version=22_04_LTS)

    ^

  • For Windows applications

    • Microsoft Windows Server 2022 Base (Type=WINDOWS, Version=2022)

    • Proton 10.0-4 (Type=PROTON, Version=20260204)

    • Proton 9.0-2 (Type=PROTON, Version=20250516)

    • Proton 8.0-5 (Type=PROTON, Version=20241007)

    • Proton 8.0-2c (Type=PROTON, Version=20230704)

Returns:



414
415
416
417
418
419
420
421
422
423
424
425
 
# File 'gems/aws-sdk-gameliftstreams/lib/aws-sdk-gameliftstreams/types.rb', line 414

class CreateApplicationInput < Struct.new(
  :description,
  :runtime_environment,
  :executable_path,
  :application_source_uri,
  :application_log_paths,
  :application_log_output_uri,
  :tags,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Hash<String,String>

A list of labels to assign to the new application resource. Tags are developer-defined key-value pairs. Tagging Amazon Web Services resources is useful for resource management, access management and cost allocation. See Tagging Amazon Web Services Resources in the Amazon Web Services General Reference. You can use TagResource to add tags, UntagResource to remove tags, and ListTagsForResource to view tags on existing resources.

Returns:

  • (Hash<String,String>) 


414
415
416
417
418
419
420
421
422
423
424
425
 
# File 'gems/aws-sdk-gameliftstreams/lib/aws-sdk-gameliftstreams/types.rb', line 414

class CreateApplicationInput < Struct.new(
  :description,
  :runtime_environment,
  :executable_path,
  :application_source_uri,
  :application_log_paths,
  :application_log_output_uri,
  :tags,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end