Interface CreateApplicationRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<CreateApplicationRequest.Builder,CreateApplicationRequest>, GameLiftStreamsRequest.Builder, SdkBuilder<CreateApplicationRequest.Builder,CreateApplicationRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
CreateApplicationRequest
@Mutable @NotThreadSafe public static interface CreateApplicationRequest.Builder extends GameLiftStreamsRequest.Builder, SdkPojo, CopyableBuilder<CreateApplicationRequest.Builder,CreateApplicationRequest>

  • Method Details

    • description

      CreateApplicationRequest.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. You can update this value later.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • runtimeEnvironment

      CreateApplicationRequest.Builder runtimeEnvironment(RuntimeEnvironment runtimeEnvironment)

      Configuration settings that identify the operating system for an application resource. This can also include a compatibility layer and other drivers.

      A runtime environment can be one of the following:

      • For Linux applications

        • Ubuntu 22.04 LTS (Type=UBUNTU, Version=22_04_LTS)

      • For Windows applications

        • Microsoft Windows Server 2022 Base (Type=WINDOWS, Version=2022)

        • Proton 9.0-2 (Type=PROTON, Version=20250516)

        • Proton 8.0-5 (Type=PROTON, Version=20241007)

        • Proton 8.0-2c (Type=PROTON, Version=20230704)

      Parameters:
      runtimeEnvironment - Configuration settings that identify the operating system for an application resource. This can also include a compatibility layer and other drivers.

      A runtime environment can be one of the following:

      • For Linux applications

        • Ubuntu 22.04 LTS (Type=UBUNTU, Version=22_04_LTS)

      • For Windows applications

        • Microsoft Windows Server 2022 Base (Type=WINDOWS, Version=2022)

        • Proton 9.0-2 (Type=PROTON, Version=20250516)

        • Proton 8.0-5 (Type=PROTON, Version=20241007)

        • Proton 8.0-2c (Type=PROTON, Version=20230704)

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • runtimeEnvironment

      default CreateApplicationRequest.Builder runtimeEnvironment(Consumer<RuntimeEnvironment.Builder> runtimeEnvironment)

      Configuration settings that identify the operating system for an application resource. This can also include a compatibility layer and other drivers.

      A runtime environment can be one of the following:

      • For Linux applications

        • Ubuntu 22.04 LTS (Type=UBUNTU, Version=22_04_LTS)

      • For Windows applications

        • Microsoft Windows Server 2022 Base (Type=WINDOWS, Version=2022)

        • Proton 9.0-2 (Type=PROTON, Version=20250516)

        • Proton 8.0-5 (Type=PROTON, Version=20241007)

        • Proton 8.0-2c (Type=PROTON, Version=20230704)

      This is a convenience method that creates an instance of the RuntimeEnvironment.Builder avoiding the need to create one manually via RuntimeEnvironment.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to runtimeEnvironment(RuntimeEnvironment).

      Parameters:
      runtimeEnvironment - a consumer that will call methods on RuntimeEnvironment.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • executablePath

      CreateApplicationRequest.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. 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 ('#!').
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • applicationSourceUri

      CreateApplicationRequest.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 Amazon Web Services Region.

      Parameters:
      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 Amazon Web Services Region.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • applicationLogPaths

      CreateApplicationRequest.Builder applicationLogPaths(Collection<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. 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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • applicationLogPaths

      CreateApplicationRequest.Builder applicationLogPaths(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. 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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • applicationLogOutputUri

      CreateApplicationRequest.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.

      The log bucket must have permissions that give Amazon GameLift Streams access to write the log files. For more information, see Application log bucket permission policy in the Amazon GameLift Streams Developer Guide.

      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 more ApplicationLogPaths.

      The log bucket must have permissions that give Amazon GameLift Streams access to write the log files. For more information, see Application log bucket permission policy in the Amazon GameLift Streams Developer Guide.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      CreateApplicationRequest.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 Amazon Web Services resources is useful for resource management, access management and cost allocation. See Tagging Amazon Web Services Resources in the Amazon Web Services General Reference. You can use TagResource to add tags, UntagResource to remove tags, and ListTagsForResource to view tags on existing resources.

      Parameters:
      tags - A list of labels to assign to the new application resource. Tags are developer-defined key-value pairs. Tagging Amazon Web Services resources is useful for resource management, access management and cost allocation. See Tagging Amazon Web Services Resources in the Amazon Web Services General Reference. You can use TagResource to add tags, UntagResource to remove tags, and ListTagsForResource to view tags on existing resources.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • clientToken

      CreateApplicationRequest.Builder clientToken(String clientToken)

      A unique identifier that represents a client request. The request is idempotent, which ensures that an API request completes only once. When users send a request, Amazon GameLift Streams automatically populates this field.

      Parameters:
      clientToken - A unique identifier that represents a client request. The request is idempotent, which ensures that an API request completes only once. When users send a request, Amazon GameLift Streams automatically populates this field.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

      CreateApplicationRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      CreateApplicationRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.