Package software.amazon.awscdk.services.gameliftstreams

Class CfnApplication

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.gameliftstreams.CfnApplication
All Implemented Interfaces:
IInspectable, IApplicationRef, IEnvironmentAware, ITaggableV2, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.119.0 (build 1634eac)", date="2025-11-13T16:10:06.694Z") @Stability(Stable) public class CfnApplication extends CfnResource implements IInspectable, IApplicationRef, ITaggableV2
The AWS::GameLiftStreams::Application resource defines an Amazon GameLift Streams application.

An application specifies the content that you want to stream, such as a game or other software, and its runtime environment (Microsoft Windows, Ubuntu, or Proton).

Before you create an Amazon GameLift Streams application, upload your uncompressed game files (do not upload a .zip file) to an Amazon Simple Storage Service (Amazon S3) standard bucket.

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.*;
 CfnApplication cfnApplication = CfnApplication.Builder.create(this, "MyCfnApplication")
         .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:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnApplication

      protected CfnApplication(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnApplication

      protected CfnApplication(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnApplication

      @Stability(Stable) public CfnApplication(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnApplicationProps props)
      Create a new AWS::GameLiftStreams::Application.

      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.
      props - Resource properties. This parameter is required.

  • Method Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getApplicationRef

      @Stability(Stable) @NotNull public ApplicationReference getApplicationRef()
      A reference to a Application resource.
      Specified by:
      getApplicationRef in interface IApplicationRef

    • getAttrArn

      @Stability(Stable) @NotNull public String getAttrArn()
      An Amazon Resource Name (ARN) that uniquely identifies the application resource across all AWS Regions. For example:.

      arn:aws:gameliftstreams:us-west-2:123456789012:application/a-9ZY8X7Wv6 .

    • getAttrId

      @Stability(Stable) @NotNull public String getAttrId()
      An ID that uniquely identifies the application resource.

      For example: a-9ZY8X7Wv6 .

    • getCdkTagManager

      @Stability(Stable) @NotNull public TagManager getCdkTagManager()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getCdkTagManager in interface ITaggableV2

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getApplicationSourceUri

      @Stability(Stable) @NotNull public String getApplicationSourceUri()
      The location of the content that you want to stream.

    • setApplicationSourceUri

      @Stability(Stable) public void setApplicationSourceUri(@NotNull String value)
      The location of the content that you want to stream.

    • getDescription

      @Stability(Stable) @NotNull public String getDescription()
      A human-readable label for the application.

    • setDescription

      @Stability(Stable) public void setDescription(@NotNull String value)
      A human-readable label for the application.

    • getExecutablePath

      @Stability(Stable) @NotNull public String getExecutablePath()
      The relative path and file name of the executable file that Amazon GameLift Streams will stream.

    • setExecutablePath

      @Stability(Stable) public void setExecutablePath(@NotNull String value)
      The relative path and file name of the executable file that Amazon GameLift Streams will stream.

    • getRuntimeEnvironment

      @Stability(Stable) @NotNull public Object getRuntimeEnvironment()
      A set of configuration settings to run the application on a stream group.

      Returns union: either IResolvable or CfnApplication.RuntimeEnvironmentProperty

    • setRuntimeEnvironment

      @Stability(Stable) public void setRuntimeEnvironment(@NotNull IResolvable value)
      A set of configuration settings to run the application on a stream group.

    • setRuntimeEnvironment

      @Stability(Stable) public void setRuntimeEnvironment(@NotNull CfnApplication.RuntimeEnvironmentProperty value)
      A set of configuration settings to run the application on a stream group.

    • getApplicationLogOutputUri

      @Stability(Stable) @Nullable public String getApplicationLogOutputUri()
      An Amazon S3 URI to a bucket where you would like Amazon GameLift Streams to save application logs.

    • setApplicationLogOutputUri

      @Stability(Stable) public void setApplicationLogOutputUri(@Nullable String value)
      An Amazon S3 URI to a bucket where you would like Amazon GameLift Streams to save application logs.

    • getApplicationLogPaths

      @Stability(Stable) @Nullable public List<String> getApplicationLogPaths()
      Locations of log files that your content generates during a stream session.

    • setApplicationLogPaths

      @Stability(Stable) public void setApplicationLogPaths(@Nullable List<String> value)
      Locations of log files that your content generates during a stream session.

    • getTags

      @Stability(Stable) @Nullable public Map<String,String> getTags()
      A list of labels to assign to the new application resource.

    • setTags

      @Stability(Stable) public void setTags(@Nullable Map<String,String> value)
      A list of labels to assign to the new application resource.