Class: Aws::GameLiftStreams::Types::CreateStreamUrlInput

Inherits:

Struct

• Object
• Struct
• Aws::GameLiftStreams::Types::CreateStreamUrlInput

Includes:

Structure

Defined in:

lib/aws-sdk-gameliftstreams/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[:role_arn]

Instance Attribute Summary

• #additional_environment_variables ⇒ Hash<String,String>

  A set of options that you can use to control the stream session runtime environment, expressed as a set of key-value pairs.

• #additional_launch_args ⇒ Array<String>

  A list of CLI arguments that are sent to the streaming server when a stream session launches.

• #application_identifier ⇒ String

  An [Amazon Resource Name (ARN)][1] or ID that uniquely identifies the application resource.

• #client_token ⇒ String

  A unique, case-sensitive identifier that you provide to ensure this request is idempotent.

• #description ⇒ String

  A descriptive label for the stream URL.

• #display_configuration ⇒ Types::DisplayConfiguration

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

• #identifier ⇒ String

  An [Amazon Resource Name (ARN)][1] or ID that uniquely identifies the stream group resource.

• #locations ⇒ Array<String>

  A list of locations, in order of preference, where Amazon GameLift Streams can place the stream session.

• #protocol ⇒ String

  The data transport protocol for the stream session.

• #role_arn ⇒ String

  The Amazon Resource Name (ARN) of the IAM role that Amazon GameLift Streams assumes during stream sessions started from this stream URL.

• #session_length_seconds ⇒ Integer

  The maximum length of time, in seconds, that a stream session started from this stream URL can run.

• #url_expires_after_minutes ⇒ Integer

  The number of minutes after creation that the stream URL remains valid.

• #usage_limit ⇒ Integer

  The maximum number of times the stream URL can start a stream session.

Instance Attribute Details

#additional_environment_variables ⇒ Hash<String,String>

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:

• (Hash<String,String>)

# File 'lib/aws-sdk-gameliftstreams/types.rb', line 1476

class CreateStreamUrlInput < Struct.new(
  :identifier,
  :application_identifier,
  :protocol,
  :url_expires_after_minutes,
  :usage_limit,
  :description,
  :locations,
  :session_length_seconds,
  :additional_launch_args,
  :additional_environment_variables,
  :role_arn,
  :display_configuration,
  :client_token)
  SENSITIVE = [:role_arn]
  include Aws::Structure
end

#additional_launch_args ⇒ Array<String>

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:

• (Array<String>)

# File 'lib/aws-sdk-gameliftstreams/types.rb', line 1476

class CreateStreamUrlInput < Struct.new(
  :identifier,
  :application_identifier,
  :protocol,
  :url_expires_after_minutes,
  :usage_limit,
  :description,
  :locations,
  :session_length_seconds,
  :additional_launch_args,
  :additional_environment_variables,
  :role_arn,
  :display_configuration,
  :client_token)
  SENSITIVE = [:role_arn]
  include Aws::Structure
end

#application_identifier ⇒ String

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:

• (String)

# File 'lib/aws-sdk-gameliftstreams/types.rb', line 1476

class CreateStreamUrlInput < Struct.new(
  :identifier,
  :application_identifier,
  :protocol,
  :url_expires_after_minutes,
  :usage_limit,
  :description,
  :locations,
  :session_length_seconds,
  :additional_launch_args,
  :additional_environment_variables,
  :role_arn,
  :display_configuration,
  :client_token)
  SENSITIVE = [:role_arn]
  include Aws::Structure
end

#client_token ⇒ String

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.

A suitable default value is auto-generated. You should normally not need to pass this option.

Returns:

• (String)

# File 'lib/aws-sdk-gameliftstreams/types.rb', line 1476

class CreateStreamUrlInput < Struct.new(
  :identifier,
  :application_identifier,
  :protocol,
  :url_expires_after_minutes,
  :usage_limit,
  :description,
  :locations,
  :session_length_seconds,
  :additional_launch_args,
  :additional_environment_variables,
  :role_arn,
  :display_configuration,
  :client_token)
  SENSITIVE = [:role_arn]
  include Aws::Structure
end

#description ⇒ String

A descriptive label for the stream URL.

Returns:

• (String)

# File 'lib/aws-sdk-gameliftstreams/types.rb', line 1476

class CreateStreamUrlInput < Struct.new(
  :identifier,
  :application_identifier,
  :protocol,
  :url_expires_after_minutes,
  :usage_limit,
  :description,
  :locations,
  :session_length_seconds,
  :additional_launch_args,
  :additional_environment_variables,
  :role_arn,
  :display_configuration,
  :client_token)
  SENSITIVE = [:role_arn]
  include Aws::Structure
end

#display_configuration ⇒ Types::DisplayConfiguration

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

Returns:

• (Types::DisplayConfiguration)

# File 'lib/aws-sdk-gameliftstreams/types.rb', line 1476

class CreateStreamUrlInput < Struct.new(
  :identifier,
  :application_identifier,
  :protocol,
  :url_expires_after_minutes,
  :usage_limit,
  :description,
  :locations,
  :session_length_seconds,
  :additional_launch_args,
  :additional_environment_variables,
  :role_arn,
  :display_configuration,
  :client_token)
  SENSITIVE = [:role_arn]
  include Aws::Structure
end

#identifier ⇒ String

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:

• (String)

# File 'lib/aws-sdk-gameliftstreams/types.rb', line 1476

class CreateStreamUrlInput < Struct.new(
  :identifier,
  :application_identifier,
  :protocol,
  :url_expires_after_minutes,
  :usage_limit,
  :description,
  :locations,
  :session_length_seconds,
  :additional_launch_args,
  :additional_environment_variables,
  :role_arn,
  :display_configuration,
  :client_token)
  SENSITIVE = [:role_arn]
  include Aws::Structure
end

#locations ⇒ Array<String>

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:

• (Array<String>)

# File 'lib/aws-sdk-gameliftstreams/types.rb', line 1476

class CreateStreamUrlInput < Struct.new(
  :identifier,
  :application_identifier,
  :protocol,
  :url_expires_after_minutes,
  :usage_limit,
  :description,
  :locations,
  :session_length_seconds,
  :additional_launch_args,
  :additional_environment_variables,
  :role_arn,
  :display_configuration,
  :client_token)
  SENSITIVE = [:role_arn]
  include Aws::Structure
end

#protocol ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-gameliftstreams/types.rb', line 1476

class CreateStreamUrlInput < Struct.new(
  :identifier,
  :application_identifier,
  :protocol,
  :url_expires_after_minutes,
  :usage_limit,
  :description,
  :locations,
  :session_length_seconds,
  :additional_launch_args,
  :additional_environment_variables,
  :role_arn,
  :display_configuration,
  :client_token)
  SENSITIVE = [:role_arn]
  include Aws::Structure
end

#role_arn ⇒ String

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:

• (String)

# File 'lib/aws-sdk-gameliftstreams/types.rb', line 1476

class CreateStreamUrlInput < Struct.new(
  :identifier,
  :application_identifier,
  :protocol,
  :url_expires_after_minutes,
  :usage_limit,
  :description,
  :locations,
  :session_length_seconds,
  :additional_launch_args,
  :additional_environment_variables,
  :role_arn,
  :display_configuration,
  :client_token)
  SENSITIVE = [:role_arn]
  include Aws::Structure
end

#session_length_seconds ⇒ Integer

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:

• (Integer)

# File 'lib/aws-sdk-gameliftstreams/types.rb', line 1476

class CreateStreamUrlInput < Struct.new(
  :identifier,
  :application_identifier,
  :protocol,
  :url_expires_after_minutes,
  :usage_limit,
  :description,
  :locations,
  :session_length_seconds,
  :additional_launch_args,
  :additional_environment_variables,
  :role_arn,
  :display_configuration,
  :client_token)
  SENSITIVE = [:role_arn]
  include Aws::Structure
end

#url_expires_after_minutes ⇒ Integer

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:

• (Integer)

# File 'lib/aws-sdk-gameliftstreams/types.rb', line 1476

class CreateStreamUrlInput < Struct.new(
  :identifier,
  :application_identifier,
  :protocol,
  :url_expires_after_minutes,
  :usage_limit,
  :description,
  :locations,
  :session_length_seconds,
  :additional_launch_args,
  :additional_environment_variables,
  :role_arn,
  :display_configuration,
  :client_token)
  SENSITIVE = [:role_arn]
  include Aws::Structure
end

#usage_limit ⇒ Integer

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:

• (Integer)

# File 'lib/aws-sdk-gameliftstreams/types.rb', line 1476

class CreateStreamUrlInput < Struct.new(
  :identifier,
  :application_identifier,
  :protocol,
  :url_expires_after_minutes,
  :usage_limit,
  :description,
  :locations,
  :session_length_seconds,
  :additional_launch_args,
  :additional_environment_variables,
  :role_arn,
  :display_configuration,
  :client_token)
  SENSITIVE = [:role_arn]
  include Aws::Structure
end