Struct CreateStreamSessionConnectionInput 

#[non_exhaustive]
pub struct CreateStreamSessionConnectionInput {
    pub client_token: Option<String>,
    pub identifier: Option<String>,
    pub stream_session_identifier: Option<String>,
    pub signal_request: Option<String>,
}

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

client_token: Option<String>

A unique identifier that represents a client request. The request is idempotent, which ensures that an API request completes only once. When users send a request, Amazon GameLift Streams automatically populates this field.

identifier: Option<String>

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 group that you want to run this stream session with. The stream group must be in ACTIVE status.

stream_session_identifier: Option<String>

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

The stream session must be in PENDING_CLIENT_RECONNECTION or ACTIVE status.

signal_request: Option<String>

A WebRTC ICE offer string to use when initializing a WebRTC connection. The offer is a very long JSON string. Provide the string as a text value in quotes. The offer must be newly generated, not the same offer provided to StartStreamSession.

Implementations

impl CreateStreamSessionConnectionInput

pub fn client_token(&self) -> Option<&str>

A unique identifier that represents a client request. The request is idempotent, which ensures that an API request completes only once. When users send a request, Amazon GameLift Streams automatically populates this field.

pub fn identifier(&self) -> Option<&str>

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 group that you want to run this stream session with. The stream group must be in ACTIVE status.

pub fn stream_session_identifier(&self) -> Option<&str>

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

The stream session must be in PENDING_CLIENT_RECONNECTION or ACTIVE status.

pub fn signal_request(&self) -> Option<&str>

A WebRTC ICE offer string to use when initializing a WebRTC connection. The offer is a very long JSON string. Provide the string as a text value in quotes. The offer must be newly generated, not the same offer provided to StartStreamSession.

impl CreateStreamSessionConnectionInput

pub fn builder() -> CreateStreamSessionConnectionInputBuilder

Creates a new builder-style object to manufacture CreateStreamSessionConnectionInput.

Trait Implementations

impl Clone for CreateStreamSessionConnectionInput

fn clone(&self) -> CreateStreamSessionConnectionInput

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CreateStreamSessionConnectionInput

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for CreateStreamSessionConnectionInput

fn eq(&self, other: &CreateStreamSessionConnectionInput) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for CreateStreamSessionConnectionInput