gameliftstreams/aws.sdk.kotlin.services.gameliftstreams.model/GetStreamSessionResponse/Builder

Builder

Properties

var additionalEnvironmentVariables: Map<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.

additionalLaunchArgs

var additionalLaunchArgs: List<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.

applicationArn

var applicationArn: String?

The application streaming in this session.

arn

var arn: String?

The Amazon Resource Name (ARN) that's assigned to a stream session resource. When combined with the stream group resource ID, this value uniquely identifies the stream session across all Amazon Web Services Regions. Format is arn:aws:gameliftstreams:[AWS Region]:[AWS account]:streamsession/[stream group resource ID]/[stream session resource ID].

connectionTimeoutSeconds

var connectionTimeoutSeconds: Int?

The maximum length of time (in seconds) that Amazon GameLift Streams keeps the stream session open. At this point, Amazon GameLift Streams ends the stream session regardless of any existing client connections.

createdAt

var createdAt: Instant?

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

description

var description: String?

A human-readable label for the stream session. You can update this value at any time.

exportFilesMetadata

var exportFilesMetadata: ExportFilesMetadata?

Provides details about the stream session's exported files.

lastUpdatedAt

var lastUpdatedAt: Instant?

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

location

var location: String?

The location where Amazon GameLift Streams is hosting the stream session.

logFileLocationUri

var logFileLocationUri: String?

Access location for log files that your content generates during a stream session. These log files are uploaded to cloud storage location at the end of a stream session. The Amazon GameLift Streams application resource defines which log files to upload.

protocol

var protocol: Protocol?

The data transfer protocol in use with the stream session.

sessionLengthSeconds

var sessionLengthSeconds: Int?

The length of time that Amazon GameLift Streams keeps the game session open.

signalRequest

var signalRequest: String?

The WebRTC ICE offer string that a client generates to initiate a connection to the stream session.

signalResponse

var signalResponse: String?

The WebRTC answer string that the stream server generates in response to the SignalRequest.

status

var status: StreamSessionStatus?

The current status of the stream session. A stream session can host clients when in ACTIVE status.

statusReason

var statusReason: StreamSessionStatusReason?

A short description of the reason the stream session is in ERROR status.

streamGroupId

var streamGroupId: String?

The unique identifier for the Amazon GameLift Streams stream group that is hosting the stream session. Format example: sg-1AB2C3De4.

userId

var userId: String?

An opaque, unique identifier for an end-user, defined by the developer.

webSdkProtocolUrl

var webSdkProtocolUrl: String?

The URL of an S3 bucket that stores Amazon GameLift Streams WebSDK files. The URL is used to establish connection with the client.

Functions

exportFilesMetadata

fun exportFilesMetadata(block: ExportFilesMetadata.Builder.() -> Unit)

construct an aws.sdk.kotlin.services.gameliftstreams.model.ExportFilesMetadata inside the given block