Package software.amazon.awscdk.services.gameliftstreams

Class CfnApplication.Builder

java.lang.Object

software.amazon.awscdk.services.gameliftstreams.CfnApplication.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnApplication>

Enclosing class:

CfnApplication

@Stability(Stable)
public static final class CfnApplication.Builder
extends Object
implements software.amazon.jsii.Builder<CfnApplication>

A fluent builder for CfnApplication.

Method Summary

Modifier and Type	Method	Description
CfnApplication.Builder	applicationLogOutputUri(String applicationLogOutputUri)	An Amazon S3 URI to a bucket where you would like Amazon GameLift Streams to save application logs.
CfnApplication.Builder	applicationLogPaths(List<String> applicationLogPaths)	Locations of log files that your content generates during a stream session.
CfnApplication.Builder	applicationSourceUri(String applicationSourceUri)	The location of the content that you want to stream.
CfnApplication	build()
static CfnApplication.Builder	create(software.constructs.Construct scope, String id)
CfnApplication.Builder	description(String description)	A human-readable label for the application.
CfnApplication.Builder	executablePath(String executablePath)	The relative path and file name of the executable file that Amazon GameLift Streams will stream.
CfnApplication.Builder	runtimeEnvironment(IResolvable runtimeEnvironment)	A set of configuration settings to run the application on a stream group.
CfnApplication.Builder	runtimeEnvironment(CfnApplication.RuntimeEnvironmentProperty runtimeEnvironment)	A set of configuration settings to run the application on a stream group.
CfnApplication.Builder	tags(Map<String,String> tags)	A list of labels to assign to the new application resource.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

create

@Stability(Stable)
public static CfnApplication.Builder create(software.constructs.Construct scope,
 String id)

Parameters:

scope - Scope in which this resource is defined. This parameter is required.

id - Construct identifier for this resource (unique in its scope). This parameter is required.

Returns:

a new instance of CfnApplication.Builder.

applicationSourceUri

@Stability(Stable)
public CfnApplication.Builder applicationSourceUri(String 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.

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

Parameters:

applicationSourceUri - The location of the content that you want to stream. This parameter is required.

Returns:

this

See Also:

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

description

@Stability(Stable)
public CfnApplication.Builder description(String description)

A human-readable label for the application.

You can update this value later.

Parameters:

description - A human-readable label for the application. This parameter is required.

Returns:

this

See Also:

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

executablePath

@Stability(Stable)
public CfnApplication.Builder executablePath(String 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 (' #! ').

Parameters:

executablePath - The relative path and file name of the executable file that Amazon GameLift Streams will stream. This parameter is required.

Returns:

this

See Also:

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

runtimeEnvironment

@Stability(Stable)
public CfnApplication.Builder runtimeEnvironment(IResolvable 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.

Parameters:

runtimeEnvironment - A set of configuration settings to run the application on a stream group. This parameter is required.

Returns:

this

See Also:

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

runtimeEnvironment

@Stability(Stable)
public CfnApplication.Builder runtimeEnvironment(CfnApplication.RuntimeEnvironmentProperty 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.

Parameters:

runtimeEnvironment - A set of configuration settings to run the application on a stream group. This parameter is required.

Returns:

this

See Also:

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

applicationLogOutputUri

@Stability(Stable)
public CfnApplication.Builder applicationLogOutputUri(String 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 .

Parameters:

applicationLogOutputUri - An Amazon S3 URI to a bucket where you would like Amazon GameLift Streams to save application logs. This parameter is required.

Returns:

this

See Also:

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

applicationLogPaths

@Stability(Stable)
public CfnApplication.Builder applicationLogPaths(List<String> 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 .

Parameters:

applicationLogPaths - Locations of log files that your content generates during a stream session. This parameter is required.

Returns:

this

See Also:

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

tags

@Stability(Stable)
public CfnApplication.Builder tags(Map<String,String> tags)

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 .

Parameters:

tags - A list of labels to assign to the new application resource. This parameter is required.

Returns:

this

See Also:

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

build

@Stability(Stable)
public CfnApplication build()

Specified by:

build in interface software.amazon.jsii.Builder<CfnApplication>

Returns:

a newly built instance of CfnApplication.