Package 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(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
         .automaticTerminationMode("automaticTerminationMode")
         .maxSessionLengthInMinutes(123)
         .maxStoppedSessionLengthInMinutes(123)
         .sessionBackup(StreamConfigurationSessionBackupProperty.builder()
                 .maxBackupsToRetain(123)
                 .mode("mode")
                 .build())
         .sessionPersistenceMode("sessionPersistenceMode")
         .sessionStorage(StreamConfigurationSessionStorageProperty.builder()
                 .mode(List.of("mode"))
                 // the properties below are optional
                 .root(StreamingSessionStorageRootProperty.builder()
                         .linux("linux")
                         .windows("windows")
                         .build())
                 .build())
         .volumeConfiguration(VolumeConfigurationProperty.builder()
                 .iops(123)
                 .size(123)
                 .throughput(123)
                 .build())
         .build();

  • Method Details

    • getClipboardMode

      @Stability(Stable) @NotNull String getClipboardMode()
      Allows or deactivates the use of the system clipboard to copy and paste between the streaming session and streaming client.

    • getEc2InstanceTypes

      @Stability(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(Stable) @NotNull List<String> getStreamingImageIds()
      The streaming images that users can select from when launching a streaming session with this launch profile.

    • getAutomaticTerminationMode

      @Stability(Stable) @Nullable default String getAutomaticTerminationMode()
      CfnLaunchProfile.StreamConfigurationProperty.AutomaticTerminationMode.

    • getMaxSessionLengthInMinutes

      @Stability(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(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.

      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).

    • getSessionBackup

      @Stability(Stable) @Nullable default Object getSessionBackup()
      CfnLaunchProfile.StreamConfigurationProperty.SessionBackup.

    • getSessionPersistenceMode

      @Stability(Stable) @Nullable default String getSessionPersistenceMode()
      CfnLaunchProfile.StreamConfigurationProperty.SessionPersistenceMode.

    • getSessionStorage

      @Stability(Stable) @Nullable default Object getSessionStorage()
      The upload storage for a streaming session.

    • getVolumeConfiguration

      @Stability(Stable) @Nullable default Object getVolumeConfiguration()
      CfnLaunchProfile.StreamConfigurationProperty.VolumeConfiguration.

    • builder

      @Stability(Stable) static CfnLaunchProfile.StreamConfigurationProperty.Builder builder()
      Returns:
      a CfnLaunchProfile.StreamConfigurationProperty.Builder of CfnLaunchProfile.StreamConfigurationProperty