software.amazon.awscdk.services.nimblestudio

Interface CfnLaunchProfile.StreamConfigurationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnLaunchProfile.StreamConfigurationProperty.Jsii$Proxy

Enclosing class:

CfnLaunchProfile

@Stability(value=Stable)
public static interface CfnLaunchProfile.StreamConfigurationProperty
extends software.amazon.jsii.JsiiSerializable

A configuration for a streaming session.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.nimblestudio.*;
 StreamConfigurationProperty streamConfigurationProperty = StreamConfigurationProperty.builder()
         .clipboardMode("clipboardMode")
         .ec2InstanceTypes(List.of("ec2InstanceTypes"))
         .streamingImageIds(List.of("streamingImageIds"))
         // the properties below are optional
         .maxSessionLengthInMinutes(123)
         .maxStoppedSessionLengthInMinutes(123)
         .sessionStorage(StreamConfigurationSessionStorageProperty.builder()
                 .mode(List.of("mode"))
                 // the properties below are optional
                 .root(StreamingSessionStorageRootProperty.builder()
                         .linux("linux")
                         .windows("windows")
                         .build())
                 .build())
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CfnLaunchProfile.StreamConfigurationProperty.Builder A builder for CfnLaunchProfile.StreamConfigurationProperty
static class	CfnLaunchProfile.StreamConfigurationProperty.Jsii$Proxy An implementation for CfnLaunchProfile.StreamConfigurationProperty

Method Summary

Modifier and Type	Method and Description
static CfnLaunchProfile.StreamConfigurationProperty.Builder	builder()
String	getClipboardMode() Enable or disable the use of the system clipboard to copy and paste between the streaming session and streaming client.
List<String>	getEc2InstanceTypes() The EC2 instance types that users can select from when launching a streaming session with this launch profile.
default Number	getMaxSessionLengthInMinutes() The length of time, in minutes, that a streaming session can be active before it is stopped or terminated.
default Number	getMaxStoppedSessionLengthInMinutes() Integer that determines if you can start and stop your sessions and how long a session can stay in the STOPPED state.
default Object	getSessionStorage() (Optional) The upload storage for a streaming session.
List<String>	getStreamingImageIds() The streaming images that users can select from when launching a streaming session with this launch profile.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getClipboardMode

@Stability(value=Stable)
 @NotNull
String getClipboardMode()

Enable or disable the use of the system clipboard to copy and paste between the streaming session and streaming client.

getEc2InstanceTypes

@Stability(value=Stable)
 @NotNull
List<String> getEc2InstanceTypes()

The EC2 instance types that users can select from when launching a streaming session with this launch profile.

getStreamingImageIds

@Stability(value=Stable)
 @NotNull
List<String> getStreamingImageIds()

The streaming images that users can select from when launching a streaming session with this launch profile.

getMaxSessionLengthInMinutes

@Stability(value=Stable)
 @Nullable
default Number getMaxSessionLengthInMinutes()

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.

getMaxStoppedSessionLengthInMinutes

@Stability(value=Stable)
 @Nullable
default Number getMaxStoppedSessionLengthInMinutes()

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.

If the value is missing or 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).

getSessionStorage

@Stability(value=Stable)
 @Nullable
default Object getSessionStorage()

(Optional) The upload storage for a streaming session.

builder

@Stability(value=Stable)
static CfnLaunchProfile.StreamConfigurationProperty.Builder builder()

Returns:

a CfnLaunchProfile.StreamConfigurationProperty.Builder of CfnLaunchProfile.StreamConfigurationProperty