Interface CreateStreamUrlRequest.Builder

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

  • Method Details

    • identifier

      CreateStreamUrlRequest.Builder identifier(String identifier)

      An Amazon Resource Name (ARN) or ID that uniquely identifies the stream group resource. Example ARN: arn:aws:gameliftstreams:us-west-2:111122223333:streamgroup/sg-1AB2C3De4. Example ID: sg-1AB2C3De4.

      The stream session runs in this stream group.

      Parameters:
      identifier - An Amazon Resource Name (ARN) or ID that uniquely identifies the stream group resource. Example ARN: arn:aws:gameliftstreams:us-west-2:111122223333:streamgroup/sg-1AB2C3De4. Example ID: sg-1AB2C3De4.

      The stream session runs in this stream group.

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

    • applicationIdentifier

      CreateStreamUrlRequest.Builder applicationIdentifier(String applicationIdentifier)

      An Amazon Resource Name (ARN) or ID that uniquely identifies the application resource. Example ARN: arn:aws:gameliftstreams:us-west-2:111122223333:application/a-9ZY8X7Wv6. Example ID: a-9ZY8X7Wv6.

      This application must be associated with the stream group.

      Parameters:
      applicationIdentifier - An Amazon Resource Name (ARN) or ID that uniquely identifies the application resource. Example ARN: arn:aws:gameliftstreams:us-west-2:111122223333:application/a-9ZY8X7Wv6. Example ID: a-9ZY8X7Wv6.

      This application must be associated with the stream group.

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

    • protocol

      CreateStreamUrlRequest.Builder protocol(String protocol)

      The data transport protocol for the stream session. Amazon GameLift Streams supports WebRTC.

      Parameters:
      protocol - The data transport protocol for the stream session. Amazon GameLift Streams supports WebRTC.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • protocol

      CreateStreamUrlRequest.Builder protocol(Protocol protocol)

      The data transport protocol for the stream session. Amazon GameLift Streams supports WebRTC.

      Parameters:
      protocol - The data transport protocol for the stream session. Amazon GameLift Streams supports WebRTC.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • urlExpiresAfterMinutes

      CreateStreamUrlRequest.Builder urlExpiresAfterMinutes(Integer urlExpiresAfterMinutes)

      The number of minutes after creation that the stream URL remains valid. After this period, the status of the stream URL changes to EXPIRED and it can no longer start stream sessions. The minimum is 1 minute. For the maximum, see Regions, quotas, and limitations in the Amazon GameLift Streams Developer Guide.

      Parameters:
      urlExpiresAfterMinutes - The number of minutes after creation that the stream URL remains valid. After this period, the status of the stream URL changes to EXPIRED and it can no longer start stream sessions. The minimum is 1 minute. For the maximum, see Regions, quotas, and limitations in the Amazon GameLift Streams Developer Guide.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • usageLimit

      CreateStreamUrlRequest.Builder usageLimit(Integer usageLimit)

      The maximum number of times the stream URL can start a stream session. Each successful use reduces the remaining uses by one. The minimum is 1, and the default is 1. For the maximum, see Regions, quotas, and limitations in the Amazon GameLift Streams Developer Guide.

      Parameters:
      usageLimit - The maximum number of times the stream URL can start a stream session. Each successful use reduces the remaining uses by one. The minimum is 1, and the default is 1. For the maximum, see Regions, quotas, and limitations in the Amazon GameLift Streams Developer Guide.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • description

      CreateStreamUrlRequest.Builder description(String description)

      A descriptive label for the stream URL.

      Parameters:
      description - A descriptive label for the stream URL.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • locations

      CreateStreamUrlRequest.Builder locations(Collection<String> locations)

      A list of locations, in order of preference, where Amazon GameLift Streams can place the stream session. Specify each location by its Amazon Web Services Region code, for example us-east-1. For a complete list of locations that Amazon GameLift Streams supports, refer to Regions, quotas, and limitations in the Amazon GameLift Streams Developer Guide.

      Parameters:
      locations - A list of locations, in order of preference, where Amazon GameLift Streams can place the stream session. Specify each location by its Amazon Web Services Region code, for example us-east-1. For a complete list of locations that Amazon GameLift Streams supports, refer to Regions, quotas, and limitations in the Amazon GameLift Streams Developer Guide.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • locations

      CreateStreamUrlRequest.Builder locations(String... locations)

      A list of locations, in order of preference, where Amazon GameLift Streams can place the stream session. Specify each location by its Amazon Web Services Region code, for example us-east-1. For a complete list of locations that Amazon GameLift Streams supports, refer to Regions, quotas, and limitations in the Amazon GameLift Streams Developer Guide.

      Parameters:
      locations - A list of locations, in order of preference, where Amazon GameLift Streams can place the stream session. Specify each location by its Amazon Web Services Region code, for example us-east-1. For a complete list of locations that Amazon GameLift Streams supports, refer to Regions, quotas, and limitations in the Amazon GameLift Streams Developer Guide.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • sessionLengthSeconds

      CreateStreamUrlRequest.Builder sessionLengthSeconds(Integer sessionLengthSeconds)

      The maximum length of time, in seconds, that a stream session started from this stream URL can run. Valid values are 1-86400 seconds (1 second to 24 hours). The default is 43200 seconds (12 hours).

      Parameters:
      sessionLengthSeconds - The maximum length of time, in seconds, that a stream session started from this stream URL can run. Valid values are 1-86400 seconds (1 second to 24 hours). The default is 43200 seconds (12 hours).
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • additionalLaunchArgs

      CreateStreamUrlRequest.Builder additionalLaunchArgs(Collection<String> additionalLaunchArgs)

      A list of CLI arguments that are sent to the streaming server when a stream session launches. You can use this to configure the application or stream session details. You can also provide custom arguments that Amazon GameLift Streams passes to your game client.

      AdditionalEnvironmentVariables and AdditionalLaunchArgs have similar purposes. AdditionalEnvironmentVariables passes data using environment variables; while AdditionalLaunchArgs passes data using command-line arguments.

      Parameters:
      additionalLaunchArgs - A list of CLI arguments that are sent to the streaming server when a stream session launches. You can use this to configure the application or stream session details. You can also provide custom arguments that Amazon GameLift Streams passes to your game client.

      AdditionalEnvironmentVariables and AdditionalLaunchArgs have similar purposes. AdditionalEnvironmentVariables passes data using environment variables; while AdditionalLaunchArgs passes data using command-line arguments.

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

    • additionalLaunchArgs

      CreateStreamUrlRequest.Builder additionalLaunchArgs(String... additionalLaunchArgs)

      A list of CLI arguments that are sent to the streaming server when a stream session launches. You can use this to configure the application or stream session details. You can also provide custom arguments that Amazon GameLift Streams passes to your game client.

      AdditionalEnvironmentVariables and AdditionalLaunchArgs have similar purposes. AdditionalEnvironmentVariables passes data using environment variables; while AdditionalLaunchArgs passes data using command-line arguments.

      Parameters:
      additionalLaunchArgs - A list of CLI arguments that are sent to the streaming server when a stream session launches. You can use this to configure the application or stream session details. You can also provide custom arguments that Amazon GameLift Streams passes to your game client.

      AdditionalEnvironmentVariables and AdditionalLaunchArgs have similar purposes. AdditionalEnvironmentVariables passes data using environment variables; while AdditionalLaunchArgs passes data using command-line arguments.

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

    • additionalEnvironmentVariables

      CreateStreamUrlRequest.Builder additionalEnvironmentVariables(Map<String,String> additionalEnvironmentVariables)

      A set of options that you can use to control the stream session runtime environment, expressed as a set of key-value pairs. You can use this to configure the application or stream session details. You can also provide custom environment variables that Amazon GameLift Streams passes to your game client.

      If you want to debug your application with environment variables, we recommend that you do so in a local environment outside of Amazon GameLift Streams. For more information, refer to the Compatibility Guidance in the troubleshooting section of the Developer Guide.

      AdditionalEnvironmentVariables and AdditionalLaunchArgs have similar purposes. AdditionalEnvironmentVariables passes data using environment variables; while AdditionalLaunchArgs passes data using command-line arguments.

      Parameters:
      additionalEnvironmentVariables - A set of options that you can use to control the stream session runtime environment, expressed as a set of key-value pairs. You can use this to configure the application or stream session details. You can also provide custom environment variables that Amazon GameLift Streams passes to your game client.

      If you want to debug your application with environment variables, we recommend that you do so in a local environment outside of Amazon GameLift Streams. For more information, refer to the Compatibility Guidance in the troubleshooting section of the Developer Guide.

      AdditionalEnvironmentVariables and AdditionalLaunchArgs have similar purposes. AdditionalEnvironmentVariables passes data using environment variables; while AdditionalLaunchArgs passes data using command-line arguments.

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

    • roleArn

      CreateStreamUrlRequest.Builder roleArn(String roleArn)

      The Amazon Resource Name (ARN) of the IAM role that Amazon GameLift Streams assumes during stream sessions started from this stream URL. For more information, see Provide AWS credentials to your streaming application in the Amazon GameLift Streams Developer Guide.

      Parameters:
      roleArn - The Amazon Resource Name (ARN) of the IAM role that Amazon GameLift Streams assumes during stream sessions started from this stream URL. For more information, see Provide AWS credentials to your streaming application in the Amazon GameLift Streams Developer Guide.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • displayConfiguration

      CreateStreamUrlRequest.Builder displayConfiguration(DisplayConfiguration displayConfiguration)

      The display settings, such as resolution, for stream sessions started from this stream URL.

      Parameters:
      displayConfiguration - The display settings, such as resolution, for stream sessions started from this stream URL.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • displayConfiguration

      default CreateStreamUrlRequest.Builder displayConfiguration(Consumer<DisplayConfiguration.Builder> displayConfiguration)

      The display settings, such as resolution, for stream sessions started from this stream URL.

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

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

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

    • clientToken

      CreateStreamUrlRequest.Builder clientToken(String clientToken)

      A unique, case-sensitive identifier that you provide to ensure this request is idempotent. If you retry a request with the same ClientToken, Amazon GameLift Streams returns the original response without performing the operation again.

      Parameters:
      clientToken - A unique, case-sensitive identifier that you provide to ensure this request is idempotent. If you retry a request with the same ClientToken, Amazon GameLift Streams returns the original response without performing the operation again.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

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

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