Class CfnApplicationProps.Builder
java.lang.Object
software.amazon.awscdk.services.gameliftstreams.CfnApplicationProps.Builder
- All Implemented Interfaces:
software.amazon.jsii.Builder<CfnApplicationProps>
- Enclosing interface:
CfnApplicationProps
@Stability(Stable)
public static final class CfnApplicationProps.Builder
extends Object
implements software.amazon.jsii.Builder<CfnApplicationProps>
A builder for
CfnApplicationProps-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionapplicationLogOutputUri(String applicationLogOutputUri) Sets the value ofCfnApplicationProps.getApplicationLogOutputUri()applicationLogPaths(List<String> applicationLogPaths) Sets the value ofCfnApplicationProps.getApplicationLogPaths()applicationSourceUri(String applicationSourceUri) Sets the value ofCfnApplicationProps.getApplicationSourceUri()build()Builds the configured instance.description(String description) Sets the value ofCfnApplicationProps.getDescription()executablePath(String executablePath) Sets the value ofCfnApplicationProps.getExecutablePath()runtimeEnvironment(IResolvable runtimeEnvironment) Sets the value ofCfnApplicationProps.getRuntimeEnvironment()runtimeEnvironment(CfnApplication.RuntimeEnvironmentProperty runtimeEnvironment) Sets the value ofCfnApplicationProps.getRuntimeEnvironment()Sets the value ofCfnApplicationProps.getTags()
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
applicationSourceUri
@Stability(Stable) public CfnApplicationProps.Builder applicationSourceUri(String applicationSourceUri) Sets the value ofCfnApplicationProps.getApplicationSourceUri()- Parameters:
applicationSourceUri- The location of the content that you want to stream. This parameter is required. 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.
- Returns:
this
-
description
Sets the value ofCfnApplicationProps.getDescription()- Parameters:
description- A human-readable label for the application. This parameter is required. You can update this value later.- Returns:
this
-
executablePath
Sets the value ofCfnApplicationProps.getExecutablePath()- Parameters:
executablePath- The relative path and file name of the executable file that Amazon GameLift Streams will stream. This parameter is required. Specify a path relative to the location set inApplicationSourceUri. 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:
this
-
runtimeEnvironment
@Stability(Stable) public CfnApplicationProps.Builder runtimeEnvironment(IResolvable runtimeEnvironment) Sets the value ofCfnApplicationProps.getRuntimeEnvironment()- Parameters:
runtimeEnvironment- A set of configuration settings to run the application on a stream group. This parameter is required. This configures the operating system, and can include compatibility layers and other drivers.- Returns:
this
-
runtimeEnvironment
@Stability(Stable) public CfnApplicationProps.Builder runtimeEnvironment(CfnApplication.RuntimeEnvironmentProperty runtimeEnvironment) Sets the value ofCfnApplicationProps.getRuntimeEnvironment()- Parameters:
runtimeEnvironment- A set of configuration settings to run the application on a stream group. This parameter is required. This configures the operating system, and can include compatibility layers and other drivers.- Returns:
this
-
applicationLogOutputUri
@Stability(Stable) public CfnApplicationProps.Builder applicationLogOutputUri(String applicationLogOutputUri) Sets the value ofCfnApplicationProps.getApplicationLogOutputUri()- Parameters:
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 moreApplicationLogPaths.- Returns:
this
-
applicationLogPaths
@Stability(Stable) public CfnApplicationProps.Builder applicationLogPaths(List<String> applicationLogPaths) Sets the value ofCfnApplicationProps.getApplicationLogPaths()- Parameters:
applicationLogPaths- Locations of log files that your content generates during a stream session. Enter path values that are relative to theApplicationSourceUrilocation. You can specify up to 10 log paths. Amazon GameLift Streams uploads designated log files to the Amazon S3 bucket that you specify inApplicationLogOutputUriat the end of a stream session. To retrieve stored log files, call GetStreamSession and get theLogFileLocationUri.- Returns:
this
-
tags
Sets the value ofCfnApplicationProps.getTags()- Parameters:
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 .- Returns:
this
-
build
Builds the configured instance.- Specified by:
buildin interfacesoftware.amazon.jsii.Builder<CfnApplicationProps>- Returns:
- a new instance of
CfnApplicationProps - Throws:
NullPointerException- if any required attribute was not provided
-