CfnApplicationProps

class aws_cdk.aws_gameliftstreams.CfnApplicationProps(*, application_source_uri, description, executable_path, runtime_environment, application_log_output_uri=None, application_log_paths=None, tags=None)

Bases: object

Properties for defining a CfnApplication.

Parameters:

application_source_uri (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. .. epigraph:: The Amazon S3 bucket and the Amazon GameLift Streams application must be in the same AWS Region.
description (str) – A human-readable label for the application. You can update this value later.
executable_path (str) – 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 (’ #! ‘).
runtime_environment (Union[IResolvable, RuntimeEnvironmentProperty, Dict[str, Any]]) – 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.
application_log_output_uri (Optional[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 .
application_log_paths (Optional[Sequence[str]]) – 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 .
tags (Optional[Mapping[str, str]]) – 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:

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

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_gameliftstreams as gameliftstreams

cfn_application_props = gameliftstreams.CfnApplicationProps(
    application_source_uri="applicationSourceUri",
    description="description",
    executable_path="executablePath",
    runtime_environment=gameliftstreams.CfnApplication.RuntimeEnvironmentProperty(
        type="type",
        version="version"
    ),

    # the properties below are optional
    application_log_output_uri="applicationLogOutputUri",
    application_log_paths=["applicationLogPaths"],
    tags={
        "tags_key": "tags"
    }
)

Attributes

application_log_output_uri

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:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gameliftstreams-application.html#cfn-gameliftstreams-application-applicationlogoutputuri

application_log_paths

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:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gameliftstreams-application.html#cfn-gameliftstreams-application-applicationlogpaths

application_source_uri

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. .. epigraph:

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

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

description

A human-readable label for the application.

You can update this value later.

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

executable_path

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:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gameliftstreams-application.html#cfn-gameliftstreams-application-executablepath

runtime_environment

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.

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

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 .

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