CfnLaunchProfile.StreamConfigurationProperty

All Known Implementing Classes:: CfnLaunchProfile.StreamConfigurationProperty.Jsii$Proxy

Enclosing class:: CfnLaunchProfile

public static interface CfnLaunchProfile.StreamConfigurationProperty

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

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

All Methods Static Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`static CfnLaunchProfile.StreamConfigurationProperty.Builder`	`builder()`
`default java.lang.String`	`getAutomaticTerminationMode()` Indicates if a streaming session created from this launch profile should be terminated automatically or retained without termination after being in a `STOPPED` state.
`java.lang.String`	`getClipboardMode()` Allows or deactivates the use of the system clipboard to copy and paste between the streaming session and streaming client.
`java.util.List<java.lang.String>`	`getEc2InstanceTypes()` The EC2 instance types that users can select from when launching a streaming session with this launch profile.
`default java.lang.Number`	`getMaxSessionLengthInMinutes()` The length of time, in minutes, that a streaming session can be active before it is stopped or terminated.
`default java.lang.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 java.lang.String`	`getSessionPersistenceMode()` Determine if a streaming session created from this launch profile can configure persistent storage.
`default java.lang.Object`	`getSessionStorage()` The upload storage for a streaming session.
`java.util.List<java.lang.String>`	`getStreamingImageIds()` The streaming images that users can select from when launching a streaming session with this launch profile.
`default java.lang.Object`	`getVolumeConfiguration()` Custom volume configuration for the root volumes that are attached to streaming sessions.

- Method Detail
  - getClipboardMode
```
java.lang.String getClipboardMode()
```
    Allows or deactivates the use of the system clipboard to copy and paste between the streaming session and streaming client.
  - getEc2InstanceTypes
```
java.util.List<java.lang.String> getEc2InstanceTypes()
```
    The EC2 instance types that users can select from when launching a streaming session with this launch profile.
  - getStreamingImageIds
```
java.util.List<java.lang.String> getStreamingImageIds()
```
    The streaming images that users can select from when launching a streaming session with this launch profile.
  - getAutomaticTerminationMode
```
default java.lang.String getAutomaticTerminationMode()
```
    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 the STOPPED state for the time specified in maxStoppedSessionLengthInMinutes .
    - When DEACTIVATED , the streaming session can remain in the STOPPED state indefinitely.
    This parameter is only allowed when sessionPersistenceMode is ACTIVATED . When allowed, the default value for this parameter is DEACTIVATED .
  - getMaxSessionLengthInMinutes
```
default java.lang.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
```
default java.lang.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).
  - getSessionPersistenceMode
```
default java.lang.String getSessionPersistenceMode()
```
    Determine if a streaming session created from this launch profile can configure persistent storage.
    This means that volumeConfiguration and automaticTerminationMode are configured.
  - getSessionStorage
```
default java.lang.Object getSessionStorage()
```
    The upload storage for a streaming session.
  - getVolumeConfiguration
```
default java.lang.Object getVolumeConfiguration()
```
    Custom volume configuration for the root volumes that are attached to streaming sessions.
    This parameter is only allowed when sessionPersistenceMode is ACTIVATED .
  - builder
```
static CfnLaunchProfile.StreamConfigurationProperty.Builder builder()
```
    Returns:
    
    a CfnLaunchProfile.StreamConfigurationProperty.Builder of CfnLaunchProfile.StreamConfigurationProperty

Interface CfnLaunchProfile.StreamConfigurationProperty

Nested Class Summary

Method Summary

Method Detail

getClipboardMode

getEc2InstanceTypes

getStreamingImageIds

getAutomaticTerminationMode

getMaxSessionLengthInMinutes

getMaxStoppedSessionLengthInMinutes

getSessionPersistenceMode

getSessionStorage

getVolumeConfiguration

builder