Struct aws_sdk_nimble::types::StreamingSession

#[non_exhaustive]
pub struct StreamingSession {

    pub arn: Option<String>,
    pub created_at: Option<DateTime>,
    pub created_by: Option<String>,
    pub ec2_instance_type: Option<String>,
    pub launch_profile_id: Option<String>,
    pub owned_by: Option<String>,
    pub session_id: Option<String>,
    pub state: Option<StreamingSessionState>,
    pub status_code: Option<StreamingSessionStatusCode>,
    pub status_message: Option<String>,
    pub streaming_image_id: Option<String>,
    pub tags: Option<HashMap<String, String>>,
    pub terminate_at: Option<DateTime>,
    pub updated_at: Option<DateTime>,
    pub updated_by: Option<String>,
    pub stopped_at: Option<DateTime>,
    pub stopped_by: Option<String>,
    pub started_at: Option<DateTime>,
    pub started_by: Option<String>,
    pub stop_at: Option<DateTime>,
    pub started_from_backup_id: Option<String>,
    pub backup_mode: Option<SessionBackupMode>,
    pub max_backups_to_retain: i32,
    pub volume_retention_mode: Option<VolumeRetentionMode>,
    pub session_persistence_mode: Option<SessionPersistenceMode>,
    pub volume_configuration: Option<VolumeConfiguration>,
    pub automatic_termination_mode: Option<AutomaticTerminationMode>,
}

A streaming session is a virtual workstation created using a particular launch profile.

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.

arn: Option<String>

The Amazon Resource Name (ARN) that is assigned to a studio resource and uniquely identifies it. ARNs are unique across all Regions.

created_at: Option<DateTime>

The ISO timestamp in seconds for when the resource was created.

created_by: Option<String>

The user ID of the user that created the streaming session.

ec2_instance_type: Option<String>

The EC2 Instance type used for the streaming session.

launch_profile_id: Option<String>

The ID of the launch profile used to control access from the streaming session.

owned_by: Option<String>

The user ID of the user that owns the streaming session. The user that owns the session will be logging into the session and interacting with the virtual workstation.

session_id: Option<String>

The session ID.

state: Option<StreamingSessionState>

The current state.

status_code: Option<StreamingSessionStatusCode>

The status code.

status_message: Option<String>

The status message for the streaming session.

streaming_image_id: Option<String>

The ID of the streaming image.

tags: Option<HashMap<String, String>>

A collection of labels, in the form of key-value pairs, that apply to this resource.

terminate_at: Option<DateTime>

The time the streaming session will automatically terminate if not terminated by the user.

updated_at: Option<DateTime>

The ISO timestamp in seconds for when the resource was updated.

updated_by: Option<String>

The user ID of the user that most recently updated the resource.

stopped_at: Option<DateTime>

The time the session entered STOP_IN_PROGRESS state.

stopped_by: Option<String>

The user ID of the user that stopped the streaming session.

started_at: Option<DateTime>

The time the session entered START_IN_PROGRESS state.

started_by: Option<String>

The user ID of the user that started the streaming session.

stop_at: Option<DateTime>

The time the streaming session will automatically be stopped if the user doesn’t stop the session themselves.

started_from_backup_id: Option<String>

The backup ID used to restore a streaming session.

backup_mode: Option<SessionBackupMode>

Shows the current backup setting of the session.

max_backups_to_retain: i32

The maximum number of backups of a streaming session that you can have. When the maximum number of backups is reached, the oldest backup is deleted.

volume_retention_mode: Option<VolumeRetentionMode>

Determine if an EBS volume created from this streaming session will be backed up.

session_persistence_mode: Option<SessionPersistenceMode>

Determine if a streaming session created from this launch profile can configure persistent storage. This means that volumeConfiguration and automaticTerminationMode are configured.

volume_configuration: Option<VolumeConfiguration>

Custom volume configuration for the root volumes that are attached to streaming sessions.

This parameter is only allowed when sessionPersistenceMode is ACTIVATED.

automatic_termination_mode: Option<AutomaticTerminationMode>

Indicates if a streaming session created from this launch profile should be terminated automatically or retained without termination after being in a STOPPED state.

• When ACTIVATED, the streaming session is scheduled for termination after being in the STOPPED state for the time specified in maxStoppedSessionLengthInMinutes.

• When DEACTIVATED, the streaming session can remain in the STOPPED state indefinitely.

This parameter is only allowed when sessionPersistenceMode is ACTIVATED. When allowed, the default value for this parameter is DEACTIVATED.

Implementations

impl StreamingSession

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

The Amazon Resource Name (ARN) that is assigned to a studio resource and uniquely identifies it. ARNs are unique across all Regions.

pub fn created_at(&self) -> Option<&DateTime>

The ISO timestamp in seconds for when the resource was created.

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

The user ID of the user that created the streaming session.

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

The EC2 Instance type used for the streaming session.

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

The ID of the launch profile used to control access from the streaming session.

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

The user ID of the user that owns the streaming session. The user that owns the session will be logging into the session and interacting with the virtual workstation.

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

The session ID.

pub fn state(&self) -> Option<&StreamingSessionState>

The current state.

pub fn status_code(&self) -> Option<&StreamingSessionStatusCode>

The status code.

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

The status message for the streaming session.

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

The ID of the streaming image.

pub fn tags(&self) -> Option<&HashMap<String, String>>

A collection of labels, in the form of key-value pairs, that apply to this resource.

pub fn terminate_at(&self) -> Option<&DateTime>

The time the streaming session will automatically terminate if not terminated by the user.

pub fn updated_at(&self) -> Option<&DateTime>

The ISO timestamp in seconds for when the resource was updated.

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

The user ID of the user that most recently updated the resource.

pub fn stopped_at(&self) -> Option<&DateTime>

The time the session entered STOP_IN_PROGRESS state.

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

The user ID of the user that stopped the streaming session.

pub fn started_at(&self) -> Option<&DateTime>

The time the session entered START_IN_PROGRESS state.

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

The user ID of the user that started the streaming session.

pub fn stop_at(&self) -> Option<&DateTime>

The time the streaming session will automatically be stopped if the user doesn’t stop the session themselves.

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

The backup ID used to restore a streaming session.

pub fn backup_mode(&self) -> Option<&SessionBackupMode>

Shows the current backup setting of the session.

pub fn max_backups_to_retain(&self) -> i32

The maximum number of backups of a streaming session that you can have. When the maximum number of backups is reached, the oldest backup is deleted.

pub fn volume_retention_mode(&self) -> Option<&VolumeRetentionMode>

Determine if an EBS volume created from this streaming session will be backed up.

pub fn session_persistence_mode(&self) -> Option<&SessionPersistenceMode>

Determine if a streaming session created from this launch profile can configure persistent storage. This means that volumeConfiguration and automaticTerminationMode are configured.

pub fn volume_configuration(&self) -> Option<&VolumeConfiguration>

Custom volume configuration for the root volumes that are attached to streaming sessions.

This parameter is only allowed when sessionPersistenceMode is ACTIVATED.

pub fn automatic_termination_mode(&self) -> Option<&AutomaticTerminationMode>

Indicates if a streaming session created from this launch profile should be terminated automatically or retained without termination after being in a STOPPED state.

• When ACTIVATED, the streaming session is scheduled for termination after being in the STOPPED state for the time specified in maxStoppedSessionLengthInMinutes.

• When DEACTIVATED, the streaming session can remain in the STOPPED state indefinitely.

This parameter is only allowed when sessionPersistenceMode is ACTIVATED. When allowed, the default value for this parameter is DEACTIVATED.

impl StreamingSession

pub fn builder() -> StreamingSessionBuilder

Creates a new builder-style object to manufacture StreamingSession.

Trait Implementations

impl Clone for StreamingSession

fn clone(&self) -> StreamingSession

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for StreamingSession

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

Formats the value using the given formatter.

impl PartialEq for StreamingSession

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for StreamingSession