@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class StreamConfigurationCreate extends Object implements Serializable, Cloneable, StructuredPojo
Configuration for streaming workstations created using this launch profile.
Constructor and Description |
---|
StreamConfigurationCreate() |
Modifier and Type | Method and Description |
---|---|
StreamConfigurationCreate |
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
STOPPED state. |
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
STOPPED state. |
StreamConfigurationSessionBackup |
getSessionBackup()
Configures how streaming sessions are backed up when launched from this launch profile.
|
String |
getSessionPersistenceMode()
Determine if a streaming session created from this launch profile can configure persistent storage.
|
StreamConfigurationSessionStorage |
getSessionStorage()
The upload storage for a streaming workstation that is created using this launch profile.
|
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
STOPPED state. |
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
STOPPED state. |
void |
setSessionBackup(StreamConfigurationSessionBackup sessionBackup)
Configures how streaming sessions are backed up when launched from this launch profile.
|
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 workstation that is created using this launch profile.
|
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.
|
StreamConfigurationCreate |
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. |
StreamConfigurationCreate |
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. |
StreamConfigurationCreate |
withClipboardMode(StreamingClipboardMode clipboardMode)
Allows or deactivates the use of the system clipboard to copy and paste between the streaming session and
streaming client.
|
StreamConfigurationCreate |
withClipboardMode(String clipboardMode)
Allows or deactivates the use of the system clipboard to copy and paste between the streaming session and
streaming client.
|
StreamConfigurationCreate |
withEc2InstanceTypes(Collection<String> ec2InstanceTypes)
The EC2 instance types that users can select from when launching a streaming session with this launch profile.
|
StreamConfigurationCreate |
withEc2InstanceTypes(StreamingInstanceType... ec2InstanceTypes)
The EC2 instance types that users can select from when launching a streaming session with this launch profile.
|
StreamConfigurationCreate |
withEc2InstanceTypes(String... ec2InstanceTypes)
The EC2 instance types that users can select from when launching a streaming session with this launch profile.
|
StreamConfigurationCreate |
withMaxSessionLengthInMinutes(Integer maxSessionLengthInMinutes)
The length of time, in minutes, that a streaming session can be active before it is stopped or terminated.
|
StreamConfigurationCreate |
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. |
StreamConfigurationCreate |
withSessionBackup(StreamConfigurationSessionBackup sessionBackup)
Configures how streaming sessions are backed up when launched from this launch profile.
|
StreamConfigurationCreate |
withSessionPersistenceMode(SessionPersistenceMode sessionPersistenceMode)
Determine if a streaming session created from this launch profile can configure persistent storage.
|
StreamConfigurationCreate |
withSessionPersistenceMode(String sessionPersistenceMode)
Determine if a streaming session created from this launch profile can configure persistent storage.
|
StreamConfigurationCreate |
withSessionStorage(StreamConfigurationSessionStorage sessionStorage)
The upload storage for a streaming workstation that is created using this launch profile.
|
StreamConfigurationCreate |
withStreamingImageIds(Collection<String> streamingImageIds)
The streaming images that users can select from when launching a streaming session with this launch profile.
|
StreamConfigurationCreate |
withStreamingImageIds(String... streamingImageIds)
The streaming images that users can select from when launching a streaming session with this launch profile.
|
StreamConfigurationCreate |
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
.
AutomaticTerminationMode
public 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
.
AutomaticTerminationMode
public StreamConfigurationCreate 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
.
AutomaticTerminationMode
public StreamConfigurationCreate 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
.
AutomaticTerminationMode
public 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.StreamingClipboardMode
public String getClipboardMode()
Allows or deactivates the use of the system clipboard to copy and paste between the streaming session and streaming client.
StreamingClipboardMode
public StreamConfigurationCreate 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.StreamingClipboardMode
public StreamConfigurationCreate 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.StreamingClipboardMode
public List<String> getEc2InstanceTypes()
The EC2 instance types that users can select from when launching a streaming session with this launch profile.
StreamingInstanceType
public 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.StreamingInstanceType
public StreamConfigurationCreate 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.StreamingInstanceType
public StreamConfigurationCreate 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.StreamingInstanceType
public StreamConfigurationCreate 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.StreamingInstanceType
public 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 StreamConfigurationCreate 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 StreamConfigurationCreate 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)
Configures how streaming sessions are backed up when launched from this launch profile.
sessionBackup
- Configures how streaming sessions are backed up when launched from this launch profile.public StreamConfigurationSessionBackup getSessionBackup()
Configures how streaming sessions are backed up when launched from this launch profile.
public StreamConfigurationCreate withSessionBackup(StreamConfigurationSessionBackup sessionBackup)
Configures how streaming sessions are backed up when launched from this launch profile.
sessionBackup
- Configures how streaming sessions are backed up when launched from this launch profile.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.SessionPersistenceMode
public 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.SessionPersistenceMode
public StreamConfigurationCreate 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.SessionPersistenceMode
public StreamConfigurationCreate 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.SessionPersistenceMode
public void setSessionStorage(StreamConfigurationSessionStorage sessionStorage)
The upload storage for a streaming workstation that is created using this launch profile.
sessionStorage
- The upload storage for a streaming workstation that is created using this launch profile.public StreamConfigurationSessionStorage getSessionStorage()
The upload storage for a streaming workstation that is created using this launch profile.
public StreamConfigurationCreate withSessionStorage(StreamConfigurationSessionStorage sessionStorage)
The upload storage for a streaming workstation that is created using this launch profile.
sessionStorage
- The upload storage for a streaming workstation that is created using this launch profile.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 StreamConfigurationCreate 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 StreamConfigurationCreate 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 StreamConfigurationCreate 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 Object
Object.toString()
public StreamConfigurationCreate clone()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.