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 StreamConfigurationCreate = StreamConfigurationCreate' {
- automaticTerminationMode :: Maybe AutomaticTerminationMode
- maxSessionLengthInMinutes :: Maybe Natural
- maxStoppedSessionLengthInMinutes :: Maybe Natural
- sessionBackup :: Maybe StreamConfigurationSessionBackup
- sessionPersistenceMode :: Maybe SessionPersistenceMode
- sessionStorage :: Maybe StreamConfigurationSessionStorage
- volumeConfiguration :: Maybe VolumeConfiguration
- clipboardMode :: StreamingClipboardMode
- ec2InstanceTypes :: NonEmpty StreamingInstanceType
- streamingImageIds :: NonEmpty Text
- newStreamConfigurationCreate :: StreamingClipboardMode -> NonEmpty StreamingInstanceType -> NonEmpty Text -> StreamConfigurationCreate
- streamConfigurationCreate_automaticTerminationMode :: Lens' StreamConfigurationCreate (Maybe AutomaticTerminationMode)
- streamConfigurationCreate_maxSessionLengthInMinutes :: Lens' StreamConfigurationCreate (Maybe Natural)
- streamConfigurationCreate_maxStoppedSessionLengthInMinutes :: Lens' StreamConfigurationCreate (Maybe Natural)
- streamConfigurationCreate_sessionBackup :: Lens' StreamConfigurationCreate (Maybe StreamConfigurationSessionBackup)
- streamConfigurationCreate_sessionPersistenceMode :: Lens' StreamConfigurationCreate (Maybe SessionPersistenceMode)
- streamConfigurationCreate_sessionStorage :: Lens' StreamConfigurationCreate (Maybe StreamConfigurationSessionStorage)
- streamConfigurationCreate_volumeConfiguration :: Lens' StreamConfigurationCreate (Maybe VolumeConfiguration)
- streamConfigurationCreate_clipboardMode :: Lens' StreamConfigurationCreate StreamingClipboardMode
- streamConfigurationCreate_ec2InstanceTypes :: Lens' StreamConfigurationCreate (NonEmpty StreamingInstanceType)
- streamConfigurationCreate_streamingImageIds :: Lens' StreamConfigurationCreate (NonEmpty Text)
Documentation
data StreamConfigurationCreate Source #
Configuration for streaming workstations created using this launch profile.
See: newStreamConfigurationCreate
smart constructor.
StreamConfigurationCreate' | |
|
Instances
newStreamConfigurationCreate Source #
:: StreamingClipboardMode | |
-> NonEmpty StreamingInstanceType | |
-> NonEmpty Text | |
-> StreamConfigurationCreate |
Create a value of StreamConfigurationCreate
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:automaticTerminationMode:StreamConfigurationCreate'
, streamConfigurationCreate_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:maxSessionLengthInMinutes:StreamConfigurationCreate'
, streamConfigurationCreate_maxSessionLengthInMinutes
- The length of time, in minutes, that a streaming session can be active
before it is stopped or terminated. After this point, Nimble Studio
automatically terminates or stops the session. The default length of
time is 690 minutes, and the maximum length of time is 30 days.
$sel:maxStoppedSessionLengthInMinutes:StreamConfigurationCreate'
, streamConfigurationCreate_maxStoppedSessionLengthInMinutes
- Integer that determines if you can start and stop your sessions and how
long a session can stay in the STOPPED
state. The default value is 0.
The maximum value is 5760.
This field is allowed only when sessionPersistenceMode
is ACTIVATED
and automaticTerminationMode
is ACTIVATED
.
If the value is set to 0, your sessions can’t be STOPPED
. If you then
call StopStreamingSession
, the session fails. If the time that a
session stays in the READY
state exceeds the
maxSessionLengthInMinutes
value, the session will automatically be
terminated (instead of STOPPED
).
If the value is set to a positive number, the session can be stopped.
You can call StopStreamingSession
to stop sessions in the READY
state. If the time that a session stays in the READY
state exceeds the
maxSessionLengthInMinutes
value, the session will automatically be
stopped (instead of terminated).
$sel:sessionBackup:StreamConfigurationCreate'
, streamConfigurationCreate_sessionBackup
- Configures how streaming sessions are backed up when launched from this
launch profile.
$sel:sessionPersistenceMode:StreamConfigurationCreate'
, streamConfigurationCreate_sessionPersistenceMode
- Determine if a streaming session created from this launch profile can
configure persistent storage. This means that volumeConfiguration
and
automaticTerminationMode
are configured.
$sel:sessionStorage:StreamConfigurationCreate'
, streamConfigurationCreate_sessionStorage
- The upload storage for a streaming workstation that is created using
this launch profile.
$sel:volumeConfiguration:StreamConfigurationCreate'
, streamConfigurationCreate_volumeConfiguration
- Custom volume configuration for the root volumes that are attached to
streaming sessions.
This parameter is only allowed when sessionPersistenceMode
is
ACTIVATED
.
$sel:clipboardMode:StreamConfigurationCreate'
, streamConfigurationCreate_clipboardMode
- Allows or deactivates the use of the system clipboard to copy and paste
between the streaming session and streaming client.
$sel:ec2InstanceTypes:StreamConfigurationCreate'
, streamConfigurationCreate_ec2InstanceTypes
- The EC2 instance types that users can select from when launching a
streaming session with this launch profile.
$sel:streamingImageIds:StreamConfigurationCreate'
, streamConfigurationCreate_streamingImageIds
- The streaming images that users can select from when launching a
streaming session with this launch profile.
streamConfigurationCreate_automaticTerminationMode :: Lens' StreamConfigurationCreate (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
.
streamConfigurationCreate_maxSessionLengthInMinutes :: Lens' StreamConfigurationCreate (Maybe Natural) Source #
The length of time, in minutes, that a streaming session can be active before it is stopped or terminated. After this point, Nimble Studio automatically terminates or stops the session. The default length of time is 690 minutes, and the maximum length of time is 30 days.
streamConfigurationCreate_maxStoppedSessionLengthInMinutes :: Lens' StreamConfigurationCreate (Maybe Natural) Source #
Integer that determines if you can start and stop your sessions and how
long a session can stay in the STOPPED
state. The default value is 0.
The maximum value is 5760.
This field is allowed only when sessionPersistenceMode
is ACTIVATED
and automaticTerminationMode
is ACTIVATED
.
If the value is set to 0, your sessions can’t be STOPPED
. If you then
call StopStreamingSession
, the session fails. If the time that a
session stays in the READY
state exceeds the
maxSessionLengthInMinutes
value, the session will automatically be
terminated (instead of STOPPED
).
If the value is set to a positive number, the session can be stopped.
You can call StopStreamingSession
to stop sessions in the READY
state. If the time that a session stays in the READY
state exceeds the
maxSessionLengthInMinutes
value, the session will automatically be
stopped (instead of terminated).
streamConfigurationCreate_sessionBackup :: Lens' StreamConfigurationCreate (Maybe StreamConfigurationSessionBackup) Source #
Configures how streaming sessions are backed up when launched from this launch profile.
streamConfigurationCreate_sessionPersistenceMode :: Lens' StreamConfigurationCreate (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.
streamConfigurationCreate_sessionStorage :: Lens' StreamConfigurationCreate (Maybe StreamConfigurationSessionStorage) Source #
The upload storage for a streaming workstation that is created using this launch profile.
streamConfigurationCreate_volumeConfiguration :: Lens' StreamConfigurationCreate (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
.
streamConfigurationCreate_clipboardMode :: Lens' StreamConfigurationCreate StreamingClipboardMode Source #
Allows or deactivates the use of the system clipboard to copy and paste between the streaming session and streaming client.
streamConfigurationCreate_ec2InstanceTypes :: Lens' StreamConfigurationCreate (NonEmpty StreamingInstanceType) Source #
The EC2 instance types that users can select from when launching a streaming session with this launch profile.
streamConfigurationCreate_streamingImageIds :: Lens' StreamConfigurationCreate (NonEmpty Text) Source #
The streaming images that users can select from when launching a streaming session with this launch profile.