gameliftstreams/aws.sdk.kotlin.services.gameliftstreams.model/StreamUrlSummary

StreamUrlSummary

Describes a stream URL. This is a summary view that omits the full configuration, such as launch arguments and display settings. To retrieve the complete configuration, call GetStreamUrl.

Types

Builder

class Builder

Companion

object Companion

Properties

applicationArn

val applicationArn: String?

The application that runs in the stream sessions.

arn

val 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].

createdAt

val 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

val description: String?

The descriptive label for the stream URL.

expiresAt

val expiresAt: Instant?

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

remainingUses

val remainingUses: Int?

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

sessionLengthSeconds

val sessionLengthSeconds: Int?

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

status

val status: StreamUrlStatus?

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

statusReason

val statusReason: StreamUrlStatusReason?

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:

streamGroupArn

val streamGroupArn: String?

The stream group that runs the stream sessions.

streamUrl

val streamUrl: 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.

streamUrlId

val streamUrlId: String?

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

usageLimit

val usageLimit: Int?

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

Functions

copy

inline fun copy(block: StreamUrlSummary.Builder.() -> Unit = {}): StreamUrlSummary

equals

open operator override fun equals(other: Any?): Boolean

hashCode

open override fun hashCode(): Int

toString

open override fun toString(): String