Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
Synopsis
- data StreamingSession = StreamingSession' {
- arn :: Maybe Text
- automaticTerminationMode :: Maybe AutomaticTerminationMode
- backupMode :: Maybe SessionBackupMode
- createdAt :: Maybe ISO8601
- createdBy :: Maybe Text
- ec2InstanceType :: Maybe Text
- launchProfileId :: Maybe Text
- maxBackupsToRetain :: Maybe Natural
- ownedBy :: Maybe Text
- sessionId :: Maybe Text
- sessionPersistenceMode :: Maybe SessionPersistenceMode
- startedAt :: Maybe ISO8601
- startedBy :: Maybe Text
- startedFromBackupId :: Maybe Text
- state :: Maybe StreamingSessionState
- statusCode :: Maybe StreamingSessionStatusCode
- statusMessage :: Maybe Text
- stopAt :: Maybe ISO8601
- stoppedAt :: Maybe ISO8601
- stoppedBy :: Maybe Text
- streamingImageId :: Maybe Text
- tags :: Maybe (HashMap Text Text)
- terminateAt :: Maybe ISO8601
- updatedAt :: Maybe ISO8601
- updatedBy :: Maybe Text
- volumeConfiguration :: Maybe VolumeConfiguration
- volumeRetentionMode :: Maybe VolumeRetentionMode
- newStreamingSession :: StreamingSession
- streamingSession_arn :: Lens' StreamingSession (Maybe Text)
- streamingSession_automaticTerminationMode :: Lens' StreamingSession (Maybe AutomaticTerminationMode)
- streamingSession_backupMode :: Lens' StreamingSession (Maybe SessionBackupMode)
- streamingSession_createdAt :: Lens' StreamingSession (Maybe UTCTime)
- streamingSession_createdBy :: Lens' StreamingSession (Maybe Text)
- streamingSession_ec2InstanceType :: Lens' StreamingSession (Maybe Text)
- streamingSession_launchProfileId :: Lens' StreamingSession (Maybe Text)
- streamingSession_maxBackupsToRetain :: Lens' StreamingSession (Maybe Natural)
- streamingSession_ownedBy :: Lens' StreamingSession (Maybe Text)
- streamingSession_sessionId :: Lens' StreamingSession (Maybe Text)
- streamingSession_sessionPersistenceMode :: Lens' StreamingSession (Maybe SessionPersistenceMode)
- streamingSession_startedAt :: Lens' StreamingSession (Maybe UTCTime)
- streamingSession_startedBy :: Lens' StreamingSession (Maybe Text)
- streamingSession_startedFromBackupId :: Lens' StreamingSession (Maybe Text)
- streamingSession_state :: Lens' StreamingSession (Maybe StreamingSessionState)
- streamingSession_statusCode :: Lens' StreamingSession (Maybe StreamingSessionStatusCode)
- streamingSession_statusMessage :: Lens' StreamingSession (Maybe Text)
- streamingSession_stopAt :: Lens' StreamingSession (Maybe UTCTime)
- streamingSession_stoppedAt :: Lens' StreamingSession (Maybe UTCTime)
- streamingSession_stoppedBy :: Lens' StreamingSession (Maybe Text)
- streamingSession_streamingImageId :: Lens' StreamingSession (Maybe Text)
- streamingSession_tags :: Lens' StreamingSession (Maybe (HashMap Text Text))
- streamingSession_terminateAt :: Lens' StreamingSession (Maybe UTCTime)
- streamingSession_updatedAt :: Lens' StreamingSession (Maybe UTCTime)
- streamingSession_updatedBy :: Lens' StreamingSession (Maybe Text)
- streamingSession_volumeConfiguration :: Lens' StreamingSession (Maybe VolumeConfiguration)
- streamingSession_volumeRetentionMode :: Lens' StreamingSession (Maybe VolumeRetentionMode)
Documentation
data StreamingSession Source #
A streaming session is a virtual workstation created using a particular launch profile.
See: newStreamingSession
smart constructor.
StreamingSession' | |
|
Instances
newStreamingSession :: StreamingSession Source #
Create a value of StreamingSession
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:arn:StreamingSession'
, streamingSession_arn
- The Amazon Resource Name (ARN) that is assigned to a studio resource and
uniquely identifies it. ARNs are unique across all Regions.
$sel:automaticTerminationMode:StreamingSession'
, streamingSession_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 theSTOPPED
state for the time specified inmaxStoppedSessionLengthInMinutes
. - When
DEACTIVATED
, the streaming session can remain in theSTOPPED
state indefinitely.
This parameter is only allowed when sessionPersistenceMode
is
ACTIVATED
. When allowed, the default value for this parameter is
DEACTIVATED
.
$sel:backupMode:StreamingSession'
, streamingSession_backupMode
- Shows the current backup setting of the session.
$sel:createdAt:StreamingSession'
, streamingSession_createdAt
- The ISO timestamp in seconds for when the resource was created.
$sel:createdBy:StreamingSession'
, streamingSession_createdBy
- The user ID of the user that created the streaming session.
$sel:ec2InstanceType:StreamingSession'
, streamingSession_ec2InstanceType
- The EC2 Instance type used for the streaming session.
$sel:launchProfileId:StreamingSession'
, streamingSession_launchProfileId
- The ID of the launch profile used to control access from the streaming
session.
$sel:maxBackupsToRetain:StreamingSession'
, streamingSession_maxBackupsToRetain
- 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.
$sel:ownedBy:StreamingSession'
, streamingSession_ownedBy
- 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.
$sel:sessionId:StreamingSession'
, streamingSession_sessionId
- The session ID.
$sel:sessionPersistenceMode:StreamingSession'
, streamingSession_sessionPersistenceMode
- Determine if a streaming session created from this launch profile can
configure persistent storage. This means that volumeConfiguration
and
automaticTerminationMode
are configured.
$sel:startedAt:StreamingSession'
, streamingSession_startedAt
- The time the session entered START_IN_PROGRESS
state.
$sel:startedBy:StreamingSession'
, streamingSession_startedBy
- The user ID of the user that started the streaming session.
$sel:startedFromBackupId:StreamingSession'
, streamingSession_startedFromBackupId
- The backup ID used to restore a streaming session.
$sel:state:StreamingSession'
, streamingSession_state
- The current state.
$sel:statusCode:StreamingSession'
, streamingSession_statusCode
- The status code.
$sel:statusMessage:StreamingSession'
, streamingSession_statusMessage
- The status message for the streaming session.
$sel:stopAt:StreamingSession'
, streamingSession_stopAt
- The time the streaming session will automatically be stopped if the user
doesn’t stop the session themselves.
$sel:stoppedAt:StreamingSession'
, streamingSession_stoppedAt
- The time the session entered STOP_IN_PROGRESS
state.
$sel:stoppedBy:StreamingSession'
, streamingSession_stoppedBy
- The user ID of the user that stopped the streaming session.
$sel:streamingImageId:StreamingSession'
, streamingSession_streamingImageId
- The ID of the streaming image.
$sel:tags:StreamingSession'
, streamingSession_tags
- A collection of labels, in the form of key-value pairs, that apply to
this resource.
$sel:terminateAt:StreamingSession'
, streamingSession_terminateAt
- The time the streaming session will automatically terminate if not
terminated by the user.
$sel:updatedAt:StreamingSession'
, streamingSession_updatedAt
- The ISO timestamp in seconds for when the resource was updated.
$sel:updatedBy:StreamingSession'
, streamingSession_updatedBy
- The user ID of the user that most recently updated the resource.
$sel:volumeConfiguration:StreamingSession'
, streamingSession_volumeConfiguration
- Custom volume configuration for the root volumes that are attached to
streaming sessions.
This parameter is only allowed when sessionPersistenceMode
is
ACTIVATED
.
$sel:volumeRetentionMode:StreamingSession'
, streamingSession_volumeRetentionMode
- Determine if an EBS volume created from this streaming session will be
backed up.
streamingSession_arn :: Lens' StreamingSession (Maybe Text) Source #
The Amazon Resource Name (ARN) that is assigned to a studio resource and uniquely identifies it. ARNs are unique across all Regions.
streamingSession_automaticTerminationMode :: Lens' StreamingSession (Maybe AutomaticTerminationMode) Source #
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 theSTOPPED
state for the time specified inmaxStoppedSessionLengthInMinutes
. - When
DEACTIVATED
, the streaming session can remain in theSTOPPED
state indefinitely.
This parameter is only allowed when sessionPersistenceMode
is
ACTIVATED
. When allowed, the default value for this parameter is
DEACTIVATED
.
streamingSession_backupMode :: Lens' StreamingSession (Maybe SessionBackupMode) Source #
Shows the current backup setting of the session.
streamingSession_createdAt :: Lens' StreamingSession (Maybe UTCTime) Source #
The ISO timestamp in seconds for when the resource was created.
streamingSession_createdBy :: Lens' StreamingSession (Maybe Text) Source #
The user ID of the user that created the streaming session.
streamingSession_ec2InstanceType :: Lens' StreamingSession (Maybe Text) Source #
The EC2 Instance type used for the streaming session.
streamingSession_launchProfileId :: Lens' StreamingSession (Maybe Text) Source #
The ID of the launch profile used to control access from the streaming session.
streamingSession_maxBackupsToRetain :: Lens' StreamingSession (Maybe Natural) Source #
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.
streamingSession_ownedBy :: Lens' StreamingSession (Maybe Text) Source #
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.
streamingSession_sessionId :: Lens' StreamingSession (Maybe Text) Source #
The session ID.
streamingSession_sessionPersistenceMode :: Lens' StreamingSession (Maybe SessionPersistenceMode) Source #
Determine if a streaming session created from this launch profile can
configure persistent storage. This means that volumeConfiguration
and
automaticTerminationMode
are configured.
streamingSession_startedAt :: Lens' StreamingSession (Maybe UTCTime) Source #
The time the session entered START_IN_PROGRESS
state.
streamingSession_startedBy :: Lens' StreamingSession (Maybe Text) Source #
The user ID of the user that started the streaming session.
streamingSession_startedFromBackupId :: Lens' StreamingSession (Maybe Text) Source #
The backup ID used to restore a streaming session.
streamingSession_state :: Lens' StreamingSession (Maybe StreamingSessionState) Source #
The current state.
streamingSession_statusCode :: Lens' StreamingSession (Maybe StreamingSessionStatusCode) Source #
The status code.
streamingSession_statusMessage :: Lens' StreamingSession (Maybe Text) Source #
The status message for the streaming session.
streamingSession_stopAt :: Lens' StreamingSession (Maybe UTCTime) Source #
The time the streaming session will automatically be stopped if the user doesn’t stop the session themselves.
streamingSession_stoppedAt :: Lens' StreamingSession (Maybe UTCTime) Source #
The time the session entered STOP_IN_PROGRESS
state.
streamingSession_stoppedBy :: Lens' StreamingSession (Maybe Text) Source #
The user ID of the user that stopped the streaming session.
streamingSession_streamingImageId :: Lens' StreamingSession (Maybe Text) Source #
The ID of the streaming image.
streamingSession_tags :: Lens' StreamingSession (Maybe (HashMap Text Text)) Source #
A collection of labels, in the form of key-value pairs, that apply to this resource.
streamingSession_terminateAt :: Lens' StreamingSession (Maybe UTCTime) Source #
The time the streaming session will automatically terminate if not terminated by the user.
streamingSession_updatedAt :: Lens' StreamingSession (Maybe UTCTime) Source #
The ISO timestamp in seconds for when the resource was updated.
streamingSession_updatedBy :: Lens' StreamingSession (Maybe Text) Source #
The user ID of the user that most recently updated the resource.
streamingSession_volumeConfiguration :: Lens' StreamingSession (Maybe VolumeConfiguration) Source #
Custom volume configuration for the root volumes that are attached to streaming sessions.
This parameter is only allowed when sessionPersistenceMode
is
ACTIVATED
.
streamingSession_volumeRetentionMode :: Lens' StreamingSession (Maybe VolumeRetentionMode) Source #
Determine if an EBS volume created from this streaming session will be backed up.