Class: Aws::GameLiftStreams::Types::GetStreamUrlOutput

Inherits:

Struct

• Object
• Struct
• Aws::GameLiftStreams::Types::GetStreamUrlOutput

Defined in:

gems/aws-sdk-gameliftstreams/lib/aws-sdk-gameliftstreams/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[:stream_url, :role_arn]

Instance Attribute Summary

• #additional_environment_variables ⇒ Hash<String,String>

  The environment variables made available to the application when a stream session starts.

• #additional_launch_args ⇒ Array<String>

  The command-line arguments passed to the application when a stream session starts.

• #application_arn ⇒ String

  The application that runs in the stream sessions.

• #arn ⇒ String

  The [Amazon Resource Name (ARN)][1] that uniquely identifies the stream URL across all Amazon Web Services Regions.

• #created_at ⇒ Time

  A timestamp that indicates when this resource was created.

• #description ⇒ String

  The descriptive label for the stream URL.

• #display_configuration ⇒ Types::DisplayConfiguration

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

• #expires_at ⇒ Time

  The date and time when the stream URL expires and stops accepting new stream sessions.

• #locations ⇒ Array<String>

  The list of locations, in order of preference, where Amazon GameLift Streams places the stream session.

• #protocol ⇒ String

  The data transport protocol used for stream sessions started from this stream URL.

• #remaining_uses ⇒ Integer

  The number of times the stream URL can still be used to start a 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.

• #status ⇒ String

  The current status of the stream URL.

• #status_reason ⇒ String

  Additional information about why the stream URL is in its current status.

• #stream_group_arn ⇒ String

  The stream group that runs the stream sessions.

• #stream_sessions ⇒ Array<Types::StreamSessionSummary>

  A list of the stream sessions that have been started through this stream URL.

• #stream_url ⇒ String

  The shareable stream URL.

• #stream_url_id ⇒ String

  The unique identifier for the stream URL resource, for example su-1AB2C3De4.

• #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>

The environment variables made available to the application when a stream session starts.

Returns:

• (Hash<String,String>)

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

class GetStreamUrlOutput < Struct.new(
  :arn,
  :stream_url_id,
  :stream_url,
  :status,
  :status_reason,
  :expires_at,
  :created_at,
  :usage_limit,
  :remaining_uses,
  :stream_group_arn,
  :application_arn,
  :protocol,
  :locations,
  :session_length_seconds,
  :description,
  :additional_launch_args,
  :additional_environment_variables,
  :role_arn,
  :display_configuration,
  :stream_sessions)
  SENSITIVE = [:stream_url, :role_arn]
  include Aws::Structure
end

#additional_launch_args ⇒ Array<String>

The command-line arguments passed to the application when a stream session starts.

Returns:

• (Array<String>)

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

class GetStreamUrlOutput < Struct.new(
  :arn,
  :stream_url_id,
  :stream_url,
  :status,
  :status_reason,
  :expires_at,
  :created_at,
  :usage_limit,
  :remaining_uses,
  :stream_group_arn,
  :application_arn,
  :protocol,
  :locations,
  :session_length_seconds,
  :description,
  :additional_launch_args,
  :additional_environment_variables,
  :role_arn,
  :display_configuration,
  :stream_sessions)
  SENSITIVE = [:stream_url, :role_arn]
  include Aws::Structure
end

#application_arn ⇒ String

The application that runs in the stream sessions.

This value is an Amazon Resource Name (ARN) that uniquely identifies the application resource. Example ARN: arn:aws:gameliftstreams:us-west-2:111122223333:application/a-9ZY8X7Wv6.

Returns:

• (String)

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

class GetStreamUrlOutput < Struct.new(
  :arn,
  :stream_url_id,
  :stream_url,
  :status,
  :status_reason,
  :expires_at,
  :created_at,
  :usage_limit,
  :remaining_uses,
  :stream_group_arn,
  :application_arn,
  :protocol,
  :locations,
  :session_length_seconds,
  :description,
  :additional_launch_args,
  :additional_environment_variables,
  :role_arn,
  :display_configuration,
  :stream_sessions)
  SENSITIVE = [:stream_url, :role_arn]
  include Aws::Structure
end

#arn ⇒ String

The Amazon Resource Name (ARN) that uniquely identifies the stream URL across all Amazon Web Services Regions. Format is arn:aws:gameliftstreams:[AWS Region]:[AWS account]:streamurl/[stream group resource ID]/[stream URL resource ID].

Returns:

• (String)

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

class GetStreamUrlOutput < Struct.new(
  :arn,
  :stream_url_id,
  :stream_url,
  :status,
  :status_reason,
  :expires_at,
  :created_at,
  :usage_limit,
  :remaining_uses,
  :stream_group_arn,
  :application_arn,
  :protocol,
  :locations,
  :session_length_seconds,
  :description,
  :additional_launch_args,
  :additional_environment_variables,
  :role_arn,
  :display_configuration,
  :stream_sessions)
  SENSITIVE = [:stream_url, :role_arn]
  include Aws::Structure
end

#created_at ⇒ Time

A timestamp that indicates when this resource was created. Timestamps are expressed using in ISO8601 format, such as: 2022-12-27T22:29:40+00:00 (UTC).

Returns:

• (Time)

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

class GetStreamUrlOutput < Struct.new(
  :arn,
  :stream_url_id,
  :stream_url,
  :status,
  :status_reason,
  :expires_at,
  :created_at,
  :usage_limit,
  :remaining_uses,
  :stream_group_arn,
  :application_arn,
  :protocol,
  :locations,
  :session_length_seconds,
  :description,
  :additional_launch_args,
  :additional_environment_variables,
  :role_arn,
  :display_configuration,
  :stream_sessions)
  SENSITIVE = [:stream_url, :role_arn]
  include Aws::Structure
end

#description ⇒ String

The descriptive label for the stream URL.

Returns:

• (String)

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

class GetStreamUrlOutput < Struct.new(
  :arn,
  :stream_url_id,
  :stream_url,
  :status,
  :status_reason,
  :expires_at,
  :created_at,
  :usage_limit,
  :remaining_uses,
  :stream_group_arn,
  :application_arn,
  :protocol,
  :locations,
  :session_length_seconds,
  :description,
  :additional_launch_args,
  :additional_environment_variables,
  :role_arn,
  :display_configuration,
  :stream_sessions)
  SENSITIVE = [:stream_url, :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 'gems/aws-sdk-gameliftstreams/lib/aws-sdk-gameliftstreams/types.rb', line 2966

class GetStreamUrlOutput < Struct.new(
  :arn,
  :stream_url_id,
  :stream_url,
  :status,
  :status_reason,
  :expires_at,
  :created_at,
  :usage_limit,
  :remaining_uses,
  :stream_group_arn,
  :application_arn,
  :protocol,
  :locations,
  :session_length_seconds,
  :description,
  :additional_launch_args,
  :additional_environment_variables,
  :role_arn,
  :display_configuration,
  :stream_sessions)
  SENSITIVE = [:stream_url, :role_arn]
  include Aws::Structure
end

#expires_at ⇒ Time

The date and time when the stream URL expires and stops accepting new stream sessions. Timestamps are expressed using in ISO8601 format, such as: 2022-12-27T22:29:40+00:00 (UTC).

Returns:

• (Time)

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

class GetStreamUrlOutput < Struct.new(
  :arn,
  :stream_url_id,
  :stream_url,
  :status,
  :status_reason,
  :expires_at,
  :created_at,
  :usage_limit,
  :remaining_uses,
  :stream_group_arn,
  :application_arn,
  :protocol,
  :locations,
  :session_length_seconds,
  :description,
  :additional_launch_args,
  :additional_environment_variables,
  :role_arn,
  :display_configuration,
  :stream_sessions)
  SENSITIVE = [:stream_url, :role_arn]
  include Aws::Structure
end

#locations ⇒ Array<String>

The list of locations, in order of preference, where Amazon GameLift Streams places the stream session. 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 'gems/aws-sdk-gameliftstreams/lib/aws-sdk-gameliftstreams/types.rb', line 2966

class GetStreamUrlOutput < Struct.new(
  :arn,
  :stream_url_id,
  :stream_url,
  :status,
  :status_reason,
  :expires_at,
  :created_at,
  :usage_limit,
  :remaining_uses,
  :stream_group_arn,
  :application_arn,
  :protocol,
  :locations,
  :session_length_seconds,
  :description,
  :additional_launch_args,
  :additional_environment_variables,
  :role_arn,
  :display_configuration,
  :stream_sessions)
  SENSITIVE = [:stream_url, :role_arn]
  include Aws::Structure
end

#protocol ⇒ String

The data transport protocol used for stream sessions started from this stream URL.

Returns:

• (String)

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

class GetStreamUrlOutput < Struct.new(
  :arn,
  :stream_url_id,
  :stream_url,
  :status,
  :status_reason,
  :expires_at,
  :created_at,
  :usage_limit,
  :remaining_uses,
  :stream_group_arn,
  :application_arn,
  :protocol,
  :locations,
  :session_length_seconds,
  :description,
  :additional_launch_args,
  :additional_environment_variables,
  :role_arn,
  :display_configuration,
  :stream_sessions)
  SENSITIVE = [:stream_url, :role_arn]
  include Aws::Structure
end

#remaining_uses ⇒ Integer

The number of times the stream URL can still be used to start a stream session.

Returns:

• (Integer)

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

class GetStreamUrlOutput < Struct.new(
  :arn,
  :stream_url_id,
  :stream_url,
  :status,
  :status_reason,
  :expires_at,
  :created_at,
  :usage_limit,
  :remaining_uses,
  :stream_group_arn,
  :application_arn,
  :protocol,
  :locations,
  :session_length_seconds,
  :description,
  :additional_launch_args,
  :additional_environment_variables,
  :role_arn,
  :display_configuration,
  :stream_sessions)
  SENSITIVE = [:stream_url, :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 'gems/aws-sdk-gameliftstreams/lib/aws-sdk-gameliftstreams/types.rb', line 2966

class GetStreamUrlOutput < Struct.new(
  :arn,
  :stream_url_id,
  :stream_url,
  :status,
  :status_reason,
  :expires_at,
  :created_at,
  :usage_limit,
  :remaining_uses,
  :stream_group_arn,
  :application_arn,
  :protocol,
  :locations,
  :session_length_seconds,
  :description,
  :additional_launch_args,
  :additional_environment_variables,
  :role_arn,
  :display_configuration,
  :stream_sessions)
  SENSITIVE = [:stream_url, :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.

Returns:

• (Integer)

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

class GetStreamUrlOutput < Struct.new(
  :arn,
  :stream_url_id,
  :stream_url,
  :status,
  :status_reason,
  :expires_at,
  :created_at,
  :usage_limit,
  :remaining_uses,
  :stream_group_arn,
  :application_arn,
  :protocol,
  :locations,
  :session_length_seconds,
  :description,
  :additional_launch_args,
  :additional_environment_variables,
  :role_arn,
  :display_configuration,
  :stream_sessions)
  SENSITIVE = [:stream_url, :role_arn]
  include Aws::Structure
end

#status ⇒ String

The current status of the stream URL. Possible statuses include the following:

• ACTIVE: The stream URL is valid and can start stream sessions.

• EXPIRED: The stream URL has passed its expiration time and can no longer start stream sessions.

• REVOKED: The stream URL was revoked and can no longer start stream sessions.

• LIMIT_REACHED: The stream URL has been used the maximum number of times and can no longer start stream sessions.

Returns:

• (String)

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

class GetStreamUrlOutput < Struct.new(
  :arn,
  :stream_url_id,
  :stream_url,
  :status,
  :status_reason,
  :expires_at,
  :created_at,
  :usage_limit,
  :remaining_uses,
  :stream_group_arn,
  :application_arn,
  :protocol,
  :locations,
  :session_length_seconds,
  :description,
  :additional_launch_args,
  :additional_environment_variables,
  :role_arn,
  :display_configuration,
  :stream_sessions)
  SENSITIVE = [:stream_url, :role_arn]
  include Aws::Structure
end

#status_reason ⇒ String

Additional information about why the stream URL is in its current status. Amazon GameLift Streams populates this value when the status is REVOKED. Possible values include the following:

• userRevoked: You revoked the stream URL.

• revokedAndTerminatingSessions: You revoked the stream URL and Amazon GameLift Streams is ending its running stream sessions.

• revokedAndSessionsTerminated: You revoked the stream URL and its running stream sessions have ended.

• streamGroupDeleted: The stream group was deleted, which revoked the stream URL.

• applicationDeleted: The application was deleted, which revoked the stream URL.

Returns:

• (String)

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

class GetStreamUrlOutput < Struct.new(
  :arn,
  :stream_url_id,
  :stream_url,
  :status,
  :status_reason,
  :expires_at,
  :created_at,
  :usage_limit,
  :remaining_uses,
  :stream_group_arn,
  :application_arn,
  :protocol,
  :locations,
  :session_length_seconds,
  :description,
  :additional_launch_args,
  :additional_environment_variables,
  :role_arn,
  :display_configuration,
  :stream_sessions)
  SENSITIVE = [:stream_url, :role_arn]
  include Aws::Structure
end

#stream_group_arn ⇒ String

The stream group that runs the stream sessions.

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

Returns:

• (String)

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

class GetStreamUrlOutput < Struct.new(
  :arn,
  :stream_url_id,
  :stream_url,
  :status,
  :status_reason,
  :expires_at,
  :created_at,
  :usage_limit,
  :remaining_uses,
  :stream_group_arn,
  :application_arn,
  :protocol,
  :locations,
  :session_length_seconds,
  :description,
  :additional_launch_args,
  :additional_environment_variables,
  :role_arn,
  :display_configuration,
  :stream_sessions)
  SENSITIVE = [:stream_url, :role_arn]
  include Aws::Structure
end

#stream_sessions ⇒ Array<Types::StreamSessionSummary>

A list of the stream sessions that have been started through this stream URL.

Returns:

• (Array<Types::StreamSessionSummary>)

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

class GetStreamUrlOutput < Struct.new(
  :arn,
  :stream_url_id,
  :stream_url,
  :status,
  :status_reason,
  :expires_at,
  :created_at,
  :usage_limit,
  :remaining_uses,
  :stream_group_arn,
  :application_arn,
  :protocol,
  :locations,
  :session_length_seconds,
  :description,
  :additional_launch_args,
  :additional_environment_variables,
  :role_arn,
  :display_configuration,
  :stream_sessions)
  SENSITIVE = [:stream_url, :role_arn]
  include Aws::Structure
end

#stream_url ⇒ String

The shareable stream URL. Distribute this URL to end users so that they can start and play a stream session in a hosted web player. Treat the stream URL as a secret. Anyone who has it can start a stream session until the stream URL expires, is revoked, or reaches its usage limit.

Returns:

• (String)

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

class GetStreamUrlOutput < Struct.new(
  :arn,
  :stream_url_id,
  :stream_url,
  :status,
  :status_reason,
  :expires_at,
  :created_at,
  :usage_limit,
  :remaining_uses,
  :stream_group_arn,
  :application_arn,
  :protocol,
  :locations,
  :session_length_seconds,
  :description,
  :additional_launch_args,
  :additional_environment_variables,
  :role_arn,
  :display_configuration,
  :stream_sessions)
  SENSITIVE = [:stream_url, :role_arn]
  include Aws::Structure
end

#stream_url_id ⇒ String

The unique identifier for the stream URL resource, for example su-1AB2C3De4.

Returns:

• (String)

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

class GetStreamUrlOutput < Struct.new(
  :arn,
  :stream_url_id,
  :stream_url,
  :status,
  :status_reason,
  :expires_at,
  :created_at,
  :usage_limit,
  :remaining_uses,
  :stream_group_arn,
  :application_arn,
  :protocol,
  :locations,
  :session_length_seconds,
  :description,
  :additional_launch_args,
  :additional_environment_variables,
  :role_arn,
  :display_configuration,
  :stream_sessions)
  SENSITIVE = [:stream_url, :role_arn]
  include Aws::Structure
end

#usage_limit ⇒ Integer

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

Returns:

• (Integer)

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

class GetStreamUrlOutput < Struct.new(
  :arn,
  :stream_url_id,
  :stream_url,
  :status,
  :status_reason,
  :expires_at,
  :created_at,
  :usage_limit,
  :remaining_uses,
  :stream_group_arn,
  :application_arn,
  :protocol,
  :locations,
  :session_length_seconds,
  :description,
  :additional_launch_args,
  :additional_environment_variables,
  :role_arn,
  :display_configuration,
  :stream_sessions)
  SENSITIVE = [:stream_url, :role_arn]
  include Aws::Structure
end