Package software.amazon.awscdk.services.nimblestudio

Class CfnLaunchProfile.StreamConfigurationProperty.Builder

java.lang.Object

software.amazon.awscdk.services.nimblestudio.CfnLaunchProfile.StreamConfigurationProperty.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnLaunchProfile.StreamConfigurationProperty>

Enclosing interface:

CfnLaunchProfile.StreamConfigurationProperty

@Stability(Stable)
public static final class CfnLaunchProfile.StreamConfigurationProperty.Builder
extends Object
implements software.amazon.jsii.Builder<CfnLaunchProfile.StreamConfigurationProperty>

A builder for CfnLaunchProfile.StreamConfigurationProperty

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CfnLaunchProfile.StreamConfigurationProperty.Builder	automaticTerminationMode(String automaticTerminationMode)	Sets the value of CfnLaunchProfile.StreamConfigurationProperty.getAutomaticTerminationMode()
CfnLaunchProfile.StreamConfigurationProperty	build()	Builds the configured instance.
CfnLaunchProfile.StreamConfigurationProperty.Builder	clipboardMode(String clipboardMode)	Sets the value of CfnLaunchProfile.StreamConfigurationProperty.getClipboardMode()
CfnLaunchProfile.StreamConfigurationProperty.Builder	ec2InstanceTypes(List<String> ec2InstanceTypes)	Sets the value of CfnLaunchProfile.StreamConfigurationProperty.getEc2InstanceTypes()
CfnLaunchProfile.StreamConfigurationProperty.Builder	maxSessionLengthInMinutes(Number maxSessionLengthInMinutes)	Sets the value of CfnLaunchProfile.StreamConfigurationProperty.getMaxSessionLengthInMinutes()
CfnLaunchProfile.StreamConfigurationProperty.Builder	maxStoppedSessionLengthInMinutes(Number maxStoppedSessionLengthInMinutes)	Sets the value of CfnLaunchProfile.StreamConfigurationProperty.getMaxStoppedSessionLengthInMinutes()
CfnLaunchProfile.StreamConfigurationProperty.Builder	sessionBackup(IResolvable sessionBackup)	Sets the value of CfnLaunchProfile.StreamConfigurationProperty.getSessionBackup()
CfnLaunchProfile.StreamConfigurationProperty.Builder	sessionBackup(CfnLaunchProfile.StreamConfigurationSessionBackupProperty sessionBackup)	Sets the value of CfnLaunchProfile.StreamConfigurationProperty.getSessionBackup()
CfnLaunchProfile.StreamConfigurationProperty.Builder	sessionPersistenceMode(String sessionPersistenceMode)	Sets the value of CfnLaunchProfile.StreamConfigurationProperty.getSessionPersistenceMode()
CfnLaunchProfile.StreamConfigurationProperty.Builder	sessionStorage(IResolvable sessionStorage)	Sets the value of CfnLaunchProfile.StreamConfigurationProperty.getSessionStorage()
CfnLaunchProfile.StreamConfigurationProperty.Builder	sessionStorage(CfnLaunchProfile.StreamConfigurationSessionStorageProperty sessionStorage)	Sets the value of CfnLaunchProfile.StreamConfigurationProperty.getSessionStorage()
CfnLaunchProfile.StreamConfigurationProperty.Builder	streamingImageIds(List<String> streamingImageIds)	Sets the value of CfnLaunchProfile.StreamConfigurationProperty.getStreamingImageIds()
CfnLaunchProfile.StreamConfigurationProperty.Builder	volumeConfiguration(IResolvable volumeConfiguration)	Sets the value of CfnLaunchProfile.StreamConfigurationProperty.getVolumeConfiguration()
CfnLaunchProfile.StreamConfigurationProperty.Builder	volumeConfiguration(CfnLaunchProfile.VolumeConfigurationProperty volumeConfiguration)	Sets the value of CfnLaunchProfile.StreamConfigurationProperty.getVolumeConfiguration()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Builder

public Builder()

Method Details

clipboardMode

@Stability(Stable)
public CfnLaunchProfile.StreamConfigurationProperty.Builder clipboardMode(String clipboardMode)

Sets the value of CfnLaunchProfile.StreamConfigurationProperty.getClipboardMode()

Parameters:

clipboardMode - Allows or deactivates the use of the system clipboard to copy and paste between the streaming session and streaming client. This parameter is required.

Returns:

this

ec2InstanceTypes

@Stability(Stable)
public CfnLaunchProfile.StreamConfigurationProperty.Builder ec2InstanceTypes(List<String> ec2InstanceTypes)

Sets the value of CfnLaunchProfile.StreamConfigurationProperty.getEc2InstanceTypes()

Parameters:

ec2InstanceTypes - The EC2 instance types that users can select from when launching a streaming session with this launch profile. This parameter is required.

Returns:

this

streamingImageIds

@Stability(Stable)
public CfnLaunchProfile.StreamConfigurationProperty.Builder streamingImageIds(List<String> streamingImageIds)

Sets the value of CfnLaunchProfile.StreamConfigurationProperty.getStreamingImageIds()

Parameters:

streamingImageIds - The streaming images that users can select from when launching a streaming session with this launch profile. This parameter is required.

Returns:

this

automaticTerminationMode

@Stability(Stable)
public CfnLaunchProfile.StreamConfigurationProperty.Builder automaticTerminationMode(String automaticTerminationMode)

Sets the value of CfnLaunchProfile.StreamConfigurationProperty.getAutomaticTerminationMode()

Parameters:

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 .

Returns:

this

maxSessionLengthInMinutes

@Stability(Stable)
public CfnLaunchProfile.StreamConfigurationProperty.Builder maxSessionLengthInMinutes(Number maxSessionLengthInMinutes)

Sets the value of CfnLaunchProfile.StreamConfigurationProperty.getMaxSessionLengthInMinutes()

Parameters:

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.

Returns:

this

maxStoppedSessionLengthInMinutes

@Stability(Stable)
public CfnLaunchProfile.StreamConfigurationProperty.Builder maxStoppedSessionLengthInMinutes(Number maxStoppedSessionLengthInMinutes)

Sets the value of CfnLaunchProfile.StreamConfigurationProperty.getMaxStoppedSessionLengthInMinutes()

Parameters:

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

Returns:

this

sessionBackup

@Stability(Stable)
public CfnLaunchProfile.StreamConfigurationProperty.Builder sessionBackup(IResolvable sessionBackup)

Sets the value of CfnLaunchProfile.StreamConfigurationProperty.getSessionBackup()

Parameters:

sessionBackup - Information about the streaming session backup.

Returns:

this

sessionBackup

@Stability(Stable)
public CfnLaunchProfile.StreamConfigurationProperty.Builder sessionBackup(CfnLaunchProfile.StreamConfigurationSessionBackupProperty sessionBackup)

Sets the value of CfnLaunchProfile.StreamConfigurationProperty.getSessionBackup()

Parameters:

sessionBackup - Information about the streaming session backup.

Returns:

this

sessionPersistenceMode

@Stability(Stable)
public CfnLaunchProfile.StreamConfigurationProperty.Builder sessionPersistenceMode(String sessionPersistenceMode)

Sets the value of CfnLaunchProfile.StreamConfigurationProperty.getSessionPersistenceMode()

Parameters:

sessionPersistenceMode - Determine if a streaming session created from this launch profile can configure persistent storage. This means that volumeConfiguration and automaticTerminationMode are configured.

Returns:

this

sessionStorage

@Stability(Stable)
public CfnLaunchProfile.StreamConfigurationProperty.Builder sessionStorage(IResolvable sessionStorage)

Sets the value of CfnLaunchProfile.StreamConfigurationProperty.getSessionStorage()

Parameters:

sessionStorage - The upload storage for a streaming session.

Returns:

this

sessionStorage

@Stability(Stable)
public CfnLaunchProfile.StreamConfigurationProperty.Builder sessionStorage(CfnLaunchProfile.StreamConfigurationSessionStorageProperty sessionStorage)

Sets the value of CfnLaunchProfile.StreamConfigurationProperty.getSessionStorage()

Parameters:

sessionStorage - The upload storage for a streaming session.

Returns:

this

volumeConfiguration

@Stability(Stable)
public CfnLaunchProfile.StreamConfigurationProperty.Builder volumeConfiguration(IResolvable volumeConfiguration)

Sets the value of CfnLaunchProfile.StreamConfigurationProperty.getVolumeConfiguration()

Parameters:

volumeConfiguration - Custom volume configuration for the root volumes that are attached to streaming sessions. This parameter is only allowed when sessionPersistenceMode is ACTIVATED .

Returns:

this

volumeConfiguration

@Stability(Stable)
public CfnLaunchProfile.StreamConfigurationProperty.Builder volumeConfiguration(CfnLaunchProfile.VolumeConfigurationProperty volumeConfiguration)

Sets the value of CfnLaunchProfile.StreamConfigurationProperty.getVolumeConfiguration()

Parameters:

volumeConfiguration - Custom volume configuration for the root volumes that are attached to streaming sessions. This parameter is only allowed when sessionPersistenceMode is ACTIVATED .

Returns:

this

build

@Stability(Stable)
public CfnLaunchProfile.StreamConfigurationProperty build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<CfnLaunchProfile.StreamConfigurationProperty>

Returns:

a new instance of CfnLaunchProfile.StreamConfigurationProperty

Throws:

NullPointerException - if any required attribute was not provided