@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class StreamConfiguration extends Object implements Serializable, Cloneable, StructuredPojo
A configuration for a streaming session.
| Constructor and Description | 
|---|
| StreamConfiguration() | 
| Modifier and Type | Method and Description | 
|---|---|
| StreamConfiguration | clone() | 
| boolean | equals(Object obj) | 
| String | getAutomaticTerminationMode()
 Indicates if a streaming session created from this launch profile should be terminated automatically or retained
 without termination after being in a  STOPPEDstate. | 
| String | getClipboardMode()
 Allows or deactivates 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. | 
| Integer | getMaxSessionLengthInMinutes()
 The length of time, in minutes, that a streaming session can be active before it is stopped or terminated. | 
| Integer | getMaxStoppedSessionLengthInMinutes()
 Integer that determines if you can start and stop your sessions and how long a session can stay in the
  STOPPEDstate. | 
| StreamConfigurationSessionBackup | getSessionBackup()
 Information about the streaming session backup. | 
| String | getSessionPersistenceMode()
 Determine if a streaming session created from this launch profile can configure persistent storage. | 
| StreamConfigurationSessionStorage | getSessionStorage()
 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. | 
| VolumeConfiguration | getVolumeConfiguration()
 Custom volume configuration for the root volumes that are attached to streaming sessions. | 
| int | hashCode() | 
| void | marshall(ProtocolMarshaller protocolMarshaller)Marshalls this structured data using the given  ProtocolMarshaller. | 
| void | setAutomaticTerminationMode(String automaticTerminationMode)
 Indicates if a streaming session created from this launch profile should be terminated automatically or retained
 without termination after being in a  STOPPEDstate. | 
| void | setClipboardMode(String clipboardMode)
 Allows or deactivates the use of the system clipboard to copy and paste between the streaming session and
 streaming client. | 
| void | setEc2InstanceTypes(Collection<String> ec2InstanceTypes)
 The EC2 instance types that users can select from when launching a streaming session with this launch profile. | 
| void | setMaxSessionLengthInMinutes(Integer maxSessionLengthInMinutes)
 The length of time, in minutes, that a streaming session can be active before it is stopped or terminated. | 
| void | setMaxStoppedSessionLengthInMinutes(Integer maxStoppedSessionLengthInMinutes)
 Integer that determines if you can start and stop your sessions and how long a session can stay in the
  STOPPEDstate. | 
| void | setSessionBackup(StreamConfigurationSessionBackup sessionBackup)
 Information about the streaming session backup. | 
| void | setSessionPersistenceMode(String sessionPersistenceMode)
 Determine if a streaming session created from this launch profile can configure persistent storage. | 
| void | setSessionStorage(StreamConfigurationSessionStorage sessionStorage)
 The upload storage for a streaming session. | 
| void | setStreamingImageIds(Collection<String> streamingImageIds)
 The streaming images that users can select from when launching a streaming session with this launch profile. | 
| void | setVolumeConfiguration(VolumeConfiguration volumeConfiguration)
 Custom volume configuration for the root volumes that are attached to streaming sessions. | 
| String | toString()Returns a string representation of this object. | 
| StreamConfiguration | withAutomaticTerminationMode(AutomaticTerminationMode automaticTerminationMode)
 Indicates if a streaming session created from this launch profile should be terminated automatically or retained
 without termination after being in a  STOPPEDstate. | 
| StreamConfiguration | withAutomaticTerminationMode(String automaticTerminationMode)
 Indicates if a streaming session created from this launch profile should be terminated automatically or retained
 without termination after being in a  STOPPEDstate. | 
| StreamConfiguration | withClipboardMode(StreamingClipboardMode clipboardMode)
 Allows or deactivates the use of the system clipboard to copy and paste between the streaming session and
 streaming client. | 
| StreamConfiguration | withClipboardMode(String clipboardMode)
 Allows or deactivates the use of the system clipboard to copy and paste between the streaming session and
 streaming client. | 
| StreamConfiguration | withEc2InstanceTypes(Collection<String> ec2InstanceTypes)
 The EC2 instance types that users can select from when launching a streaming session with this launch profile. | 
| StreamConfiguration | withEc2InstanceTypes(StreamingInstanceType... ec2InstanceTypes)
 The EC2 instance types that users can select from when launching a streaming session with this launch profile. | 
| StreamConfiguration | withEc2InstanceTypes(String... ec2InstanceTypes)
 The EC2 instance types that users can select from when launching a streaming session with this launch profile. | 
| StreamConfiguration | withMaxSessionLengthInMinutes(Integer maxSessionLengthInMinutes)
 The length of time, in minutes, that a streaming session can be active before it is stopped or terminated. | 
| StreamConfiguration | withMaxStoppedSessionLengthInMinutes(Integer maxStoppedSessionLengthInMinutes)
 Integer that determines if you can start and stop your sessions and how long a session can stay in the
  STOPPEDstate. | 
| StreamConfiguration | withSessionBackup(StreamConfigurationSessionBackup sessionBackup)
 Information about the streaming session backup. | 
| StreamConfiguration | withSessionPersistenceMode(SessionPersistenceMode sessionPersistenceMode)
 Determine if a streaming session created from this launch profile can configure persistent storage. | 
| StreamConfiguration | withSessionPersistenceMode(String sessionPersistenceMode)
 Determine if a streaming session created from this launch profile can configure persistent storage. | 
| StreamConfiguration | withSessionStorage(StreamConfigurationSessionStorage sessionStorage)
 The upload storage for a streaming session. | 
| StreamConfiguration | withStreamingImageIds(Collection<String> streamingImageIds)
 The streaming images that users can select from when launching a streaming session with this launch profile. | 
| StreamConfiguration | withStreamingImageIds(String... streamingImageIds)
 The streaming images that users can select from when launching a streaming session with this launch profile. | 
| StreamConfiguration | withVolumeConfiguration(VolumeConfiguration volumeConfiguration)
 Custom volume configuration for the root volumes that are attached to streaming sessions. | 
public void setAutomaticTerminationMode(String 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 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.
 
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 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.
AutomaticTerminationModepublic 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.
 
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.
AutomaticTerminationModepublic StreamConfiguration withAutomaticTerminationMode(String 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 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.
 
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 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.
AutomaticTerminationModepublic StreamConfiguration withAutomaticTerminationMode(AutomaticTerminationMode 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 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.
 
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 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.
AutomaticTerminationModepublic void setClipboardMode(String clipboardMode)
Allows or deactivates the use of the system clipboard to copy and paste between the streaming session and streaming client.
clipboardMode - Allows or deactivates the use of the system clipboard to copy and paste between the streaming session and
        streaming client.StreamingClipboardModepublic String getClipboardMode()
Allows or deactivates the use of the system clipboard to copy and paste between the streaming session and streaming client.
StreamingClipboardModepublic StreamConfiguration withClipboardMode(String clipboardMode)
Allows or deactivates the use of the system clipboard to copy and paste between the streaming session and streaming client.
clipboardMode - Allows or deactivates the use of the system clipboard to copy and paste between the streaming session and
        streaming client.StreamingClipboardModepublic StreamConfiguration withClipboardMode(StreamingClipboardMode clipboardMode)
Allows or deactivates the use of the system clipboard to copy and paste between the streaming session and streaming client.
clipboardMode - Allows or deactivates the use of the system clipboard to copy and paste between the streaming session and
        streaming client.StreamingClipboardModepublic List<String> getEc2InstanceTypes()
The EC2 instance types that users can select from when launching a streaming session with this launch profile.
StreamingInstanceTypepublic void setEc2InstanceTypes(Collection<String> ec2InstanceTypes)
The EC2 instance types that users can select from when launching a streaming session with this launch profile.
ec2InstanceTypes - The EC2 instance types that users can select from when launching a streaming session with this launch
        profile.StreamingInstanceTypepublic StreamConfiguration withEc2InstanceTypes(String... ec2InstanceTypes)
The EC2 instance types that users can select from when launching a streaming session with this launch profile.
 NOTE: This method appends the values to the existing list (if any). Use
 setEc2InstanceTypes(java.util.Collection) or withEc2InstanceTypes(java.util.Collection) if you
 want to override the existing values.
 
ec2InstanceTypes - The EC2 instance types that users can select from when launching a streaming session with this launch
        profile.StreamingInstanceTypepublic StreamConfiguration withEc2InstanceTypes(Collection<String> ec2InstanceTypes)
The EC2 instance types that users can select from when launching a streaming session with this launch profile.
ec2InstanceTypes - The EC2 instance types that users can select from when launching a streaming session with this launch
        profile.StreamingInstanceTypepublic StreamConfiguration withEc2InstanceTypes(StreamingInstanceType... ec2InstanceTypes)
The EC2 instance types that users can select from when launching a streaming session with this launch profile.
ec2InstanceTypes - The EC2 instance types that users can select from when launching a streaming session with this launch
        profile.StreamingInstanceTypepublic void setMaxSessionLengthInMinutes(Integer 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.
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.public Integer 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.
public StreamConfiguration withMaxSessionLengthInMinutes(Integer 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.
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.public void setMaxStoppedSessionLengthInMinutes(Integer 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).
 
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).
public Integer 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).
 
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).
public StreamConfiguration withMaxStoppedSessionLengthInMinutes(Integer 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).
 
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).
public void setSessionBackup(StreamConfigurationSessionBackup sessionBackup)
Information about the streaming session backup.
sessionBackup - Information about the streaming session backup.public StreamConfigurationSessionBackup getSessionBackup()
Information about the streaming session backup.
public StreamConfiguration withSessionBackup(StreamConfigurationSessionBackup sessionBackup)
Information about the streaming session backup.
sessionBackup - Information about the streaming session backup.public void setSessionPersistenceMode(String sessionPersistenceMode)
 Determine if a streaming session created from this launch profile can configure persistent storage. This means
 that volumeConfiguration and automaticTerminationMode are configured.
 
sessionPersistenceMode - Determine if a streaming session created from this launch profile can configure persistent storage. This
        means that volumeConfiguration and automaticTerminationMode are configured.SessionPersistenceModepublic String getSessionPersistenceMode()
 Determine if a streaming session created from this launch profile can configure persistent storage. This means
 that volumeConfiguration and automaticTerminationMode are configured.
 
volumeConfiguration and automaticTerminationMode are configured.SessionPersistenceModepublic StreamConfiguration withSessionPersistenceMode(String sessionPersistenceMode)
 Determine if a streaming session created from this launch profile can configure persistent storage. This means
 that volumeConfiguration and automaticTerminationMode are configured.
 
sessionPersistenceMode - Determine if a streaming session created from this launch profile can configure persistent storage. This
        means that volumeConfiguration and automaticTerminationMode are configured.SessionPersistenceModepublic StreamConfiguration withSessionPersistenceMode(SessionPersistenceMode sessionPersistenceMode)
 Determine if a streaming session created from this launch profile can configure persistent storage. This means
 that volumeConfiguration and automaticTerminationMode are configured.
 
sessionPersistenceMode - Determine if a streaming session created from this launch profile can configure persistent storage. This
        means that volumeConfiguration and automaticTerminationMode are configured.SessionPersistenceModepublic void setSessionStorage(StreamConfigurationSessionStorage sessionStorage)
The upload storage for a streaming session.
sessionStorage - The upload storage for a streaming session.public StreamConfigurationSessionStorage getSessionStorage()
The upload storage for a streaming session.
public StreamConfiguration withSessionStorage(StreamConfigurationSessionStorage sessionStorage)
The upload storage for a streaming session.
sessionStorage - The upload storage for a streaming session.public List<String> getStreamingImageIds()
The streaming images that users can select from when launching a streaming session with this launch profile.
public void setStreamingImageIds(Collection<String> streamingImageIds)
The streaming images that users can select from when launching a streaming session with this launch profile.
streamingImageIds - The streaming images that users can select from when launching a streaming session with this launch
        profile.public StreamConfiguration withStreamingImageIds(String... streamingImageIds)
The streaming images that users can select from when launching a streaming session with this launch profile.
 NOTE: This method appends the values to the existing list (if any). Use
 setStreamingImageIds(java.util.Collection) or withStreamingImageIds(java.util.Collection) if
 you want to override the existing values.
 
streamingImageIds - The streaming images that users can select from when launching a streaming session with this launch
        profile.public StreamConfiguration withStreamingImageIds(Collection<String> streamingImageIds)
The streaming images that users can select from when launching a streaming session with this launch profile.
streamingImageIds - The streaming images that users can select from when launching a streaming session with this launch
        profile.public void setVolumeConfiguration(VolumeConfiguration volumeConfiguration)
Custom volume configuration for the root volumes that are attached to streaming sessions.
 This parameter is only allowed when sessionPersistenceMode is ACTIVATED.
 
volumeConfiguration - Custom volume configuration for the root volumes that are attached to streaming sessions.
        
        This parameter is only allowed when sessionPersistenceMode is ACTIVATED.
public VolumeConfiguration getVolumeConfiguration()
Custom volume configuration for the root volumes that are attached to streaming sessions.
 This parameter is only allowed when sessionPersistenceMode is ACTIVATED.
 
         This parameter is only allowed when sessionPersistenceMode is ACTIVATED.
public StreamConfiguration withVolumeConfiguration(VolumeConfiguration volumeConfiguration)
Custom volume configuration for the root volumes that are attached to streaming sessions.
 This parameter is only allowed when sessionPersistenceMode is ACTIVATED.
 
volumeConfiguration - Custom volume configuration for the root volumes that are attached to streaming sessions.
        
        This parameter is only allowed when sessionPersistenceMode is ACTIVATED.
public String toString()
toString in class ObjectObject.toString()public StreamConfiguration clone()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojoProtocolMarshaller.marshall in interface StructuredPojoprotocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.