Struct CreateApplicationInput

#[non_exhaustive]
pub struct CreateApplicationInput {
    pub description: Option<String>,
    pub runtime_environment: Option<RuntimeEnvironment>,
    pub executable_path: Option<String>,
    pub application_source_uri: Option<String>,
    pub application_log_paths: Option<Vec<String>>,
    pub application_log_output_uri: Option<String>,
    pub tags: Option<HashMap<String, String>>,
    pub client_token: Option<String>,
}

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

description: Option<String>

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

runtime_environment: Option<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 8.0-5 (Type=PROTON, Version=20241007)

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

executable_path: Option<String>

The path and file name of the executable file that launches the content for streaming. Enter a path value that is relative to the location set in ApplicationSourceUri.

application_source_uri: Option<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.

application_log_paths: Option<Vec<String>>

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.

application_log_output_uri: Option<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.

tags: Option<HashMap<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.

client_token: Option<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.

Implementations

impl CreateApplicationInput

pub fn description(&self) -> Option<&str>

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

pub fn runtime_environment(&self) -> Option<&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 8.0-5 (Type=PROTON, Version=20241007)

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

pub fn executable_path(&self) -> Option<&str>

The path and file name of the executable file that launches the content for streaming. Enter a path value that is relative to the location set in ApplicationSourceUri.

pub fn application_source_uri(&self) -> Option<&str>

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.

pub fn application_log_paths(&self) -> &[String]

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.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .application_log_paths.is_none().

pub fn application_log_output_uri(&self) -> Option<&str>

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.

pub fn tags(&self) -> Option<&HashMap<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.

pub fn client_token(&self) -> Option<&str>

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.

impl CreateApplicationInput

pub fn builder() -> CreateApplicationInputBuilder

Creates a new builder-style object to manufacture CreateApplicationInput.

Trait Implementations

impl Clone for CreateApplicationInput

fn clone(&self) -> CreateApplicationInput

Returns a duplicate of the value.

const fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CreateApplicationInput

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for CreateApplicationInput

fn eq(&self, other: &CreateApplicationInput) -> bool

Tests for self and other values to be equal, and is used by ==.

const fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for CreateApplicationInput