Class CfnLaunchProfile.StreamConfigurationProperty
A configuration for a streaming session.
Inheritance
Namespace: Amazon.CDK.AWS.NimbleStudio
Assembly: Amazon.CDK.AWS.NimbleStudio.dll
Syntax (csharp)
public class StreamConfigurationProperty : Object, CfnLaunchProfile.IStreamConfigurationProperty
Syntax (vb)
Public Class StreamConfigurationProperty
Inherits Object
Implements CfnLaunchProfile.IStreamConfigurationProperty
Remarks
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.NimbleStudio;
var streamConfigurationProperty = new StreamConfigurationProperty {
ClipboardMode = "clipboardMode",
Ec2InstanceTypes = new [] { "ec2InstanceTypes" },
StreamingImageIds = new [] { "streamingImageIds" },
// the properties below are optional
AutomaticTerminationMode = "automaticTerminationMode",
MaxSessionLengthInMinutes = 123,
MaxStoppedSessionLengthInMinutes = 123,
SessionBackup = new StreamConfigurationSessionBackupProperty {
MaxBackupsToRetain = 123,
Mode = "mode"
},
SessionPersistenceMode = "sessionPersistenceMode",
SessionStorage = new StreamConfigurationSessionStorageProperty {
Mode = new [] { "mode" },
// the properties below are optional
Root = new StreamingSessionStorageRootProperty {
Linux = "linux",
Windows = "windows"
}
},
VolumeConfiguration = new VolumeConfigurationProperty {
Iops = 123,
Size = 123,
Throughput = 123
}
};
Synopsis
Constructors
StreamConfigurationProperty() |
Properties
AutomaticTerminationMode |
|
ClipboardMode | Allows or deactivates the use of the system clipboard to copy and paste between the streaming session and streaming client. |
Ec2InstanceTypes | The EC2 instance types that users can select from when launching a streaming session with this launch profile. |
MaxSessionLengthInMinutes | The length of time, in minutes, that a streaming session can be active before it is stopped or terminated. |
MaxStoppedSessionLengthInMinutes | Integer that determines if you can start and stop your sessions and how long a session can stay in the |
SessionBackup |
|
SessionPersistenceMode |
|
SessionStorage | The upload storage for a streaming session. |
StreamingImageIds | The streaming images that users can select from when launching a streaming session with this launch profile. |
VolumeConfiguration |
|
Constructors
StreamConfigurationProperty()
public StreamConfigurationProperty()
Properties
AutomaticTerminationMode
CfnLaunchProfile.StreamConfigurationProperty.AutomaticTerminationMode
.
public string AutomaticTerminationMode { get; set; }
Property Value
System.String
Remarks
ClipboardMode
Allows or deactivates the use of the system clipboard to copy and paste between the streaming session and streaming client.
public string ClipboardMode { get; set; }
Property Value
System.String
Remarks
Ec2InstanceTypes
The EC2 instance types that users can select from when launching a streaming session with this launch profile.
public string[] Ec2InstanceTypes { get; set; }
Property Value
System.String[]
Remarks
MaxSessionLengthInMinutes
The length of time, in minutes, that a streaming session can be active before it is stopped or terminated.
public Nullable<double> MaxSessionLengthInMinutes { get; set; }
Property Value
System.Nullable<System.Double>
Remarks
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.
MaxStoppedSessionLengthInMinutes
Integer that determines if you can start and stop your sessions and how long a session can stay in the STOPPED
state.
public Nullable<double> MaxStoppedSessionLengthInMinutes { get; set; }
Property Value
System.Nullable<System.Double>
Remarks
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).
SessionBackup
CfnLaunchProfile.StreamConfigurationProperty.SessionBackup
.
public object SessionBackup { get; set; }
Property Value
System.Object
Remarks
SessionPersistenceMode
CfnLaunchProfile.StreamConfigurationProperty.SessionPersistenceMode
.
public string SessionPersistenceMode { get; set; }
Property Value
System.String
Remarks
SessionStorage
The upload storage for a streaming session.
public object SessionStorage { get; set; }
Property Value
System.Object
Remarks
StreamingImageIds
The streaming images that users can select from when launching a streaming session with this launch profile.
public string[] StreamingImageIds { get; set; }
Property Value
System.String[]
Remarks
VolumeConfiguration
CfnLaunchProfile.StreamConfigurationProperty.VolumeConfiguration
.
public object VolumeConfiguration { get; set; }
Property Value
System.Object