Package software.amazon.awscdk.services.gameliftstreams

Interface CfnApplicationProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnApplicationProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.118.0 (build 02eec31)",
           date="2025-11-04T09:27:42.407Z")
@Stability(Stable)
public interface CfnApplicationProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnApplication.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.gameliftstreams.*;
 CfnApplicationProps cfnApplicationProps = CfnApplicationProps.builder()
         .applicationSourceUri("applicationSourceUri")
         .description("description")
         .executablePath("executablePath")
         .runtimeEnvironment(RuntimeEnvironmentProperty.builder()
                 .type("type")
                 .version("version")
                 .build())
         // the properties below are optional
         .applicationLogOutputUri("applicationLogOutputUri")
         .applicationLogPaths(List.of("applicationLogPaths"))
         .tags(Map.of(
                 "tagsKey", "tags"))
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gameliftstreams-application.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnApplicationProps.Builder	A builder for CfnApplicationProps
static final class	CfnApplicationProps.Jsii$Proxy	An implementation for CfnApplicationProps

Method Summary

Modifier and Type	Method	Description
static CfnApplicationProps.Builder	builder()
default String	getApplicationLogOutputUri()	An Amazon S3 URI to a bucket where you would like Amazon GameLift Streams to save application logs.
default List<String>	getApplicationLogPaths()	Locations of log files that your content generates during a stream session.
String	getApplicationSourceUri()	The location of the content that you want to stream.
String	getDescription()	A human-readable label for the application.
String	getExecutablePath()	The relative path and file name of the executable file that Amazon GameLift Streams will stream.
Object	getRuntimeEnvironment()	A set of configuration settings to run the application on a stream group.
default Map<String,String>	getTags()	A list of labels to assign to the new application resource.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getApplicationSourceUri

@Stability(Stable)
@NotNull
String getApplicationSourceUri()

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 AWS Region.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gameliftstreams-application.html#cfn-gameliftstreams-application-applicationsourceuri

getDescription

@Stability(Stable)
@NotNull
String getDescription()

A human-readable label for the application.

You can update this value later.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gameliftstreams-application.html#cfn-gameliftstreams-application-description

getExecutablePath

@Stability(Stable)
@NotNull
String getExecutablePath()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gameliftstreams-application.html#cfn-gameliftstreams-application-executablepath

getRuntimeEnvironment

@Stability(Stable)
@NotNull
Object getRuntimeEnvironment()

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.

Returns union: either IResolvable or CfnApplication.RuntimeEnvironmentProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gameliftstreams-application.html#cfn-gameliftstreams-application-runtimeenvironment

getApplicationLogOutputUri

@Stability(Stable)
@Nullable
default String getApplicationLogOutputUri()

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 .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gameliftstreams-application.html#cfn-gameliftstreams-application-applicationlogoutputuri

getApplicationLogPaths

@Stability(Stable)
@Nullable
default List<String> getApplicationLogPaths()

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 .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gameliftstreams-application.html#cfn-gameliftstreams-application-applicationlogpaths

getTags

@Stability(Stable)
@Nullable
default Map<String,String> getTags()

A list of labels to assign to the new application resource.

Tags are developer-defined key-value pairs. Tagging AWS resources is useful for resource management, access management and cost allocation. See Tagging AWS Resources in the AWS General Reference .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gameliftstreams-application.html#cfn-gameliftstreams-application-tags

builder

@Stability(Stable)
static CfnApplicationProps.Builder builder()

Returns:

a CfnApplicationProps.Builder of CfnApplicationProps